Decorator (module-decoration 0.9.1 API)

java.lang.Object
- jidefx.scene.control.decoration.Decorator<T>

Type Parameters:

T - the type of the decoration node.

Direct Known Subclasses:

MutableDecorator
```
public class Decorator<T extends javafx.scene.Node>
extends java.lang.Object
```
Decorator provides the information for a decorator.
```
 DecorationUtils.install(textField, new Decorator(clearButton, Pos.CENTER_RIGHT, new Insets(0, 100, 0, 0), new
 Point2D(-50, 0), true));
 DecorationUtils.install(textField, new Decorator(labelButton, Pos.CENTER_LEFT, new Insets(0, 0, 0, 100), new
 Point2D(50, 0), true));
 
```
The code above will put two buttons inside a TextField on both sides. Both are vertically center aligned. Since the two buttons only have icon, we used CENTER_RIGHT and CENTER_LEFT. If the buttons had text, we would have chosen BASELINE_RIGHT and BASELINE_LEFT so that the text of the buttons will align with the text of the TextField. The two offsets are 50 and -50. This value will move the buttons to inside the TextField. At last, in order to avoid the clipping of the text in the TextField, we add 100% (of the button size) padding on both sides.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ReadOnlyObjectProperty<T>`	`node` A read-only property for the decoration node.
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Point2D>`	`offset`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets>`	`padding`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Pos>`	`pos`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.animation.Transition>`	`transition`
`javafx.beans.property.ReadOnlyBooleanProperty`	`valueInPercent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected javafx.beans.property.ReadOnlyObjectWrapper<T>`	`_nodeProperty`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Point2D>`	`_offsetProperty`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Insets>`	`_paddingProperty`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Pos>`	`_posProperty`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.animation.Transition>`	`_transitionProperty`
`protected javafx.beans.property.ReadOnlyBooleanWrapper`	`_valueInPercentProperty`

Constructor Summary

Constructors
Constructor and Description
`Decorator()`
`Decorator(T node)` Creates a Decorator at the TOP_RIGHT position.
`Decorator(T node, javafx.geometry.Pos pos)` Creates a Decorator at the specified position.
`Decorator(T node, javafx.geometry.Pos pos, javafx.geometry.Point2D offset)` Creates a Decorator at the specified position.
`Decorator(T node, javafx.geometry.Pos pos, javafx.geometry.Point2D offset, javafx.geometry.Insets padding)` Creates a Decorator at the specified position.
`Decorator(T node, javafx.geometry.Pos pos, javafx.geometry.Point2D offset, javafx.geometry.Insets padding, jidefx.animation.AnimationType type)` Creates a Decorator at the specified position with a specified padding added to the target node.
`Decorator(T node, javafx.geometry.Pos pos, javafx.geometry.Point2D offset, javafx.geometry.Insets padding, boolean valueInPercentOrPixels, javafx.animation.Transition transition)` Creates a Decorator at the specified position with a specified padding added to the target node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`getNode()` Gets the decoration node.
`javafx.geometry.Insets`	`getPadding()` Gets the padding that will be applied to the node that is decorated.
`javafx.geometry.Pos`	`getPos()` Gets the position of the decoration.
`javafx.geometry.Point2D`	`getPosOffset()` Gets the position offset from the specified Pos.
`javafx.animation.Transition`	`getTransition()` Gets the transition.
`boolean`	`isValueInPercent()` Checks if the PosOffset and Padding is pixel based or percent based.
`javafx.beans.property.ReadOnlyObjectProperty<T>`	`nodeProperty()` A read-only property for the decoration node.
`protected javafx.beans.property.ReadOnlyObjectWrapper<T>`	`nodePropertyImpl()`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Point2D>`	`offsetProperty()`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Point2D>`	`offsetPropertyImpl()`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets>`	`paddingProperty()`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Insets>`	`paddingPropertyImpl()`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Pos>`	`posProperty()`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Pos>`	`posPropertyImpl()`
`javafx.beans.property.ReadOnlyObjectProperty<javafx.animation.Transition>`	`transitionProperty()`
`protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.animation.Transition>`	`transitionPropertyImpl()`
`javafx.beans.property.ReadOnlyBooleanProperty`	`valueInPercentProperty()`
`protected javafx.beans.property.ReadOnlyBooleanWrapper`	`valueInPercentPropertyImpl()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - node
```
public javafx.beans.property.ReadOnlyObjectProperty<T extends javafx.scene.Node> nodeProperty
```
    A read-only property for the decoration node.
    
    See Also:
    
    getNode()
  - pos
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Pos> posProperty
```
    See Also:
    
    getPos()
  - offset
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Point2D> offsetProperty
```
  - padding
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets> paddingProperty
```
    See Also:
    
    getPadding()
  - transition
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.animation.Transition> transitionProperty
```
    See Also:
    
    getTransition()
  - valueInPercent
