FormularComponent (XDEV Application Framework 5.0.2 API)

Type Parameters:

C - type of the implementing JComponent

All Known Subinterfaces:

BooleanFormularComponent<C>, ColorFormularComponent<C>, DateFormularComponent<C>, ExtendedList<C>, ExtendedTable<C>, FormattedFormularComponent<C>, ImageFormularComponent<C>, MasterDetailComponent<C>, NumberFormularComponent<C>

All Known Implementing Classes:

DetailEditor.DetailComboBox, XdevCheckBox, XdevComboBox, XdevDateTextField, XdevFormattedTextField, XdevLabel, XdevLayoutCell, XdevListBox, XdevNmListBox, XdevPasswordField, XdevPicture, XdevProgressBar, XdevRadioButton, XdevSlider, XdevSpinner, XdevTable, XdevTextArea, XdevTextField, XdevTextPane
```
public interface FormularComponent<C extends JComponent>
```
Enables a JComponent to be used as a FormularComponent. A FormularComponent provides methods that allows the Formular to set and read values from the component automatically.

See Also:

BooleanFormularComponent, NumberFormularComponent, DateFormularComponent, ImageFormularComponent, MasterDetailComponent

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface FormularComponent.ValueChangeListener
Listener interface which is informed when the value changes.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`FormularComponent.ValueChangeListener` Listener interface which is informed when the value changes.

Field Summary

Fields
Modifier and Type Field and Description

static String DATA_FIELD_SEPARATOR
Separator which is used if a data field contains more entries, e.g.

Fields
Modifier and Type	Field and Description
`static String`	`DATA_FIELD_SEPARATOR` Separator which is used if a data field contains more entries, e.g.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addValidator(Validator validator)` Adds a validator to this component
`void`	`addValueChangeListener(FormularComponent.ValueChangeListener l)` Registers a `FormularComponent.ValueChangeListener`.
`Object`	`getClientProperty(Object key)` Returns the value of the property with the specified key.
`String`	`getDataField()` Returns the name of the bound data field of this formular component.
`Operator`	`getFilterOperator()` Returns the operator used in `Formular.createCondition(String)`
`String`	`getFormularName()` Returns the name of the component in the formular context.
`Object`	`getFormularValue()` Returns the value of the component.
`Validator[]`	`getValidators()` Returns all validators of this component.
`boolean`	`hasStateChanged()` Checks if the component's state since the last call of `saveState()` has changed.
`boolean`	`isEnabled()` Determines whether this component is enabled or not.
`boolean`	`isMultiSelect()` Returns whether the component supports multi selection or not.
`boolean`	`isReadOnly()` Determines whether this component is only used to display values.
`boolean`	`isVisible()` Determines whether this component is visible or not.
`void`	`putClientProperty(Object key, Object value)` Adds an arbitrary key/value "client property" to this component.
`void`	`removeValidator(Validator validator)` Removes a validator from this component
`void`	`restoreState()` Restores the internally saved state of the component.
`void`	`saveState()` Saves the state of the component internally.
`void`	`setDataField(String dataField)` Sets the name of the bound data field of this formular component.
`void`	`setFilterOperator(Operator filterOperator)` Sets the filter operator used in `Formular.createCondition(String)`
`void`	`setFormularValue(VirtualTable vt, int columnIndex, Object value)` Deprecated. replaced by {@link #setFormularValue(VirtualTable, Map)
`void`	`setFormularValue(VirtualTable vt, Map<String,Object> record)` Sets the value of the component, taking the value(s) of the record according to `getDataField()`.
`void`	`setReadOnly(boolean readOnly)` Sets if this form component is only used to display values.
`void`	`validateState()` Calls `Validator.validate(Object)` of all registered `Validator`s.
`void`	`validateState(Validation validation)` Calls `Validator.validate(Object)` of all registered `Validator`s.
`boolean`	`verify()` Returns whether the component's value adheres all set constraints.

- Field Detail
  - DATA_FIELD_SEPARATOR
```
static final String DATA_FIELD_SEPARATOR
```
    Separator which is used if a data field contains more entries, e.g. a multi column foreign key
    
    Since:
    
    3.2
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getFormularName
```
String getFormularName()
```
    Returns the name of the component in the formular context.
    
    Returns:
    
    the name of the component in the formular context.
  - setDataField
```
void setDataField(String dataField)
```
    Sets the name of the bound data field of this formular component.
    
    Parameters:
    
    dataField - the new bound data field
    
    Since:
    
    3.1
  - getDataField
```
String getDataField()
```
    Returns the name of the bound data field of this formular component.
    
    Returns:
    
    the name of the bound data field
    
    Since:
    
    3.1
  - setFormularValue
```
@Deprecated
void setFormularValue(VirtualTable vt,
                                  int columnIndex,
                                  Object value)
```
    Deprecated. replaced by {@link #setFormularValue(VirtualTable, Map)
    
    Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.
    
    Parameters:
    
    vt - VirtualTable to use the format from
    
    columnIndex - of the column to use the format from
    
    value - value to set
  - setFormularValue
```
void setFormularValue(VirtualTable vt,
                      Map<String,Object> record)
