Package pamViewFX.fxNodes.pamScrollers

Class AbstractPamScrollerFX

java.lang.Object

pamScrollSystem.AbstractPamScroller

pamViewFX.fxNodes.pamScrollers.AbstractPamScrollerFX

All Implemented Interfaces:

Serializable, DataTimeLimits

Direct Known Subclasses:

AcousticScrollerFX, PamScrollerFX

public abstract class AbstractPamScrollerFX
extends AbstractPamScroller
implements Serializable

A scroller UI interfacing with PAMGUARD programmed using JavaFX.

Author:

Jamie Macaulay

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractPamScrollerFX(String name, javafx.geometry.Orientation orientation, int stepSizeMillis, long defaultLoadTime, boolean hasMenu)

Method Summary

Modifier and Type	Method	Description
javafx.scene.layout.Pane	createNavigationPane(boolean isViewer, javafx.geometry.Orientation orientation)	Create the navigation menu based on whether the scroll bar is being used in real time or for viewing data.
abstract javafx.scene.layout.Pane	getNode()	Get the node which contain all controls for scrolling system.
javafx.geometry.Orientation	getOrientation()	Get the orientation of the scroll bar.
PamButton	getPageBackwardButton()	Get the page backward button
PamButton	getPageForwardButton()	Get the page forward button used in viewer mode.
PamButton	getSettingsButton()	Get the settings button which opens the navigation dialog.
boolean	isShowing()
void	openTimeNavigationDialogAWT()	Opens the AWT time navigation dialog.
void	openTimeNavigationDialogFX()	Open the time navigation dialog.

Methods inherited from class pamScrollSystem.AbstractPamScroller

addDataBlock, addMenuParts, addObserver, anotherScrollerMovedInner, anotherScrollerMovedOuter, coupledScrollerChanged, coupleScroller, destroyScroller, getDefaultLoadtime, getMaximumMillis, getMinimumMillis, getNumUsedDataBlocks, getObservers, getPageStep, getPamMenuParts, getRangeMillis, getScrollerCoupling, getScrollerData, getScrollManager, getSpecialLoadTimes, getStepSizeMillis, getUsedDataBlock, getValueMillis, getVisibleAmount, getVisibleEnd, isDataBlockUsed, isInSpecialList, notifyRangeChange, pageBack, pageForward, playbackStarted, playbackStopped, rangesChanged, reLoad, removeAllDataBlocks, removeDataBlock, removeObserver, setBlockIncrement, setPageStep, setRangeMillis, setScrollerCoupling, setStepSizeMillis, setUnitIncrement, setValueMillis, setVisibleMillis, startPlayback, stopPlayback, toString, uncoupleScroller, valueSetMillis

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractPamScrollerFX

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

Method Details

createNavigationPane

public javafx.scene.layout.Pane createNavigationPane(boolean isViewer,
 javafx.geometry.Orientation orientation)

Create the navigation menu based on whether the scroll bar is being used in real time or for viewing data. Can override this to add more controls.

Parameters:

isViewer - -whether in viewer mode or not

Orientation - orientation -orientation of the scroll bar

Returns:

pane holding controls for time navigation.

openTimeNavigationDialogAWT

public void openTimeNavigationDialogAWT()

Opens the AWT time navigation dialog.

openTimeNavigationDialogFX

public void openTimeNavigationDialogFX()

Open the time navigation dialog.

getOrientation

public javafx.geometry.Orientation getOrientation()

Get the orientation of the scroll bar.

Returns:

orientation of the scroll bar. Either horizontal or vertical.

getSettingsButton

public PamButton getSettingsButton()

Get the settings button which opens the navigation dialog.

Returns:

the button which opens the navigation dialog.

getPageForwardButton

public PamButton getPageForwardButton()

Get the page forward button used in viewer mode.

Returns:

getPageBackwardButton

public PamButton getPageBackwardButton()

Get the page backward button

Returns:

getNode

public abstract javafx.scene.layout.Pane getNode()

Get the node which contain all controls for scrolling system.

Returns:

the FX component to go into the GUI.

isShowing

public boolean isShowing()

Overrides:

isShowing in class AbstractPamScroller