Package dataPlotsFX.scroller

Class TDAcousticScroller

java.lang.Object
pamScrollSystem.AbstractPamScroller
pamViewFX.fxNodes.pamScrollers.AbstractPamScrollerFX
pamViewFX.fxNodes.pamScrollers.acousticScroller.AcousticScrollerFX
dataPlotsFX.scroller.TDAcousticScroller
All Implemented Interfaces:
Serializable, PamSettings, SettingsNameProvider, DataTimeLimits
public class TDAcousticScroller extends AcousticScrollerFX implements PamSettings
Subclass for the td display. Provides a specific type of navigation dialog for this scroller.
Author:
Jamie Macaulay
See Also:

  • Constructor Details

    • TDAcousticScroller

      public TDAcousticScroller(String name, javafx.geometry.Orientation orientation, int stepSizeMillis, long defaultLoadTime, boolean hasMenu, TDDisplayFX tdDisplay)
      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.
      owner - The pamscroller window owner. Used to keep dialogs inside the TDDisplay window.

  • Method Details

    • setVisibleMillis

      public void setVisibleMillis(long visibleAmount)
      Overrides:
      setVisibleMillis in class AcousticScrollerFX
      Parameters:
      visibleAmount - the visibleAmount to set in millis

    • createSelectorButton

      public void createSelectorButton()
      Create select button.

    • addDataBlock

      public void addDataBlock(PamDataBlock dataBlock)
      Description copied from class: AbstractPamScroller
      Add a datablock to the list for this scroller.

      When the scroller is moved, data from data blocks in this list will re read from the database and binary stores. Other data will not be read.

      Overrides:
      addDataBlock in class AbstractPamScroller
      Parameters:
      dataBlock - a PamDataBlock

    • addDataBlockGraphics

      public void addDataBlockGraphics(PamDataBlock dataBlock)

    • layoutScrollBarPane

      public void layoutScrollBarPane(javafx.geometry.Orientation orientation)
      Description copied from class: AcousticScrollerFX
      Layout the control pane containing scroll bar and buttons to navigate in time.
      Overrides:
      layoutScrollBarPane in class AcousticScrollerFX
      Parameters:
      orientation - - orientation of the time scroller.

    • setOrientation

      public void setOrientation(javafx.geometry.Orientation orientation)
      Set orientation for the scroller.
      Overrides:
      setOrientation in class AcousticScrollerFX
      Parameters:
      orientation - - orientation of the time scroller.

    • addRangeObserver

      public void addRangeObserver(VisibleRangeObserver timeRangeListener)
      The range spinner.
      Overrides:
      addRangeObserver in class AcousticScrollerFX
      Parameters:
      timeRangeListener -

    • getNode

      public javafx.scene.layout.Pane getNode()
      Description copied from class: AbstractPamScrollerFX
      Get the node which contain all controls for scrolling system.
      Overrides:
      getNode in class AcousticScrollerFX
      Returns:
      the FX component to go into the GUI.

    • loadScrollerData

      public void loadScrollerData()
      Description copied from class: AcousticScrollerFX
      Begins redrawing data hello in the scroll bar.
      Overrides:
      loadScrollerData in class AcousticScrollerFX

    • getUnitName

      public String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      Parameters:
      pamControlledUnitSettings -
      Returns:
      true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required