public static class VisualFormatter.Item.Property<T>
extends java.lang.Object
VisualFormatter.Item.Property is a class representing a property of
a visual formatting item, used to add custom parameters that can change the runtime
behavior of the formatting item. A property can be of different types and directions.| Modifier and Type | Class and Description |
|---|---|
static class |
VisualFormatter.Item.Property.Direction
VisualFormatter.Item.Property.Direction is an enumeration representing
the direction of the property. |
static class |
VisualFormatter.Item.Property.Type
VisualFormatter.Item.Property.Type is an enumeration representing
the type of property. |
| Constructor and Description |
|---|
Property(java.lang.String id,
java.lang.String name,
java.lang.String description,
VisualFormatter.Item.Property.Type type,
VisualFormatter.Item.Property.Direction direction,
T defaultValue,
T value) |
| Modifier and Type | Method and Description |
|---|---|
T |
getDefaultValue()
Returns the property default value.
|
java.lang.String |
getDescription()
Returns the property description.
|
VisualFormatter.Item.Property.Direction |
getDirection()
Returns the property direction.
|
java.lang.String |
getId()
Returns the property id that uniquely identifies this property.
|
java.lang.String |
getName()
Returns the property name.
|
VisualFormatter.Item.Property.Type |
getType()
Returns the property type.
|
T |
getValue()
Returns the property current value.
|
boolean |
isHiddenFromUI() |
void |
setValue(T value)
Sets the property current value.
|
public Property(java.lang.String id,
java.lang.String name,
java.lang.String description,
VisualFormatter.Item.Property.Type type,
VisualFormatter.Item.Property.Direction direction,
T defaultValue,
T value)
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getDescription()
public VisualFormatter.Item.Property.Type getType()
public VisualFormatter.Item.Property.Direction getDirection()
public T getDefaultValue()
public T getValue()
public boolean isHiddenFromUI()
public void setValue(T value)
value - The value to set.