Package detectionPlotFX

Class DetectionGroupDisplay

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

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

Direct Known Subclasses:

DetectionGroupDisplayFX

public class DetectionGroupDisplay
extends PamBorderPane

A detection plot display with convenience functions to set any type of data unit.

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
PamButton	arrowLeft	Arrow to move data units
PamButton	arrowRight	Arrow to move data units to the left.
DetectionPlotDisplay	detectionDisplay	A preview display of the data unit
javafx.scene.layout.Pane	detectionDisplayHolder	Holds the detection display and controls for viewing standard detections.
static final int	DISPLAY_COMPACT	Show the settings within hiding panes within the display.
static final int	DISPLAY_EXTENDED	Show settings on top and to the right of the display
ArrayList<GroupDisplayListener>	displayListeners	The group detection listeners.

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
DetectionGroupDisplay()	Constructor for the detection group display.
DetectionGroupDisplay(int layoutType)	Constructor for the detection group display.

Method Summary

Modifier and Type	Method	Description
void	addDisplayListener(GroupDisplayListener groupDisplayListener)	Add a display GroupDisplayListener.
void	clearDisplay()	Clear the plot pane.
void	drawCurrentUnit()	Draw the current unit.
PamDataUnit	getCurrentUnit()	Get the currently displayed data unit.
DDDataPane2	getDataTypePane()	Get the DDDataPane2 - this allows users to change between different DataInfos.
DetectionPlotDisplay	getDetectionDisplay()	Get the detection display.
boolean	isEnableScrollBar()	Check whether the scroll bar is changing.
void	prepareDisplay()	Called whenever display is first opened.
boolean	removeDisplayListener(GroupDisplayListener groupDisplayListener)	Remove a display GroupDisplayListener.
boolean	setDataUnit(PamDataUnit<?,?> dataUnit)	Sets the current in the display.
void	setDetectionGroup(List<PamDataUnit> dataList)	Set the detection group.
boolean	setDetectionPlot(String plotName)	Attempts to set the detectionPlot
void	setEnableScrollBar(boolean enableScrollBarPane)	Show the scroll bar which allows the user to change time limits.
void	triggerListeners(PamDataUnit oldDataUnit, PamDataUnit newDataUnit)	Trigger the data unit changing listeners.

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

getChildren

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Field Details

DISPLAY_COMPACT

public static final int DISPLAY_COMPACT

Show the settings within hiding panes within the display.

See Also:

• Constant Field Values

DISPLAY_EXTENDED

public static final int DISPLAY_EXTENDED

Show settings on top and to the right of the display

See Also:

• Constant Field Values

arrowLeft

public PamButton arrowLeft

Arrow to move data units

arrowRight

public PamButton arrowRight

Arrow to move data units to the left.

detectionDisplay

public DetectionPlotDisplay detectionDisplay

A preview display of the data unit

detectionDisplayHolder

public javafx.scene.layout.Pane detectionDisplayHolder

Holds the detection display and controls for viewing standard detections.

displayListeners

public ArrayList<GroupDisplayListener> displayListeners

The group detection listeners.

Constructor Details

DetectionGroupDisplay

public DetectionGroupDisplay()

Constructor for the detection group display.

DetectionGroupDisplay

public DetectionGroupDisplay(int layoutType)

Constructor for the detection group display.

Parameters:

layoutType - - the layout of the display - e.g. DetectionGroupDisplay.DISPLAY_COMPACT

Method Details

getDetectionDisplay

public DetectionPlotDisplay getDetectionDisplay()

Get the detection display.

Returns:

the detection display.

getDataTypePane

public DDDataPane2 getDataTypePane()

Get the DDDataPane2 - this allows users to change between different DataInfos.

Returns:

the DDDataPane2.

prepareDisplay

public void prepareDisplay()

Called whenever display is first opened.

clearDisplay

public void clearDisplay()

Clear the plot pane.

setDataUnit

public boolean setDataUnit(PamDataUnit<?,?> dataUnit)

Sets the current in the display.

Parameters:

pamDataUnit - - the current data unit to set.

detectionDisplay - - the detection display plot to set the data unit for.

Returns:

true of a new data info has been added - usually means a different type of detection to display compared to the last detection.

setDetectionPlot

public boolean setDetectionPlot(String plotName)

Attempts to set the detectionPlot

Parameters:

plotName -

Returns:

triggerListeners

public void triggerListeners(PamDataUnit oldDataUnit,
 PamDataUnit newDataUnit)

Trigger the data unit changing listeners.

Parameters:

oldDataUnit - - the old current data unit.

newDataUnit - - the new current data unit.

addDisplayListener

public void addDisplayListener(GroupDisplayListener groupDisplayListener)

Add a display GroupDisplayListener.

removeDisplayListener

public boolean removeDisplayListener(GroupDisplayListener groupDisplayListener)

Remove a display GroupDisplayListener.

Returns:

remove a detection display listener

drawCurrentUnit

public void drawCurrentUnit()

Draw the current unit.

setDetectionGroup

public void setDetectionGroup(List<PamDataUnit> dataList)

Set the detection group.

Parameters:

dataList - - the detection group.

getCurrentUnit

public PamDataUnit getCurrentUnit()

Get the currently displayed data unit.

Returns:

the currently displayed data unit.

setEnableScrollBar

public void setEnableScrollBar(boolean enableScrollBarPane)

Show the scroll bar which allows the user to change time limits.

Parameters:

enableScrollBarPane - - true to enable the time scroll bar.

isEnableScrollBar

public boolean isEnableScrollBar()

Check whether the scroll bar is changing. The scroll bar allows the user to change time limits.

Returns:

true if the scroll bar pane is showing.