java.lang.Object
org.controlsfx.control.decoration.Decoration
org.controlsfx.control.decoration.GraphicDecoration
GraphicDecoration is a
Decoration
designed to show a graphic (be it
an image loaded via an ImageView
or an arbitrarily complex
scenegraph in its own right) on top of a given node. GraphicDecoration is
applied as part of the ControlsFX Decorator
API - refer to the
Decorator
javadoc for more details.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionGraphicDecoration
(javafx.scene.Node decorationNode) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it.GraphicDecoration
(javafx.scene.Node decorationNode, javafx.geometry.Pos position) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it, in the location provided by theposition
argument.GraphicDecoration
(javafx.scene.Node decorationNode, javafx.geometry.Pos position, double xOffset, double yOffset) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it, in the location provided by theposition
argument, with the given xOffset and yOffset values used to adjust the position. -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.Node
applyDecoration
(javafx.scene.Node targetNode) This method decorates the given target node with the relevant decorations, returning any 'decoration node' that needs to be added to the scenegraph (although this can be null).void
removeDecoration
(javafx.scene.Node targetNode) This method removes the decoration from the given target node.Methods inherited from class org.controlsfx.control.decoration.Decoration
getProperties
-
Constructor Details
-
GraphicDecoration
public GraphicDecoration(javafx.scene.Node decorationNode) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it. By default the decoration node will be applied in the top-left corner of the node.- Parameters:
decorationNode
- The decoration node to apply to any node that has this decoration applied to it
-
GraphicDecoration
public GraphicDecoration(javafx.scene.Node decorationNode, javafx.geometry.Pos position) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it, in the location provided by theposition
argument.- Parameters:
decorationNode
- The decoration node to apply to any node that has this decoration applied to itposition
- The location to position the decoration node relative to the node that is being decorated.
-
GraphicDecoration
public GraphicDecoration(javafx.scene.Node decorationNode, javafx.geometry.Pos position, double xOffset, double yOffset) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it, in the location provided by theposition
argument, with the given xOffset and yOffset values used to adjust the position.- Parameters:
decorationNode
- The decoration node to apply to any node that has this decoration applied to itposition
- The location to position the decoration node relative to the node that is being decorated.xOffset
- The amount of movement to apply to the decoration node in the x direction (i.e. left and right).yOffset
- The amount of movement to apply to the decoration node in the y direction (i.e. up and down).
-
-
Method Details
-
applyDecoration
public javafx.scene.Node applyDecoration(javafx.scene.Node targetNode) This method decorates the given target node with the relevant decorations, returning any 'decoration node' that needs to be added to the scenegraph (although this can be null). When the returned Node is null, this indicates that the decoration will be handled internally by the decoration (which is preferred, as the default implementation is not ideal in most circumstances).When the boolean parameter is false, this method removes the decoration from the given target node, always returning null.
- Specified by:
applyDecoration
in classDecoration
- Parameters:
targetNode
- The node to decorate.- Returns:
- The decoration, but null is a valid return value.
-
removeDecoration
public void removeDecoration(javafx.scene.Node targetNode) This method removes the decoration from the given target node.- Specified by:
removeDecoration
in classDecoration
- Parameters:
targetNode
- The node to undecorate.
-