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
,PamSettings
,SettingsNameProvider
,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.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.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
FieldsModifier and TypeFieldDescriptionReference to the scrolling pane -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called when the node is removed from the display.void
void
dataGraphMouseTime
(Long timeMillis) Called when mouse moves over a data graph to set time on scale Panel.Get the data map parameters associated with the FX GUI.getDataStreamPane
(int n) Get a data stream pane.getDataStreamPane
(DataMapInfo selectedItem) Get the display provider params.getName()
The name of display.javafx.scene.layout.Region
getNode()
Get the node to add to the display.int
Get the current number of data stream paneslong
Get a display controller associated with the display.boolean
Only used for automatic resizing.boolean
Check whether a display can be resized within PAMGuard.boolean
Check whether a pane is static.void
void
void
notifyModelChanged
(int changeType) Pick up model changed notifications from a parent user display.void
openNode()
Called when the component is first displayed.void
boolean
Called when node settings pane is requested from another program.boolean
restoreSettings
(PamControlledUnitSettings pamControlledUnitSettings) void
selectedDataTime
(Long timeStart, Long timeEnd) Called when the mouse moves into a new data stream pane.void
setDataMapParams
(DataMapParametersFX dataMapParamsFX) Set the data map parameters.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, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getBottom, getCenter, getContentBias, getLeft, getMargin, getRight, getTop, layoutChildren, leftProperty, rightProperty, setAlignment, setBottom, setCenter, setLeft, setMargin, setRight, setTop, topProperty
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, 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, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
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, getInitialCursor, getInitialFocusTraversable, 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, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, 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, setPressed, 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
-
Field Details
-
Constructor Details
-
Method Details
-
newSettings
public void newSettings() -
createDataGraphs
public void createDataGraphs() -
repaintAll
public void repaintAll() -
newDataSources
public void newDataSources() -
getNode
public javafx.scene.layout.Region getNode()Description copied from interface:UserDisplayNodeFX
Get the node to add to the display.- Specified by:
getNode
in interfaceUserDisplayNodeFX
- 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 interfaceUserDisplayNodeFX
-
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 interfaceUserDisplayNodeFX
- 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 interfaceUserDisplayNodeFX
- 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 interfaceUserDisplayNodeFX
- 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 interfaceUserDisplayNodeFX
-
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 interfaceUserDisplayNodeFX
- Parameters:
changeType
-
-
getName
Description copied from interface:UserDisplayNodeFX
The name of display. Used for default tabs etc.- Specified by:
getName
in interfaceUserDisplayNodeFX
- Returns:
- the name of the display
-
dataGraphMouseTime
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
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 millistimeEnd
- - 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 interfaceUserDisplayNodeFX
- Returns:
- true if a minor display.
-
getDisplayParams
Description copied from interface:UserDisplayNodeFX
Get the display provider params.- Specified by:
getDisplayParams
in interfaceUserDisplayNodeFX
- Returns:
- display params.
-
setFrameHolder
Description copied from interface:UserDisplayNodeFX
Called whenever the display is added to a frame.- Specified by:
setFrameHolder
in interfaceUserDisplayNodeFX
- Parameters:
internalFrame
- - the internal frame.
-
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 interfaceUserDisplayNodeFX
- 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
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.
-
getDataStreamPane
-
setDataMapParams
Set the data map parameters.- Parameters:
dataMapParamsFX
-
-
getDataMapParams
Get the data map parameters associated with the FX GUI. Note these are separate from the parameters in the DataMapControls which are for the default swing display (not great)- Returns:
- the current data map parameters.
-
getUnitName
- Specified by:
getUnitName
in interfaceSettingsNameProvider
- Returns:
- A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
-
getUnitType
- Specified by:
getUnitType
in interfacePamSettings
- Returns:
- A Name specific to the type, e.g. Click detector
-
getSettingsReference
- Specified by:
getSettingsReference
in interfacePamSettings
- Returns:
- The serialisable object that will be stored
-
getSettingsVersion
public long getSettingsVersion()- Specified by:
getSettingsVersion
in interfacePamSettings
- Returns:
- An integer version number for the settings
-
restoreSettings
- Specified by:
restoreSettings
in interfacePamSettings
- 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
-