```
    Sets the value of the component, taking the value(s) of the record according to getDataField().
    
    Parameters:
    
    vt - the underlying virtual table
    
    record - the data <column,value>
    
    Since:
    
    3.2
  - getFormularValue
```
Object getFormularValue()
```
    Returns the value of the component.
    
    Returns:
    
    the value of the component.
  - saveState
```
void saveState()
```
    Saves the state of the component internally.
    A saved state can be restored using restoreState().
  - restoreState
```
void restoreState()
```
    Restores the internally saved state of the component.
    The state of the component can be saved using saveState().
  - hasStateChanged
```
boolean hasStateChanged()
```
    Checks if the component's state since the last call of saveState() has changed.
    
    Returns:
    
    true if the component's state has changed, false otherwise
    
    Since:
    
    3.1
  - addValueChangeListener
```
void addValueChangeListener(FormularComponent.ValueChangeListener l)
```
    Registers a FormularComponent.ValueChangeListener.
    
    Parameters:
    
    l - the listener to register
  - isMultiSelect
```
boolean isMultiSelect()
```
    Returns whether the component supports multi selection or not.
    A component that supports multi selection can have more than one selected item / value.
    
    Returns:
    
    true if the component supports multi selection, false otherwise.
  - verify
```
boolean verify()
```
    Returns whether the component's value adheres all set constraints.
    This is a alternative method for validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.
    
    Returns:
    
    true if the value of the component adheres all set constraints; otherwise false.
  - addValidator
```
void addValidator(Validator validator)
```
    Adds a validator to this component
    
    Parameters:
    
    validator - the validator to add
    
    Since:
    
    3.1
    
    See Also:
    
    validateState()
  - removeValidator
```
void removeValidator(Validator validator)
```
    Removes a validator from this component
    
    Parameters:
    
    validator - the validator to remove
    
    Since:
    
    3.1
    
    See Also:
    
    validateState()
  - getValidators
```
Validator[] getValidators()
```
    Returns all validators of this component.
    If no validator is present an empty array is returned.
    
    Returns:
    
    all validators of this component
    
    Since:
    
    3.1
  - validateState
```
void validateState()
            throws ValidationException
```
    Calls Validator.validate(Object) of all registered Validators.
    
    Throws:
    
    ValidationException
    
    Since:
    
    3.1
    
    See Also:
    
    verify()
  - validateState
```
void validateState(Validation validation)
            throws ValidationException
```
    Calls Validator.validate(Object) of all registered Validators.
    Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.
    
    Parameters:
    
    validation - the validation process object
    
    Throws:
    
    ValidationException
    
    Since:
    
    3.1
    
    See Also:
    
    verify()
  - getFilterOperator
```
Operator getFilterOperator()
```
    Returns the operator used in Formular.createCondition(String)
    
    Returns:
    
    the component's filter operator
    
    Since:
    
    3.1
  - setFilterOperator
```
void setFilterOperator(Operator filterOperator)
```
    Sets the filter operator used in Formular.createCondition(String)
    
    Parameters:
    
    filterOperator - the new filter operator
    
    Since:
    
    3.1
  - isReadOnly
```
boolean isReadOnly()
```
    Determines whether this component is only used to display values.
    
    Returns:
    
    true if this component is only used to display values.
    
    Since:
    
    3.2
  - setReadOnly
```
void setReadOnly(boolean readOnly)
```
    Sets if this form component is only used to display values.
    
    Parameters:
    
    readOnly - true to only display values
    
    Since:
    
    3.2
  - isVisible
```
boolean isVisible()
```
    Determines whether this component is visible or not.
    
    Returns:
    
    true if the component is visible, false otherwise
  - isEnabled
```
boolean isEnabled()
```
    Determines whether this component is enabled or not.
    
    Returns:
    
    true if the component is enabled, false otherwise
  - putClientProperty
```
void putClientProperty(Object key,
                       Object value)
```
    Adds an arbitrary key/value "client property" to this component.
    The get/putClientProperty methods provide access to a small per-instance hashtable. Callers can use get/putClientProperty to annotate components that were created by another module. For example, a layout manager might store per child constraints this way. For example:
```
 componentA.putClientProperty("to the left of",componentB);
 
```
    If value is null this method will remove the property. Changes to client properties are reported with PropertyChange events. The name of the property (for the sake of PropertyChange events) is key.toString().
    The clientProperty dictionary is not intended to support large scale extensions to form nor should be it considered an alternative to subclassing when designing a new component.
    Parameters:
    
    key - the new client property key
    
    value - the new client property value; if null this method will remove the property
    
    See Also:
    
    getClientProperty(java.lang.Object)
  - getClientProperty
```
Object getClientProperty(Object key)
```
    Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non- null value.
    
    Parameters:
    
    key - the being queried
    
    Returns:
    
    the value of this property or null
    
    See Also:
    
    putClientProperty(java.lang.Object, java.lang.Object)

Interface FormularComponent<C extends JComponent>

Nested Class Summary

Field Summary

Method Summary

Field Detail

DATA_FIELD_SEPARATOR

Method Detail

getFormularName

setDataField

getDataField

setFormularValue

setFormularValue

getFormularValue

saveState

restoreState

hasStateChanged

addValueChangeListener

isMultiSelect

verify

addValidator

removeValidator

getValidators

validateState

validateState

getFilterOperator

setFilterOperator

isReadOnly

setReadOnly

isVisible

isEnabled

putClientProperty

getClientProperty