```
public javafx.beans.property.ReadOnlyBooleanProperty valueInPercentProperty
```
    See Also:
    
    isValueInPercent()
- Field Detail
  - _nodeProperty
```
protected javafx.beans.property.ReadOnlyObjectWrapper<T extends javafx.scene.Node> _nodeProperty
```
  - _posProperty
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Pos> _posProperty
```
  - _paddingProperty
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Insets> _paddingProperty
```
  - _offsetProperty
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Point2D> _offsetProperty
```
  - _valueInPercentProperty
```
protected javafx.beans.property.ReadOnlyBooleanWrapper _valueInPercentProperty
```
  - _transitionProperty
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.animation.Transition> _transitionProperty
```
- Constructor Detail
  - Decorator
```
public Decorator()
```
  - Decorator
```
public Decorator(T node)
```
    Creates a Decorator at the TOP_RIGHT position.
    
    Parameters:
    
    node - the decoration node.
  - Decorator
```
public Decorator(T node,
                 javafx.geometry.Pos pos)
```
    Creates a Decorator at the specified position.
    
    Parameters:
    
    node - the decoration node.
    
    pos - the position of the decoration node relative to the target node. For example, TOP_RIGHT means the center of the decoration node will be at the exact top right corner of the target node.
  - Decorator
```
public Decorator(T node,
                 javafx.geometry.Pos pos,
                 javafx.geometry.Point2D offset)
```
    Creates a Decorator at the specified position. The decoration node has an offset from the specified Pos.
    
    Parameters:
    
    node - the decoration node.
    
    pos - the position of the decoration node relative to the target node. For example, TOP_RIGHT means the center of the decoration node will be at the exact top right corner of the target node.
    
    offset - the offset of the decoration node. The value in the offset is the percentage of size of the decoration node.
  - Decorator
```
public Decorator(T node,
                 javafx.geometry.Pos pos,
                 javafx.geometry.Point2D offset,
                 javafx.geometry.Insets padding)
```
    Creates a Decorator at the specified position. The decoration node has an offset from the specified Pos.
    
    Parameters:
    
    node - the decoration node.
    
    pos - the position of the decoration node relative to the target node. For example, TOP_RIGHT means the center of the decoration node will be at the exact top right corner of the target node.
    
    offset - the offset of the decoration node. The value in the offset is the percentage of size of the decoration node.
    
    padding - the padding added to the target node. The value in the padding is the percentage of size of the decoration node if valueInPercentOrPixels is true. Otherwise, it would be in pixels.
  - Decorator
```
public Decorator(T node,
                 javafx.geometry.Pos pos,
                 javafx.geometry.Point2D offset,
                 javafx.geometry.Insets padding,
                 jidefx.animation.AnimationType type)
```
    Creates a Decorator at the specified position with a specified padding added to the target node. The decoration node has an offset from the specified Pos.
    
    Parameters:
    
    node - the decoration node.
    
    pos - the position of the decoration node relative to the target node. For example, TOP_RIGHT means the center of the decoration node will be at the exact top right corner of the target node.
    
    offset - the offset of the decoration node. The value in the offset is the percentage of size of the decoration node if valueInPercentOrPixels is true. Otherwise, it would be in pixels.
    
    padding - the padding added to the target node. The value in the padding is the percentage of size of the decoration node if valueInPercentOrPixels is true. Otherwise, it would be in pixels.
    
    type - the animation type as defined in <code>AnimationType</code>.
  - Decorator
