org.nuxeo.ecm.platform.ui.web.component.holder

Class UIValueHolder

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.nuxeo.ecm.platform.ui.web.component.holder.UIValueHolder

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

public class UIValueHolder
extends UIInput

Component that keeps and exposes a value to the context during each JSF phase.

Can be bound to a value as an input component, or not.

Since:

5.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
UIValueHolder()

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	encodeChildren(FacesContext context)
Object	getDefaultValue()
String	getFamily()
String	getRendererType()
boolean	getRendersChildren()
Boolean	getSubmitValue()
Object	getValueToExpose()
String	getVar()
boolean	invokeOnComponent(FacesContext context, String clientId, ContextCallback callback)
void	processDecodes(FacesContext context)
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	queueEvent(FacesEvent event)
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context) Saves the locally set literal values kept on the component (from standard tags attributes) and since 5.6, also saves the submitted value as UIInput.saveState(FacesContext) does not do it (see NXP-8898).
void	setDefaultValue(Object defaultValue)
void	setSubmitValue(Boolean submitValue)
void	setVar(String var)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIValueHolder

public UIValueHolder()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

getRendererType

public String getRendererType()

Overrides:

getRendererType in class UIComponentBase

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

broadcast

public void broadcast(FacesEvent event)

Overrides:

broadcast in class UIComponentBase

queueEvent

public void queueEvent(FacesEvent event)

Overrides:

queueEvent in class UIComponentBase

invokeOnComponent

public boolean invokeOnComponent(FacesContext context,
                        String clientId,
                        ContextCallback callback)
                          throws FacesException

Overrides:

invokeOnComponent in class UIComponentBase

Throws:

FacesException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

processDecodes

public void processDecodes(FacesContext context)

Overrides:

processDecodes in class UIInput

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIInput

processUpdates

public void processUpdates(FacesContext context)

Overrides:

processUpdates in class UIInput

getVar

public String getVar()

setVar

public void setVar(String var)

getDefaultValue

public Object getDefaultValue()

setDefaultValue

public void setDefaultValue(Object defaultValue)

getSubmitValue

public Boolean getSubmitValue()

setSubmitValue

public void setSubmitValue(Boolean submitValue)

getValueToExpose

public Object getValueToExpose()

restoreState

public void restoreState(FacesContext context,
                Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIInput

saveState

public Object saveState(FacesContext context)

Saves the locally set literal values kept on the component (from standard tags attributes) and since 5.6, also saves the submitted value as UIInput.saveState(FacesContext) does not do it (see NXP-8898).

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIInput