ControlsFX 11.2.2 · 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.

Field Summary

Modifier and Type	Field and Description
private final Node	decorationNode
private final Pos	pos
private final ChangeListener<Boolean>	targetNeedsLayoutListener Because `decorationNode` is unmanaged, we need this listener to detect when its Parent lays out so that we can lay out `decorationNode`.
private final double	xOffset
private final double	yOffset

Constructor Summary

Access	Constructor and Description
public	GraphicDecoration(Node The decoration node to apply to any node that has this decoration applied to it decorationNode) Constructs a new GraphicDecoration with the given decoration node to be applied to any node that has this decoration applied to it.
public	GraphicDecoration(Node The decoration node to apply to any node that has this decoration applied to it decorationNode, Pos The location to position the decoration node relative to the node that is being decorated. 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.
public	GraphicDecoration(Node The decoration node to apply to any node that has this decoration applied to it decorationNode, Pos The location to position the decoration node relative to the node that is being decorated. position, double The amount of movement to apply to the decoration node in the x direction (i.e. left and right). xOffset, double The amount of movement to apply to the decoration node in the y direction (i.e. up and down). 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 and Description
public Node	applyDecoration(Node targetNode) Implements abstract org.controlsfx.control.decoration.Decoration.applyDecoration. 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).
private void	layoutGraphic(Node targetNode)
public void	removeDecoration(Node targetNode) Implements abstract org.controlsfx.control.decoration.Decoration.removeDecoration. This method removes the decoration from the given target node.

Inherited from org.controlsfx.control.decoration.Decoration:: getProperties

Field Detail

decorationNode	back to summary
private final Node decorationNode

pos	back to summary
private final Pos pos

targetNeedsLayoutListener	back to summary
private final ChangeListener<Boolean> targetNeedsLayoutListener Because `decorationNode` is unmanaged, we need this listener to detect when its Parent lays out so that we can lay out `decorationNode`.

xOffset	back to summary
private final double xOffset

yOffset	back to summary
private final double yOffset

Constructor Detail

GraphicDecoration	back to summary
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:Node The decoration node to apply to any node that has this decoration applied to it

GraphicDecoration

back to summary

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:Node: The decoration node to apply to any node that has this decoration applied to it

GraphicDecoration back to summary

GraphicDecoration	back to summary
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:Node The decoration node to apply to any node that has this decoration applied to it position:Pos The location to position the decoration node relative to the node that is being decorated.

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:Node: The decoration node to apply to any node that has this decoration applied to it
position:Pos: The location to position the decoration node relative to the node that is being decorated.

GraphicDecoration back to summary

GraphicDecoration	back to summary
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:Node The decoration node to apply to any node that has this decoration applied to it position:Pos The location to position the decoration node relative to the node that is being decorated. xOffset:double The amount of movement to apply to the decoration node in the x direction (i.e. left and right). yOffset:double The amount of movement to apply to the decoration node in the y direction (i.e. up and down).

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:Node: The decoration node to apply to any node that has this decoration applied to it
position:Pos: The location to position the decoration node relative to the node that is being decorated.
xOffset:double: The amount of movement to apply to the decoration node in the x direction (i.e. left and right).
yOffset:double: The amount of movement to apply to the decoration node in the y direction (i.e. up and down).

Method Detail

applyDecoration	back to summary
public Node applyDecoration(Node targetNode) Implements abstract org.controlsfx.control.decoration.Decoration.applyDecoration. Doc from org.controlsfx.control.decoration.Decoration.applyDecoration. 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. Annotations @Override

applyDecoration

back to summary

public Node applyDecoration(Node targetNode)

Implements abstract org.controlsfx.control.decoration.Decoration.applyDecoration.

Doc from org.controlsfx.control.decoration.Decoration.applyDecoration.

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.

Annotations

@Override

layoutGraphic	back to summary
private void layoutGraphic(Node targetNode)

removeDecoration	back to summary
public void removeDecoration(Node targetNode) Implements abstract org.controlsfx.control.decoration.Decoration.removeDecoration. Doc from org.controlsfx.control.decoration.Decoration.removeDecoration. This method removes the decoration from the given target node. Annotations @Override

removeDecoration

back to summary

public void removeDecoration(Node targetNode)

Implements abstract org.controlsfx.control.decoration.Decoration.removeDecoration.

Doc from org.controlsfx.control.decoration.Decoration.removeDecoration.

This method removes the decoration from the given target node.

Annotations

@Override

public Class GraphicDecoration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail