Decorator class
for adding and removing decorations on a node. ControlsFX
ships with pre-built decorations, including GraphicDecoration and
StyleClassDecoration.
To better understand how to use the ControlsFX decoration API in your
application, refer to the code samples and explanations in Decorator.
Decorator, GraphicDecoration, StyleClassDecoration
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public abstract Node | Returns: The decoration, but null is a valid return value.The node to decorate. 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). |
| public final synchronized Map | |
| public abstract void | removeDecoration(Node
The node to undecorate. targetNode)This method removes the decoration from the given target node. |
| properties | back to summary |
|---|---|
| private volatile Map<String, Object> properties | |
| Decoration | back to summary |
|---|---|
| protected Decoration() Instantiates a default Decoration instance (obviously only callable by subclasses). | |
| applyDecoration | back to summary |
|---|---|
| public abstract 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. | |
| getProperties | back to summary |
|---|---|
| public final synchronized Map Custom decoration properties | |
| removeDecoration | back to summary |
|---|---|
| public abstract void removeDecoration(Node targetNode) This method removes the decoration from the given target node.
| |