Package detectionPlotFX

Class DetectionGroupDisplayFX

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.BorderPane
pamViewFX.fxNodes.PamBorderPane
detectionPlotFX.DetectionGroupDisplay
detectionPlotFX.DetectionGroupDisplayFX
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, PamSettings, SettingsNameProvider, UserDisplayNodeFX
public class DetectionGroupDisplayFX extends DetectionGroupDisplay implements UserDisplayNodeFX, PamSettings
A group detection display with all the bits added to allow the display to be used in the FX GUI as a stand-alone user display.
Author:
Jamie Macaulay

  • Property Summary

    Properties inherited from class javafx.scene.layout.BorderPane

    bottom, center, left, right, top

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Field Summary

    Fields inherited from class detectionPlotFX.DetectionGroupDisplay

    arrowLeft, arrowRight, detectionDisplay, detectionDisplayHolder, DISPLAY_COMPACT, DISPLAY_EXTENDED, displayListeners

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    DetectionGroupDisplayFX(DetectionDisplayControl2 displayControl)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    closeNode()
    Called when the node is removed from the display.
    DetectionPlotParams
    getDisplayParams()
    Get the display provider params.
    String
    getName()
    The name of display.
    javafx.scene.layout.Region
    getNode()
    Get the node to add to the display.
    Serializable
    getSettingsReference()
     
    long
    getSettingsVersion()
     
    String
    getUnitName()
     
    String
    getUnitType()
     
    UserDisplayControlFX
    getUserDisplayControl()
    Get a display controller associated with the display.
    boolean
    isMinorDisplay()
    Only used for automatic resizing.
    boolean
    isResizeableDisplay()
    Check whether a display can be resized within PAMGuard.
    boolean
    isStaticDisplay()
    Check whether a pane is static.
    void
    notifyModelChanged(int changeType)
    Pick up model changed notifications from a parent user display.
    void
    openNode()
    Called when the component is first displayed.
    boolean
    requestNodeSettingsPane()
    Called when node settings pane is requested from another program.
    boolean
    restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
     
    boolean
    setDataUnit(PamDataUnit<?,?> dataUnit)
    Sets the current in the display.
    void
    setDisplayParams(DetectionPlotParams detectionPlotParams)
    Set the display parameterts.
    void
    setFrameHolder(PamInternalPane internalFrame)
    Called whenever the display is added to a frame.

    Methods inherited from class detectionPlotFX.DetectionGroupDisplay

    addDisplayListener, clearDisplay, drawCurrentUnit, getCurrentUnit, getDataTypePane, getDetectionDisplay, isEnableScrollBar, prepareDisplay, removeDisplayListener, setDetectionGroup, setDetectionPlot, setEnableScrollBar, triggerListeners

    Methods inherited from class pamViewFX.fxNodes.PamBorderPane

    setBottomSpace, setLeftSpace, setRightSpace, setTopSpace

    Methods inherited from class javafx.scene.layout.BorderPane

    bottomProperty, centerProperty, clearConstraints, getAlignment, getBottom, getCenter, getContentBias, getLeft, getMargin, getRight, getTop, leftProperty, rightProperty, setAlignment, setBottom, setCenter, setLeft, setMargin, setRight, setTop, topProperty

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPositionX, snapPositionY, snapSizeX, snapSizeY, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setEffect, setEventDispatcher, setFocusTraversable, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Description copied from interface: UserDisplayNodeFX
      The name of display. Used for default tabs etc.
      Specified by:
      getName in interface UserDisplayNodeFX
      Returns:
      the name of the display

    • getNode

      public javafx.scene.layout.Region getNode()
      Description copied from interface: UserDisplayNodeFX
      Get the node to add to the display.
      Specified by:
      getNode in interface UserDisplayNodeFX
      Returns:
      The FX node to add to the display

    • openNode

      public void openNode()
      Description copied from interface: UserDisplayNodeFX
      Called when the component is first displayed.
      Specified by:
      openNode in interface UserDisplayNodeFX

    • isStaticDisplay

      public boolean isStaticDisplay()
      Description copied from interface: UserDisplayNodeFX
      Check whether a pane is static. If the pane is static then it cannot be removed from PAMGuard, it cannot be resized and no other user display can be added to the tab. This is rarely used.
      Specified by:
      isStaticDisplay in interface UserDisplayNodeFX
      Returns:
      true if the pane cannot be removed from the view.

    • isResizeableDisplay

      public boolean isResizeableDisplay()
      Description copied from interface: UserDisplayNodeFX
      Check whether a display can be resized within PAMGuard.
      Specified by:
      isResizeableDisplay in interface UserDisplayNodeFX
      Returns:
      true of the pane can be resized.

    • isMinorDisplay

      public boolean isMinorDisplay()
      Description copied from interface: UserDisplayNodeFX
      Only used for automatic resizing. Minor displays are automatically made smaller
      Specified by:
      isMinorDisplay in interface UserDisplayNodeFX
      Returns:
      true if a minor display.

    • closeNode

      public void closeNode()
      Description copied from interface: UserDisplayNodeFX
      Called when the node is removed from the display.
      Specified by:
      closeNode in interface UserDisplayNodeFX

    • getDisplayParams

      public DetectionPlotParams getDisplayParams()
      Description copied from interface: UserDisplayNodeFX
      Get the display provider params.
      Specified by:
      getDisplayParams in interface UserDisplayNodeFX
      Returns:
      display params.

    • setFrameHolder

      public void setFrameHolder(PamInternalPane internalFrame)
      Description copied from interface: UserDisplayNodeFX
      Called whenever the display is added to a frame.
      Specified by:
      setFrameHolder in interface UserDisplayNodeFX
      Parameters:
      internalFrame - - the internal frame.

    • requestNodeSettingsPane

      public boolean requestNodeSettingsPane()
      Description copied from interface: UserDisplayNodeFX
      Called when node settings pane is requested from another program. Note that the design of displays is such that settings are shown in the display itself, usually with a sliding pane or something similar revealed. Hence, this function should not be used to grab a pane to put in a dialog.
      Specified by:
      requestNodeSettingsPane in interface UserDisplayNodeFX
      Returns:
      true if the pane can show settings.

    • notifyModelChanged

      public void notifyModelChanged(int changeType)
      Description copied from interface: UserDisplayNodeFX
      Pick up model changed notifications from a parent user display.
      Specified by:
      notifyModelChanged in interface UserDisplayNodeFX

    • setDisplayParams

      public void setDisplayParams(DetectionPlotParams detectionPlotParams)
      Set the display parameterts.
      Parameters:
      detectionPlotParams -

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

    • 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

    • getUserDisplayControl

      public UserDisplayControlFX getUserDisplayControl()
      Description copied from interface: UserDisplayNodeFX
      Get a display controller associated with the display. Note that a display does not need a controller so this can return null.
      Specified by:
      getUserDisplayControl in interface UserDisplayNodeFX
      Returns:
      the associated control for the display.

    • setDataUnit

      public boolean setDataUnit(PamDataUnit<?,?> dataUnit)
      Description copied from class: DetectionGroupDisplay
      Sets the current in the display.
      Overrides:
      setDataUnit in class DetectionGroupDisplay
      Returns:
      true of a new data info has been added - usually means a different type of detection to display compared to the last detection.