KIE Uberfire Properties Editor Widget API 6.2.0.Beta2

org.kie.uberfire.properties.editor.model
Class PropertyEditorFieldInfo

java.lang.Object
  extended by org.kie.uberfire.properties.editor.model.PropertyEditorFieldInfo

@Portable
public class PropertyEditorFieldInfo
extends Object


Constructor Summary
PropertyEditorFieldInfo()
           
PropertyEditorFieldInfo(String label, PropertyEditorType type)
          Create a PropertyEditorFieldInfo
PropertyEditorFieldInfo(String label, String currentStringValue, PropertyEditorType type)
          Create a PropertyEditorFieldInfo
 
Method Summary
 List<String> getComboValues()
           
 String getCurrentStringValue()
           
 String getEventId()
           
 String getKey()
           
 String getLabel()
           
 String getOriginalValue()
           
 int getPriority()
           
 PropertyEditorType getType()
           
 List<PropertyFieldValidator> getValidators()
           
 void setCurrentStringValue(String currentStringValue)
           
 void setPropertyEditorCategory(PropertyEditorCategory category)
           
 String toString()
           
 PropertyEditorFieldInfo withComboValues(List<String> comboValues)
          Combo values used in PropertyEditorType.COMBO fields.
 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 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:

withValidators

public PropertyEditorFieldInfo withValidators(PropertyFieldValidator... validators)
Add validators to a specific field. This validators are executed before the change event.

Parameters:
validators -
Returns:

getComboValues

public List<String> getComboValues()

getType

public PropertyEditorType getType()

getOriginalValue

public String getOriginalValue()

getCurrentStringValue

public String getCurrentStringValue()

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()

toString

public String toString()
Overrides:
toString in class Object

KIE Uberfire Properties Editor Widget API 6.2.0.Beta2

Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.