org.uberfire.ext.properties.editor.model

Class PropertyEditorFieldInfo

java.lang.Object

org.uberfire.ext.properties.editor.model.PropertyEditorFieldInfo

Direct Known Subclasses:

CustomPropertyEditorFieldInfo

@Portable
public class PropertyEditorFieldInfo
extends Object

Constructor Summary

Constructors

Constructor and Description
PropertyEditorFieldInfo()
PropertyEditorFieldInfo(String label, PropertyEditorType type) Create a PropertyEditorFieldInfo
PropertyEditorFieldInfo(String label, String currentStringValue, PropertyEditorType type) Create a PropertyEditorFieldInfo

Method Summary

Modifier and Type	Method and Description
List<String>	getComboValues()
String	getCurrentStringValue()
String	getEventId()
String	getHelpHeading()
String	getHelpText()
String	getKey()
String	getLabel()
String	getOriginalValue()
int	getPriority()
PropertyEditorType	getType()
List<PropertyFieldValidator>	getValidators()
boolean	hasHelpInfo()
boolean	isRemovalSupported()
void	setCurrentStringValue(String currentStringValue)
void	setPropertyEditorCategory(PropertyEditorCategory category)
String	toString()
PropertyEditorFieldInfo	withComboValues(List<String> comboValues) Combo values used in PropertyEditorType.COMBO fields.
PropertyEditorFieldInfo	withHelpInfo(String helpHeading, String helpText)
PropertyEditorFieldInfo	withKey(String key) Key is a helper to identify a field.
PropertyEditorFieldInfo	withPriority(int priority) The priority value is used to sort the categories (lower values toward the beginning).
PropertyEditorFieldInfo	withRemovalSupported(boolean isRemovalSupported)
PropertyEditorFieldInfo	withValidators(PropertyFieldValidator... validators) Add validators to a specific field.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEditorFieldInfo

public PropertyEditorFieldInfo()

PropertyEditorFieldInfo

public PropertyEditorFieldInfo(String label,
                               PropertyEditorType type)

Create a PropertyEditorFieldInfo

Parameters:

label - field descriptor

type - Property Editor Type of this field

PropertyEditorFieldInfo

public PropertyEditorFieldInfo(String label,
                               String currentStringValue,
                               PropertyEditorType type)

Create a PropertyEditorFieldInfo

Parameters:

label - field descriptor

type - Property Editor Type of this field

currentStringValue - Current value of this field

Method Detail

withKey

public PropertyEditorFieldInfo withKey(String key)

Key is a helper to identify a field. Sometimes labels can have complex descriptions. This key is a nice way to identify a property in a PropertyEditorChangeEvent.

Parameters:

key -

withComboValues

public PropertyEditorFieldInfo withComboValues(List<String> comboValues)

Combo values used in PropertyEditorType.COMBO fields.

Parameters:

comboValues - a list of combo values

withPriority

public PropertyEditorFieldInfo withPriority(int priority)

The priority value is used to sort the categories (lower values toward the beginning).

Parameters:

priority -

Returns:

withHelpInfo

public PropertyEditorFieldInfo withHelpInfo(String helpHeading,
                                            String helpText)

withValidators

public PropertyEditorFieldInfo withValidators(PropertyFieldValidator... validators)

Add validators to a specific field. This validators are executed before the change event.

Parameters:

validators -

Returns:

withRemovalSupported

public PropertyEditorFieldInfo withRemovalSupported(boolean isRemovalSupported)

getComboValues

public List<String> getComboValues()

getType

public PropertyEditorType getType()

getOriginalValue

public String getOriginalValue()

getCurrentStringValue

public String getCurrentStringValue()

isRemovalSupported

public boolean isRemovalSupported()

hasHelpInfo

public boolean hasHelpInfo()

setCurrentStringValue

public void setCurrentStringValue(String currentStringValue)

setPropertyEditorCategory

public void setPropertyEditorCategory(PropertyEditorCategory category)

getLabel

public String getLabel()

getPriority

public int getPriority()

getValidators

public List<PropertyFieldValidator> getValidators()

getEventId

public String getEventId()

getKey

public String getKey()

getHelpHeading

public String getHelpHeading()

getHelpText

public String getHelpText()

toString

public String toString()

Overrides:

toString in class Object