Package pamScrollSystem

Class PamScrollerFX

java.lang.Object

pamScrollSystem.AbstractPamScroller

pamViewFX.fxNodes.pamScrollers.AbstractPamScrollerFX

pamScrollSystem.PamScrollerFX

All Implemented Interfaces:

Serializable, DataTimeLimits

Direct Known Subclasses:

TDPamScrollerFX

public class PamScrollerFX
extends AbstractPamScrollerFX

Creates a scroll bar system that allows users to navigate through data in real time and viewer mode.

Author:

Jamie Macaulay, Doug Gillespie

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected javafx.scene.layout.Pane	navigationPane	Panel which holds buttons for navigating through data.

Fields inherited from class pamViewFX.fxNodes.pamScrollers.AbstractPamScrollerFX

orientation

Fields inherited from class pamScrollSystem.AbstractPamScroller

needsNotify, observers, pamMenuParts, playSpeeds, scrollerData, scrollManager, usedDataBlocks

Constructor Summary

Constructors

Constructor	Description
PamScrollerFX(String name, javafx.geometry.Orientation orientation, int stepSizeMillis, long defaultLoadTime, boolean hasMenu)	Construct a PAMGUARD scroll bar which contains a main scroll bar bit and buttons for moving forward in large secScollbar name (used in scroll bar management)

Method Summary

Modifier and Type	Method	Description
void	anotherScrollerMovedInner(long newValue)	Another managed scroller moved it's position
long	getBlockIncrement()
protected javafx.scene.layout.Pane	getControlPane()	Get the pane which allows users to page through viewer data/ select the maximum amount of data to be loaded and start time.
javafx.scene.layout.Pane	getNode()	Get the node which contain all controls for scrolling system.
PamScrollBarFX	getScrollBar()	Get the scroll bar.
long	getValueMillis()	The start time of the scroller in milliseconds.
long	getVisibleAmount()	This will be none for sliders, such as on the map.
void	layoutScrollBarPane(javafx.geometry.Orientation orientation)	Layout the control pane containing scroll bar and buttons to navigate in time.
void	rangesChanged(long setValue)	Called when ranges have been changed and tells scroller to go to a particular absolute value.
void	scrollMoved()
void	setBlockIncrement(long blockIncrement)
void	setOrientation(javafx.geometry.Orientation orientation)	Set orientation for the scroller.
void	setUnitIncrement(long unitIncrement)
void	setVisibleMillis(long visibleAmount)
void	valueSetMillis(long valueMillis)	Called when a new position has been set

Methods inherited from class pamViewFX.fxNodes.pamScrollers.AbstractPamScrollerFX

createNavigationPane, getOrientation, getPageBackwardButton, getPageForwardButton, getSettingsButton, isShowing, openTimeNavigationDialogAWT, openTimeNavigationDialogFX

Methods inherited from class pamScrollSystem.AbstractPamScroller

addDataBlock, addMenuParts, addObserver, anotherScrollerMovedOuter, coupledScrollerChanged, coupleScroller, destroyScroller, getDefaultLoadtime, getMaximumMillis, getMinimumMillis, getNumUsedDataBlocks, getObservers, getPageStep, getPamMenuParts, getRangeMillis, getScrollerCoupling, getScrollerData, getScrollManager, getSpecialLoadTimes, getStepSizeMillis, getUsedDataBlock, getVisibleEnd, isDataBlockUsed, isInSpecialList, notifyRangeChange, notifyValueChange, pageBack, pageForward, playbackStarted, playbackStopped, playTimerAction, rangesChangedF, reLoad, removeAllDataBlocks, removeDataBlock, removeObserver, setDefaultLoadtime, setPageStep, setRangeMillis, setScrollerCoupling, setStepSizeMillis, setValueMillis, startPlayback, stopPlayback, toString, uncoupleScroller

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

navigationPane

protected javafx.scene.layout.Pane navigationPane

