Package pamViewFX.fxPlotPanes

Class PamHiddenSidePane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.StackPane

pamViewFX.fxNodes.PamStackPane

pamViewFX.fxPlotPanes.PamHiddenSidePane

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class PamHiddenSidePane
extends PamStackPane

The PamDataPane contains a pane with two hiding panes, a left pane and a right pane.

A convenience class as this type of display is used a lot for various plots, graphs etc. .

Author:

Jamie Macaulay

Property Summary

Properties inherited from class javafx.scene.layout.StackPane

alignment

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 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
PamHiddenSidePane()	Create a stack pane with no hiding panes added.
PamHiddenSidePane(javafx.scene.layout.Region holder, javafx.scene.Node iconleft, javafx.scene.Node iconRight, javafx.scene.layout.Region leftPane, javafx.scene.layout.Region rightPane)	Create a stack pane with two overlaid hiding panes, a left hiding pane and a right hiding pane.
PamHiddenSidePane(javafx.scene.Node iconleft, javafx.scene.Node iconRight, javafx.scene.layout.Region leftPane, javafx.scene.layout.Region rightPane)	Create a stack pane with two overlaid hiding panes, a left hiding pane and a right hiding pane.

Method Summary

Modifier and Type	Method	Description
HidingPane	createHidingPane(javafx.scene.layout.Region displayPane, javafx.scene.Node icon, javafx.geometry.Side side)	Create and add a hiding pane to the display.
void	createLeftPane(javafx.scene.layout.Pane leftPane, javafx.scene.Node iconleft)	Create a left hiding pane.
void	createRightPane(javafx.scene.layout.Pane rightPane, javafx.scene.Node iconRight)	Create a right hiding pane.
HidingPane	getLeftHidingPane()	Get the hiding pane on the right side of the pane.
HidingPane	getRightHidingPane()	Get the hiding pane on the left side of the pane.
static void	setClipping(javafx.scene.layout.Region holder, HidingPane rightHidingPane, double minHeight)	Have to be careful if overlaid hidden panes, then hiding panes will appear outside node unless clipped.
void	setMinHidePaneHeight(double height)	Sets the hiding pane to have a minimum height.

Methods inherited from class javafx.scene.layout.StackPane

alignmentProperty, clearConstraints, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, 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

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

PamHiddenSidePane

public PamHiddenSidePane()

Create a stack pane with no hiding panes added. Hiding panes can be manually added later.

PamHiddenSidePane

public PamHiddenSidePane(javafx.scene.Node iconleft,
 javafx.scene.Node iconRight,
 javafx.scene.layout.Region leftPane,
 javafx.scene.layout.Region rightPane)

Create a stack pane with two overlaid hiding panes, a left hiding pane and a right hiding pane.

Parameters:

iconleft - - the icon for show button on the left hiding pane

iconRight - - the show button icon on the right for the right hiding pane

leftPane - - the pane to hold in the left hiding pane

rightPane - - the pane to hold in the right hiding pane.

PamHiddenSidePane

public PamHiddenSidePane(javafx.scene.layout.Region holder,
 javafx.scene.Node iconleft,
 javafx.scene.Node iconRight,
 javafx.scene.layout.Region leftPane,
 javafx.scene.layout.Region rightPane)

Create a stack pane with two overlaid hiding panes, a left hiding pane and a right hiding pane.

Parameters:

iconleft - - the icon for show button on the left hiding pane

iconRight - - the show button icon on the right for the right hiding pane

leftPane - - the pane to hold in the left hiding pane

rightPane - - the pane to hold in the right hiding pane.

Method Details

createLeftPane

public void createLeftPane(javafx.scene.layout.Pane leftPane,
 javafx.scene.Node iconleft)

Create a left hiding pane. If a left pane exists it is removed and replace by a new pane.

Parameters:

leftPane - - the pane to hold in the left hiding pane.

iconleft - - the icon for the left show button

createRightPane

public void createRightPane(javafx.scene.layout.Pane rightPane,
 javafx.scene.Node iconRight)

Create a right hiding pane. If a right pane exists it is removed and replace by a new pane.

Parameters:

rightPane - - the pane to hold in the right hiding pane.

iconRight - - the icon for the right show button

setClipping

public static void setClipping(javafx.scene.layout.Region holder,
 HidingPane rightHidingPane,
 double minHeight)

Have to be careful if overlaid hidden panes, then hiding panes will appear outside node unless clipped. We also may want an overlapping hiding pane if the holder become too small

setMinHidePaneHeight

public void setMinHidePaneHeight(double height)

Sets the hiding pane to have a minimum height. If the hiding is below this height then

Parameters:

height - the minimum height.

createHidingPane

public HidingPane createHidingPane(javafx.scene.layout.Region displayPane,
 javafx.scene.Node icon,
 javafx.geometry.Side side)

Create and add a hiding pane to the display.

Parameters:

displayPane - - the pane to add to the hiding pane.

icon - - the icon for the show button.

side - the side of the display the hiding pane should open on

trayPos - - the y position of the show button from the top of the pane.

pos - the position of the hiding pane oin the stack pane.

Returns:

the hiding pane.

getLeftHidingPane

public HidingPane getLeftHidingPane()

Get the hiding pane on the right side of the pane.

Returns:

the right HidingPane.

getRightHidingPane

public HidingPane getRightHidingPane()

Get the hiding pane on the left side of the pane.

Returns:

the left HidingPane.