jidefx.scene.control.decoration

Class MutableDecorator<T extends javafx.scene.Node>

java.lang.Object

jidefx.scene.control.decoration.Decorator<T>

jidefx.scene.control.decoration.MutableDecorator<T>

Type Parameters:

T - the type of the decoration node.

public class MutableDecorator<T extends javafx.scene.Node>
extends Decorator<T>

MutableDecorator is a decorator whose position information can be changed.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<T>	node A read-only property for the decoration node.
javafx.beans.property.ObjectProperty<javafx.geometry.Point2D>	offset
javafx.beans.property.ObjectProperty<javafx.geometry.Insets>	padding
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	pos
javafx.beans.property.ObjectProperty<javafx.animation.Transition>	transition
javafx.beans.property.BooleanProperty	valueInPercent

Field Summary

Fields inherited from class jidefx.scene.control.decoration.Decorator

_nodeProperty, _offsetProperty, _paddingProperty, _posProperty, _transitionProperty, _valueInPercentProperty

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<T>	nodeProperty() A read-only property for the decoration node.
javafx.beans.property.ObjectProperty<javafx.geometry.Point2D>	offsetProperty()
javafx.beans.property.ObjectProperty<javafx.geometry.Insets>	paddingProperty()
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	posProperty()
void	setPadding(javafx.geometry.Insets padding) Sets the padding to the target node.
void	setPos(javafx.geometry.Pos pos) Sets the position of the decoration node relative to the target node.
void	setPosOffset(javafx.geometry.Point2D offset) Sets the offset of the decoration node.
void	setTransition(javafx.animation.Transition transition) Sets the transition.
void	setValueInPercent(boolean valueInPercent) Sets the flag if the value is in percentage or pixels.
javafx.beans.property.ObjectProperty<javafx.animation.Transition>	transitionProperty()
javafx.beans.property.BooleanProperty	valueInPercentProperty()

Methods inherited from class jidefx.scene.control.decoration.Decorator

getNode, getPadding, getPos, getPosOffset, getTransition, isValueInPercent, nodePropertyImpl, offsetPropertyImpl, paddingPropertyImpl, posPropertyImpl, transitionPropertyImpl, 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.ObjectProperty<T extends javafx.scene.Node> nodeProperty

Overrides:

nodeProperty in class Decorator<T extends javafx.scene.Node>

See Also:

Decorator.getNode()

pos

public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> posProperty

Overrides:

posProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setPos(Pos)

padding

public javafx.beans.property.ObjectProperty<javafx.geometry.Insets> paddingProperty

Overrides:

paddingProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setPadding(Insets)

offset

public javafx.beans.property.ObjectProperty<javafx.geometry.Point2D> offsetProperty

Overrides:

offsetProperty in class Decorator<T extends javafx.scene.Node>

transition

public javafx.beans.property.ObjectProperty<javafx.animation.Transition> transitionProperty

Overrides:

transitionProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setTransition(Transition)

valueInPercent

public javafx.beans.property.BooleanProperty valueInPercentProperty

Overrides:

valueInPercentProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setValueInPercent(boolean)

Constructor Detail

MutableDecorator

public MutableDecorator()

MutableDecorator

public MutableDecorator(T node)

Creates a MutableDecorator at the TOP_RIGHT position.

Parameters:

node - the decoration node.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos)

Creates a MutableDecorator 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.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos,
                        javafx.geometry.Point2D offset)

Creates a MutableDecorator 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.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos,
                        javafx.geometry.Point2D offset,
                        javafx.geometry.Insets padding)

Creates a MutableDecorator 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.

padding - the padding added to the target node. The value in the padding is the percentage of size of the decoration node.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos,
                        javafx.geometry.Point2D offset,
                        javafx.geometry.Insets padding,
                        boolean valueInPercentOrPixels)

Creates a MutableDecorator 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.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos,
                        javafx.geometry.Point2D offset,
                        javafx.geometry.Insets padding,
                        boolean valueInPercentOrPixels,
                        jidefx.animation.AnimationType type)

Creates a MutableDecorator 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.

type - the animation type as defined in <code>AnimationType</code>.

MutableDecorator

public MutableDecorator(T node,
                        javafx.geometry.Pos pos,
                        javafx.geometry.Point2D offset,
                        javafx.geometry.Insets padding,
                        boolean valueInPercentOrPixels,
                        javafx.animation.Transition transition)

Creates a MutableDecorator 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.ObjectProperty<T> nodeProperty()

Description copied from class: Decorator

A read-only property for the decoration node.

Overrides:

nodeProperty in class Decorator<T extends javafx.scene.Node>

See Also:

Decorator.getNode()

posProperty

public javafx.beans.property.ObjectProperty<javafx.geometry.Pos> posProperty()

Overrides:

posProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setPos(Pos)

paddingProperty

public javafx.beans.property.ObjectProperty<javafx.geometry.Insets> paddingProperty()

Overrides:

paddingProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setPadding(Insets)

offsetProperty

public javafx.beans.property.ObjectProperty<javafx.geometry.Point2D> offsetProperty()

Overrides:

offsetProperty in class Decorator<T extends javafx.scene.Node>

transitionProperty

public javafx.beans.property.ObjectProperty<javafx.animation.Transition> transitionProperty()

Overrides:

transitionProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setTransition(Transition)

valueInPercentProperty

public javafx.beans.property.BooleanProperty valueInPercentProperty()

Overrides:

valueInPercentProperty in class Decorator<T extends javafx.scene.Node>

See Also:

setValueInPercent(boolean)

setPos

public void setPos(javafx.geometry.Pos pos)

Sets the position of the decoration node relative to the target node.

Parameters:

pos - the Pos.

setPosOffset

public void setPosOffset(javafx.geometry.Point2D offset)

Sets the offset of the decoration node. The value in the offset is the percentage of the size of the decoration node if the Decorator.isValueInPercent() is true. If not, the values should be in pixels.

Parameters:

offset - the offset.

setPadding

public void setPadding(javafx.geometry.Insets padding)

Sets the padding to the target node. The value in the padding is the percentage of the size of the decoration node if the Decorator.isValueInPercent() is true. If not, the values should be in pixels.

Parameters:

padding - the padding.

setTransition

public void setTransition(javafx.animation.Transition transition)

Sets the transition.

Parameters:

transition - a new transition.

setValueInPercent

public void setValueInPercent(boolean valueInPercent)

Sets the flag if the value is in percentage or pixels.

Parameters:

valueInPercent - true or false.