Package dataMap.layoutFX

Class DataMapPaneFX

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.BorderPane
pamViewFX.fxNodes.PamBorderPane
dataMap.layoutFX.DataMapPaneFX
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, UserDisplayNodeFX
public class DataMapPaneFX extends PamBorderPane implements UserDisplayNodeFX
Pane which shows users all data currently stored in binary files and databases within PAMGuard. Also allows for navigation to different part of the data time series.
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
    Modifier and Type
    Field
    Description
    ScrollingDataPaneFX
    scrollingDataPanel
    Reference to the scrolling pane

    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
    DataMapPaneFX(DataMapControl dataMapControl)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    closeNode()
    Called when the node is removed from the display.
    void
    createDataGraphs()
     
    void
    dataGraphMouseTime(Long timeMillis)
    Called when mouse moves over a data graph to set time on scale Panel.
    DataStreamPaneFX
    getDataStreamPane(int n)
    Get a data stream pane.
    UserDisplayNodeParams
    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.
    int
    getNumDataStreamPanes()
    Get the current number of data stream panes
    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
    newDataSources()
     
    void
    newSettings()
     
    void
    notifyModelChanged(int changeType)
    Pick up model changed notifications from a parent user display.
    void
    openNode()
    Called when the component is first displayed.
    void
    repaintAll()
     
    boolean
    requestNodeSettingsPane()
    Called when node settings pane is requested from another program.
    void
    scaleChanged()
    Called from ScalePanel when anything to do with scaling changes.
    void
    selectedDataTime(Long timeStart, Long timeEnd)
    Called when the mouse moves into a new data stream pane.
    void
    setFrameHolder(PamInternalPane internalFrame)
    Called whenever the display is added to a frame.

    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

  • Field Details

    • scrollingDataPanel

      public ScrollingDataPaneFX scrollingDataPanel
      Reference to the scrolling pane

  • Constructor Details

  • Method Details

    • newSettings

      public void newSettings()

    • createDataGraphs

      public void createDataGraphs()

    • repaintAll

      public void repaintAll()

    • newDataSources

      public void newDataSources()

    • scaleChanged

      public void scaleChanged()
      Called from ScalePanel when anything to do with scaling changes.

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

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

    • closeNode

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

    • 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

    • 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

    • dataGraphMouseTime

      public void dataGraphMouseTime(Long timeMillis)
      Called when mouse moves over a data graph to set time on scale Panel. Set null to clear cursor info on panel.
      Parameters:
      timeMillis - time in millis or null.

    • selectedDataTime

      public void selectedDataTime(Long timeStart, Long timeEnd)
      Called when the mouse moves into a new data stream pane. Shows the start and end time of the data currently loaded into memory.
      Parameters:
      timeStart - - the start of loaded data in millis
      timeEnd - - the end of loaded data in millis.

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

    • getDisplayParams

      public UserDisplayNodeParams 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.

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

    • getNumDataStreamPanes

      public int getNumDataStreamPanes()
      Get the current number of data stream panes
      Returns:
      the number of data stream panes

    • getDataStreamPane

      public DataStreamPaneFX getDataStreamPane(int n)
      Get a data stream pane.
      Parameters:
      n - - the index of the data stream pane
      Returns:
      the data stream pane or null if the index is out of bounds.