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:

  • 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

    • 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

    • 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.