Module org.controlsfx.controls

Package org.controlsfx.control.decoration

Class GraphicDecoration

java.lang.Object

org.controlsfx.control.decoration.Decoration

org.controlsfx.control.decoration.GraphicDecoration

public class GraphicDecoration
extends Decoration

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:

Decoration, Decorator

Constructor Summary

Constructors

Constructor	Description
GraphicDecoration(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(Node decorationNode, 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 the position argument.
GraphicDecoration(Node decorationNode, 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 the position argument, with the given xOffset and yOffset values used to adjust the position.

Method Summary

Modifier and Type	Method	Description
Node	applyDecoration(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(Node targetNode)	This method removes the decoration from the given target node.

Methods inherited from class org.controlsfx.control.decoration.Decoration

getProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicDecoration

public GraphicDecoration(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(Node decorationNode,
                         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 the position argument.

Parameters:

decorationNode - The decoration node to apply to any node that has this decoration applied to it

position - The location to position the decoration node relative to the node that is being decorated.

GraphicDecoration

public GraphicDecoration(Node decorationNode,
                         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 the position 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 it

position - 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 Detail

applyDecoration

public Node applyDecoration(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 class Decoration

Parameters:

targetNode - The node to decorate.

Returns:

The decoration, but null is a valid return value.

removeDecoration

public void removeDecoration(Node targetNode)

This method removes the decoration from the given target node.

Specified by:

removeDecoration in class Decoration

Parameters:

targetNode - The node to undecorate.