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

javax.faces.component.html.HtmlInputText

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

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ResettableComponent

public class UIValueHolder
extends javax.faces.component.html.HtmlInputText
implements ResettableComponent

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 submit the value and still expose it to the context at build time as well as at render time.

Since:

5.5

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlInputText

javax.faces.component.html.HtmlInputText.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
protected Object	submittedValue The submittedValue value of this UIInput component.
protected Boolean	submitValue
protected String	var

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UIValueHolder()

Method Summary

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeChildren(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
protected AliasVariableMapper	getAliasVariableMapper(javax.faces.context.FacesContext ctx)
String	getFaceletId()
String	getFamily()
String	getRendererType()
boolean	getRendersChildren()
Object	getSubmittedValue()
Boolean	getSubmitValue()
Object	getValueToExpose()
String	getVar()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
NuxeoValueHolderBean	lookupBean(javax.faces.context.FacesContext ctx)
protected void	processComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)
void	processDecodes(javax.faces.context.FacesContext context)
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected void	processFacetsAndChildrenWithVariable(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	resetCachedModel() Resets the value holder local values
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.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).
protected void	saveToBean(Object value)
void	setSubmittedValue(Object submittedValue)
void	setSubmitValue(Boolean submitValue)
void	setValue(Object value)
void	setVar(String var)
boolean	visitTree(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getEventNames, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setAutocomplete, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setValid, setValidator, setValidatorMessage, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

var

protected String var

submittedValue

protected transient Object submittedValue

The submittedValue value of this UIInput component.

submitValue

protected Boolean submitValue

Constructor Detail

UIValueHolder

public UIValueHolder()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getRendererType

public String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)

Overrides:

broadcast in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIComponentBase

Throws:

javax.faces.FacesException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class javax.faces.component.UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

IOException

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIInput

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIInput

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIInput

processFacetsAndChildren

protected final void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                              javax.faces.event.PhaseId phaseId)

processFacetsAndChildrenWithVariable

protected final void processFacetsAndChildrenWithVariable(javax.faces.context.FacesContext context,
                                                          javax.faces.event.PhaseId phaseId)

processComponent

protected final void processComponent(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component,
                                      javax.faces.event.PhaseId phaseId)

getVar

public String getVar()

setVar

public void setVar(String var)

getSubmitValue

public Boolean getSubmitValue()

setSubmitValue

public void setSubmitValue(Boolean submitValue)

getValueToExpose

public Object getValueToExpose()

getAliasVariableMapper

protected AliasVariableMapper getAliasVariableMapper(javax.faces.context.FacesContext ctx)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput

saveState

public Object saveState(javax.faces.context.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 javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

resetCachedModel

public void resetCachedModel()

Resets the value holder local values

Specified by:

resetCachedModel in interface ResettableComponent

Since:

5.7

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext visitContext,
                         javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIComponent

getFaceletId

public String getFaceletId()

lookupBean

public NuxeoValueHolderBean lookupBean(javax.faces.context.FacesContext ctx)

saveToBean

protected void saveToBean(Object value)

setSubmittedValue

public void setSubmittedValue(Object submittedValue)

Specified by:

setSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

setSubmittedValue in class javax.faces.component.UIInput

getSubmittedValue

public Object getSubmittedValue()

Specified by:

getSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

getSubmittedValue in class javax.faces.component.UIInput

setValue

public void setValue(Object value)

Specified by:

setValue in interface javax.faces.component.ValueHolder

Overrides:

setValue in class javax.faces.component.UIInput