Panel which holds buttons for navigating through data.

Constructor Details

PamScrollerFX

public PamScrollerFX(String name,
 javafx.geometry.Orientation orientation,
 int stepSizeMillis,
 long defaultLoadTime,
 boolean hasMenu)

Construct a PAMGUARD scroll bar which contains a main scroll bar bit and buttons for moving forward in large secScollbar name (used in scroll bar management)

Parameters:

orientation - AbstractPamScroller.VERTICAL or AbstractPamScroller.HORIZONTAL

stepSizeMillis - step size in milliseconds for scroller.

defaultLoadTime - default amount of data to load.

hasMenu - true if menu options should be shown in navigation area.

Method Details

getControlPane

protected javafx.scene.layout.Pane getControlPane()

Get the pane which allows users to page through viewer data/ select the maximum amount of data to be loaded and start time. In real time mode simply allows selection of the maximum data to be loaded and visible window size.

Parameters:

orientation - -orientation of pane.

Returns:

the navigation pane for scroll bar.

layoutScrollBarPane

public void layoutScrollBarPane(javafx.geometry.Orientation orientation)

Layout the control pane containing scroll bar and buttons to navigate in time.

Parameters:

orientation - - orientation of the time scroller.

setOrientation

public void setOrientation(javafx.geometry.Orientation orientation)

Set orientation for the scroller.

Parameters:

orientation - - orientation of the time scroller.

getNode

public javafx.scene.layout.Pane getNode()

Description copied from class: AbstractPamScrollerFX

Get the node which contain all controls for scrolling system.

Specified by:

getNode in class AbstractPamScrollerFX

Returns:

the FX component to go into the GUI.

rangesChanged

public void rangesChanged(long setValue)

Description copied from class: AbstractPamScroller

Called when ranges have been changed and tells scroller to go to a particular absolute value.

Specified by:

rangesChanged in class AbstractPamScroller

Parameters:

setValue -

scrollMoved

public void scrollMoved()

setBlockIncrement

public void setBlockIncrement(long blockIncrement)

Overrides:

setBlockIncrement in class AbstractPamScroller

Parameters:

blockIncrement - the blockIncrement to set in millis

getBlockIncrement

public long getBlockIncrement()

setVisibleMillis

public void setVisibleMillis(long visibleAmount)

Overrides:

setVisibleMillis in class AbstractPamScroller

Parameters:

visibleAmount - the visibleAmount to set in millis

getVisibleAmount

public long getVisibleAmount()

Description copied from class: AbstractPamScroller

This will be none for sliders, such as on the map. For other scrollers it should be the same as the time displayed in to the navigaiton buttons of the scroller.

Specified by:

getVisibleAmount in class AbstractPamScroller

Returns:

The visible amount of the display in milliseconds.

setUnitIncrement

public void setUnitIncrement(long unitIncrement)

Overrides:

setUnitIncrement in class AbstractPamScroller

Parameters:

unitIncrement - the unitIncrement to set in millis

getValueMillis

public long getValueMillis()

Description copied from class: AbstractPamScroller

The start time of the scroller in milliseconds. This is the current position of the scroller NOT the start time of loaded data.

Specified by:

getValueMillis in class AbstractPamScroller

Returns:

the valueMillis

valueSetMillis

public void valueSetMillis(long valueMillis)

Description copied from class: AbstractPamScroller

Called when a new position has been set

Specified by:

valueSetMillis in class AbstractPamScroller

Parameters:

valueMillis - new scroll value in milliseconds

anotherScrollerMovedInner

public void anotherScrollerMovedInner(long newValue)

Description copied from class: AbstractPamScroller

Another managed scroller moved it's position

Specified by:

anotherScrollerMovedInner in class AbstractPamScroller

Parameters:

newValue - new value in millis

getScrollBar

public PamScrollBarFX getScrollBar()

Get the scroll bar.

Returns:

the scroll bar.