com.jfoenix.controls

Class JFXDecorator

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.VBox

com.jfoenix.controls.JFXDecorator

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class JFXDecorator
extends javafx.scene.layout.VBox

Window Decorator allow to resize/move its content Note: the default close button will call stage.close() which will only close the current stage. it will not close the java application, however it can be customized by calling setOnCloseButtonAction(Runnable)

Since:

2016-03-09

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	customMaximize this property is used to replace JavaFX maximization with a custom one that prevents hiding windows taskbar when the JFXDecorator is maximized.
javafx.beans.property.StringProperty	title By default this title property is bound to the primaryStage's title property.

Properties inherited from class javafx.scene.layout.VBox

alignmentProperty, fillWidthProperty, spacingProperty

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

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, 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

Modifier and Type	Field and Description
protected JFXButton	btnClose
protected JFXButton	btnFull
protected JFXButton	btnMax
protected JFXButton	btnMin
protected javafx.scene.Node	graphic
protected javafx.scene.layout.HBox	graphicContainer
protected javafx.scene.text.Text	text
protected javafx.beans.property.StringProperty	title

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
JFXDecorator(javafx.stage.Stage stage, javafx.scene.Node node) Create a window decorator for the specified node with the options: - full screen - maximize - minimize
JFXDecorator(javafx.stage.Stage stage, javafx.scene.Node node, boolean fullScreen, boolean max, boolean min) Create a window decorator for the specified node with the options: - full screen - maximize - minimize

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	customMaximizeProperty() this property is used to replace JavaFX maximization with a custom one that prevents hiding windows taskbar when the JFXDecorator is maximized.
javafx.scene.Node	getGraphic(javafx.scene.Node node)
java.lang.String	getText() Deprecated. Use setTitle(java.lang.String) instead.
java.lang.String	getTitle() Gets the value of the property title.
boolean	isCustomMaximize()
void	setContent(javafx.scene.Node content) will change the decorator content
void	setCustomMaximize(boolean customMaximize) set customMaximize property
void	setGraphic(javafx.scene.Node node)
void	setMaximized(boolean maximized)
void	setOnCloseButtonAction(java.lang.Runnable onCloseButtonAction) set a speficed runnable when clicking on the close button
void	setText(java.lang.String text) Deprecated. Use setTitle(java.lang.String) instead.
void	setTitle(java.lang.String title) If you want the primaryStage's title and the JFXDecorator's title to be different, then go ahead and use this method.
javafx.beans.property.StringProperty	titleProperty() By default this title property is bound to the primaryStage's title property.

Methods inherited from class javafx.scene.layout.VBox

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, fillWidthProperty, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, getSpacing, getVgrow, isFillWidth, layoutChildren, requestLayout, setAlignment, setFillWidth, setMargin, setSpacing, setVgrow, spacingProperty

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, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, 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, 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, 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

customMaximize

public final javafx.beans.property.BooleanProperty customMaximizeProperty

this property is used to replace JavaFX maximization with a custom one that prevents hiding windows taskbar when the JFXDecorator is maximized.

See Also:

isCustomMaximize(), setCustomMaximize(boolean)

title

public javafx.beans.property.StringProperty titleProperty

By default this title property is bound to the primaryStage's title property.

To change it to something else, use

      jfxDecorator.titleProperty().unbind();

first.

See Also:

getTitle(), setTitle(String)

Field Detail

btnMax

protected JFXButton btnMax

btnFull

protected JFXButton btnFull

btnClose

protected JFXButton btnClose

btnMin

protected JFXButton btnMin

title

protected javafx.beans.property.StringProperty title

text

protected javafx.scene.text.Text text

graphic

protected javafx.scene.Node graphic

graphicContainer

protected javafx.scene.layout.HBox graphicContainer

Constructor Detail

JFXDecorator

public JFXDecorator(javafx.stage.Stage stage,
                    javafx.scene.Node node)

Create a window decorator for the specified node with the options: - full screen - maximize - minimize

Parameters:

stage - the primary stage used by the application

node - the node to be decorated

JFXDecorator

public JFXDecorator(javafx.stage.Stage stage,
                    javafx.scene.Node node,
                    boolean fullScreen,
                    boolean max,
                    boolean min)

Create a window decorator for the specified node with the options: - full screen - maximize - minimize

Parameters:

stage - the primary stage used by the application

node - the node to be decorated

fullScreen - indicates whether to show full screen option or not

max - indicates whether to show maximize option or not

min - indicates whether to show minimize option or not

Method Detail

setOnCloseButtonAction

public void setOnCloseButtonAction(java.lang.Runnable onCloseButtonAction)

set a speficed runnable when clicking on the close button

Parameters:

onCloseButtonAction - runnable to be executed

customMaximizeProperty

public final javafx.beans.property.BooleanProperty customMaximizeProperty()

this property is used to replace JavaFX maximization with a custom one that prevents hiding windows taskbar when the JFXDecorator is maximized.

See Also:

isCustomMaximize(), setCustomMaximize(boolean)

isCustomMaximize

public final boolean isCustomMaximize()

Returns:

whether customMaximizeProperty is active or not

setCustomMaximize

public final void setCustomMaximize(boolean customMaximize)

set customMaximize property

Parameters:

customMaximize -

setMaximized

public void setMaximized(boolean maximized)

Parameters:

maximized -

setContent

public void setContent(javafx.scene.Node content)

will change the decorator content

Parameters:

content -

setText

public void setText(java.lang.String text)

Deprecated. Use setTitle(java.lang.String) instead.

will set the title

Parameters:

text -

getText

public java.lang.String getText()

Deprecated. Use setTitle(java.lang.String) instead.

will get the title

getTitle

public java.lang.String getTitle()

Gets the value of the property title.

titleProperty

public javafx.beans.property.StringProperty titleProperty()

By default this title property is bound to the primaryStage's title property.

To change it to something else, use

      jfxDecorator.titleProperty().unbind();

first.

See Also:

getTitle(), setTitle(String)

setTitle

public void setTitle(java.lang.String title)

If you want the primaryStage's title and the JFXDecorator's title to be different, then go ahead and use this method.

By default, this title property is bound to the primaryStage's title property-so merely setting the primaryStage's title, will set the JFXDecorator's title.

setGraphic

public void setGraphic(javafx.scene.Node node)

getGraphic

public javafx.scene.Node getGraphic(javafx.scene.Node node)