```
public Decorator(T node,
                 javafx.geometry.Pos pos,
                 javafx.geometry.Point2D offset,
                 javafx.geometry.Insets padding,
                 boolean valueInPercentOrPixels,
                 javafx.animation.Transition transition)
```
    Creates a Decorator at the specified position with a specified padding added to the target node. The decoration node has an offset from the specified Pos.
    
    Parameters:
    
    node - the decoration node.
    
    pos - the position of the decoration node relative to the target node. For example, TOP_RIGHT means the center of the decoration node will be at the exact top right corner of the target node.
    
    offset - the offset of the decoration node. The value in the offset is the percentage of size of the decoration node if valueInPercentOrPixels is true. Otherwise, it would be in pixels.
    
    padding - the padding added to the target node. The value in the padding is the percentage of size of the decoration node if valueInPercentOrPixels is true. Otherwise, it would be in pixels.
    
    valueInPercentOrPixels - true if the value in the offset and padding are percentage. Otherwise in pixels.
    
    transition - the transition
- Method Detail
  - nodeProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<T> nodeProperty()
```
    A read-only property for the decoration node.
    
    See Also:
    
    getNode()
  - nodePropertyImpl
```
protected javafx.beans.property.ReadOnlyObjectWrapper<T> nodePropertyImpl()
```
  - getNode
```
public T getNode()
```
    Gets the decoration node.
    
    Returns:
    
    the decoration node.
  - posProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Pos> posProperty()
```
    See Also:
    
    getPos()
  - posPropertyImpl
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Pos> posPropertyImpl()
```
  - getPos
```
public javafx.geometry.Pos getPos()
```
    Gets the position of the decoration. The javafx.geometry.Pos relative to the target node. The position uses the center of the decoration as the anchor point. For example, if the Pos is TOP_RIGHT, it means the center of the decoration is exactly at the top right corner of the target node.
    
    Returns:
    
    the position of the decoration.
  - offsetProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Point2D> offsetProperty()
```
  - offsetPropertyImpl
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Point2D> offsetPropertyImpl()
```
  - getPosOffset
```
public javafx.geometry.Point2D getPosOffset()
```
    Gets the position offset from the specified Pos. It allows you to move the decoration node by an offset on both x and y directions from the position defined by the getPos. The offset value could be pixels or a percentage of the size of the decoration node. If it is percentage, the x value is the percentage of the width of the target node, the y is that of the height.
    
    Returns:
    
    the position offset from the specified Pos.
  - paddingProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets> paddingProperty()
```
    See Also:
    
    getPadding()
  - paddingPropertyImpl
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.geometry.Insets> paddingPropertyImpl()
```
  - getPadding
```
public javafx.geometry.Insets getPadding()
```
    Gets the padding that will be applied to the node that is decorated. The value could be pixel based or percentage of the size of the decoration node depending on the value of isValueInPercent(). You could return null if you don't mind the decoration node overlaps with the target node, which might cover some of the content of the target node.
    
    Returns:
    
    the padding for the decorated node.
  - transitionProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<javafx.animation.Transition> transitionProperty()
```
    See Also:
    
    getTransition()
  - transitionPropertyImpl
```
protected javafx.beans.property.ReadOnlyObjectWrapper<javafx.animation.Transition> transitionPropertyImpl()
```
  - valueInPercentProperty
```
public javafx.beans.property.ReadOnlyBooleanProperty valueInPercentProperty()
```
    See Also:
    
    isValueInPercent()
  - valueInPercentPropertyImpl
```
protected javafx.beans.property.ReadOnlyBooleanWrapper valueInPercentPropertyImpl()
```
  - isValueInPercent
```
public boolean isValueInPercent()
```
    Checks if the PosOffset and Padding is pixel based or percent based.
    
    Returns:
    
    true if the values are percentage of the decoration node size. False if the values are pixels.
  - getTransition
```
public javafx.animation.Transition getTransition()
```
    Gets the transition. The transition will be used to animate the decoration node. For example, a bounce effect to bring user attention, a fade in effect to bring a sense of changing smoothly.
    
    Returns:
    
    the Transition.

Class Decorator<T extends javafx.scene.Node>

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

node

pos

offset

padding

transition

valueInPercent

Field Detail

_nodeProperty

_posProperty

_paddingProperty

_offsetProperty

_valueInPercentProperty

_transitionProperty

Constructor Detail

Decorator

Decorator

Decorator

Decorator

Decorator

Decorator

Decorator

Method Detail

nodeProperty

nodePropertyImpl

getNode

posProperty

posPropertyImpl

getPos

offsetProperty

offsetPropertyImpl

getPosOffset

paddingProperty

paddingPropertyImpl

getPadding

transitionProperty

transitionPropertyImpl

valueInPercentProperty

valueInPercentPropertyImpl

isValueInPercent

getTransition