org.openfaces.component
Interface EditableStateHolder
- All Superinterfaces:
- javax.faces.component.EditableValueHolder, javax.faces.component.ValueHolder
- All Known Implementing Classes:
- FoldingPanel
public interface EditableStateHolder
- extends javax.faces.component.EditableValueHolder
This interface allows components with an "editable state" to handle their state properly inside of iteration components
such or . The "editable state" components in this case are components that are not UIInput
components by themselves but that have some of their properties editable form the client-side UI. To achieve this,
the getSubmittedValue/setSubmittedValue methods of this interface must be implemented and all of the editable state should
be saved inside of the value object managed by these methods.
Note: this interface has to extend the EditableValueHolder interface to ensure its functionality since the standard
UIData iterators (such as the DataTable component) ensure proper editable state handling only for this interface. So
since only the "submittedValue" property from EditableValueHolder is used by implementations of interface, all other functions
have to be implemented but they don't carry any functionality and are not expected to be used.
Methods inherited from interface javax.faces.component.EditableValueHolder |
addValidator, addValueChangeListener, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setValid, setValidator, setValueChangeListener |
Methods inherited from interface javax.faces.component.ValueHolder |
getConverter, getLocalValue, getValue, setConverter, setValue |
getSubmittedValue
java.lang.Object getSubmittedValue()
- Specified by:
getSubmittedValue
in interface javax.faces.component.EditableValueHolder
- Returns:
- the object that carries the editable state of the component. This editable state value is automatically
handled by the iteration components and shouldn't be used directly by application code.
setSubmittedValue
void setSubmittedValue(java.lang.Object value)
- Sets the editable state value for this component. This method is invoked by the iteration components to restore
the value that was previously received with getValue method. This method shouldn't be used directly by
application code.
- Specified by:
setSubmittedValue
in interface javax.faces.component.EditableValueHolder
Copyright © 1998-2010 TeamDev Ltd. All Rights Reserved.