com.datalogic.decode

Class VisualFormatter.Item.Property<T>

java.lang.Object

com.datalogic.decode.VisualFormatter.Item.Property<T>

Enclosing class:

VisualFormatter.Item

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.

Nested Class Summary

Nested Classes

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 Summary

Constructors

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)

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Property

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)

Method Detail

getId

public java.lang.String getId()

Returns the property id that uniquely identifies this property.

Returns:

The property id.

getName

public java.lang.String getName()

Returns the property name.

Returns:

The property name.

getDescription

public java.lang.String getDescription()

Returns the property description.

Returns:

The property description.

getType

public VisualFormatter.Item.Property.Type getType()

Returns the property type.

Returns:

The property type.

getDirection

public VisualFormatter.Item.Property.Direction getDirection()

Returns the property direction.

Returns:

The property direction.

getDefaultValue

public T getDefaultValue()

Returns the property default value.

Returns:

The property default value.

getValue

public T getValue()

Returns the property current value.

Returns:

The property current value.

isHiddenFromUI

public boolean isHiddenFromUI()

setValue

public void setValue(T value)

Sets the property current value.

Parameters:

value - The value to set.