org.controlsfx.control

Class HiddenSidesPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

org.controlsfx.control.HiddenSidesPane

All Implemented Interfaces:

javafx.css.Styleable, EventTarget, Skinnable

public class HiddenSidesPane
extends Control

A pane used to display a full-size content node and four initially hidden nodes on the four sides. The hidden nodes can be made visible by moving the mouse cursor to the edges (see setTriggerDistance(double)) of the pane. The hidden node will appear (at its preferred width or height) with a short slide-in animation. The node will disappear again as soon as the mouse cursor exits it. A hidden node / side can also be pinned by calling setPinnedSide(Side). It will remain visible as long as it stays pinned.

Screenshot

The following screenshots shows the right side node hovering over a table after it was made visible:

Code Sample

 HiddenSidesPane pane = new HiddenSidesPane();
 pane.setContent(new TableView());
 pane.setRight(new ListView());
 

Property Summary

Type	Property and Description
ObjectProperty<Node>	bottom Returns the value of the bottom node property.
ObjectProperty<Node>	content The property that is used to store a reference to the content node.
ObjectProperty<Node>	left Returns the value of the left node property.
ObjectProperty<Side>	pinnedSide Returns the pinned side property.
ObjectProperty<Node>	right Returns the value of the right node property.
ObjectProperty<Node>	top The property used to store a reference to the node shown at the top side of the pane.
DoubleProperty	triggerDistance The property that stores the distance to the pane's edges that will trigger the apperance of the hidden side nodes.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

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 and Description
HiddenSidesPane() Constructs a new pane with no content and no side nodes.
HiddenSidesPane(Node content, Node top, Node right, Node bottom, Node left) Constructs a new pane with the given content node and the four side nodes.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Node>	bottomProperty() Returns the value of the bottom node property.
ObjectProperty<Node>	contentProperty() The property that is used to store a reference to the content node.
protected Skin<?>	createDefaultSkin()
Node	getBottom() Returns the value of the bottom node property.
Node	getContent() Returns the value of the content node property.
Node	getLeft() Returns the value of the left node property.
Side	getPinnedSide() Returns the value of the pinned side property.
Node	getRight() Returns the value of the right node property.
Node	getTop() Returns the value of the top node property.
double	getTriggerDistance() Returns the value of the trigger distance property.
ObjectProperty<Node>	leftProperty() Returns the value of the left node property.
ObjectProperty<Side>	pinnedSideProperty() Returns the pinned side property.
ObjectProperty<Node>	rightProperty() Returns the value of the right node property.
void	setBottom(Node bottom) Sets the value of the bottom node property.
void	setContent(Node content) Sets the value of the content node property.
void	setLeft(Node left) Sets the value of the left node property.
void	setPinnedSide(Side side) Sets the value of the pinned side property.
void	setRight(Node right) Sets the value of the right node property.
void	setTop(Node top) Sets the value of the top node property.
void	setTriggerDistance(double distance) Set the value of the trigger distance property.
ObjectProperty<Node>	topProperty() The property used to store a reference to the node shown at the top side of the pane.
DoubleProperty	triggerDistanceProperty() The property that stores the distance to the pane's edges that will trigger the apperance of the hidden side nodes.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

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, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

triggerDistance

public final DoubleProperty triggerDistanceProperty

The property that stores the distance to the pane's edges that will trigger the apperance of the hidden side nodes.

See Also:

getTriggerDistance(), setTriggerDistance(double)

content

public final ObjectProperty<Node> contentProperty

The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.

See Also:

getContent(), setContent(Node)

top

public final ObjectProperty<Node> topProperty

The property used to store a reference to the node shown at the top side of the pane.

See Also:

getTop(), setTop(Node)

right

public final ObjectProperty<Node> rightProperty

Returns the value of the right node property.

Returns:

the right node property value

bottom

public final ObjectProperty<Node> bottomProperty

Returns the value of the bottom node property.

Returns:

the bottom node property value

left

public final ObjectProperty<Node> leftProperty

Returns the value of the left node property.

Returns:

the left node property value

pinnedSide

public final ObjectProperty<Side> pinnedSideProperty

Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.

See Also:

getPinnedSide(), setPinnedSide(Side)

Constructor Detail

HiddenSidesPane

public HiddenSidesPane(Node content,
                       Node top,
                       Node right,
                       Node bottom,
                       Node left)

Constructs a new pane with the given content node and the four side nodes. Each one of the side nodes may be null.

Parameters:

content - the primary node that will fill the entire width and height of the pane

top - the hidden node on the top side

right - the hidden node on the right side

bottom - the hidden node on the bottom side

left - the hidden node on the left side

HiddenSidesPane

public HiddenSidesPane()

Constructs a new pane with no content and no side nodes.

Method Detail

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

triggerDistanceProperty

public final DoubleProperty triggerDistanceProperty()

The property that stores the distance to the pane's edges that will trigger the apperance of the hidden side nodes.

See Also:

getTriggerDistance(), setTriggerDistance(double)

getTriggerDistance

public final double getTriggerDistance()

Returns the value of the trigger distance property.

Returns:

the trigger distance property value

setTriggerDistance

public final void setTriggerDistance(double distance)

Set the value of the trigger distance property. The value must be larger than zero.

Parameters:

distance - the new value for the trigger distance property

Throws:

IllegalArgumentException - if distance is smaller than zero.

contentProperty

public final ObjectProperty<Node> contentProperty()

The property that is used to store a reference to the content node. The content node will fill the entire width and height of the pane.

See Also:

getContent(), setContent(Node)

getContent

public final Node getContent()

Returns the value of the content node property.

Returns:

the content node property value

setContent

public final void setContent(Node content)

Sets the value of the content node property.

Parameters:

content - the new content node

topProperty

public final ObjectProperty<Node> topProperty()

The property used to store a reference to the node shown at the top side of the pane.

See Also:

getTop(), setTop(Node)

getTop

public final Node getTop()

Returns the value of the top node property.

Returns:

the top node property value

setTop

public final void setTop(Node top)

Sets the value of the top node property.

Parameters:

top - the top node value

rightProperty

public final ObjectProperty<Node> rightProperty()

Returns the value of the right node property.

Returns:

the right node property value

getRight

public final Node getRight()

Returns the value of the right node property.

Returns:

the right node property value

setRight

public final void setRight(Node right)

Sets the value of the right node property.

Parameters:

right - the right node value

bottomProperty

public final ObjectProperty<Node> bottomProperty()

Returns the value of the bottom node property.

Returns:

the bottom node property value

getBottom

public final Node getBottom()

Returns the value of the bottom node property.

Returns:

the bottom node property value

setBottom

public final void setBottom(Node bottom)

Sets the value of the bottom node property.

Parameters:

bottom - the bottom node value

leftProperty

public final ObjectProperty<Node> leftProperty()

Returns the value of the left node property.

Returns:

the left node property value

getLeft

public final Node getLeft()

Returns the value of the left node property.

Returns:

the left node property value

setLeft

public final void setLeft(Node left)

Sets the value of the left node property.

Parameters:

left - the left node value

pinnedSideProperty

public final ObjectProperty<Side> pinnedSideProperty()

Returns the pinned side property. The value of this property determines if one of the four hidden sides stays visible all the time.

See Also:

getPinnedSide(), setPinnedSide(Side)

getPinnedSide

public final Side getPinnedSide()

Returns the value of the pinned side property.

Returns:

the pinned side property value

setPinnedSide

public final void setPinnedSide(Side side)

Sets the value of the pinned side property.

Parameters:

side - the new pinned side value