org.nuxeo.ecm.platform.ui.web.binding.alias

Class UIAliasHolder

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

org.nuxeo.ecm.platform.ui.web.binding.alias.UIAliasHolder

All Implemented Interfaces:

EventListener, 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

public class UIAliasHolder
extends javax.faces.component.UIOutput

Holder component for value expressions.

Since 6.0 and JSF2 migration, exposed values are now stored in a view-scoped managed bean and do not need to be exposed again at render time.

This component is still interesting to anchor the component in the tree, and make sure its children are reset on ajax requests, when the value it holds can have an impact on the underlying components. In this case, it is instantiated by the AliasTagHandler or SetTagHandler facelet handlers, depending on their instantiation criteria.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

AliasTagHandler, SetTagHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected AliasVariableMapper	alias Keep the alias transient: it's supposed to be set at build time by facelet handlers and does not need to be restored/saved.
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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

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)
AliasVariableMapper	getAlias()
protected AliasVariableMapper	getAliasVariableMapper()
String	getFamily()
String	getRendererType()
boolean	getRendersChildren()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
boolean	isRendered()
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	processFacetsAndChildrenWithVariables(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	setAlias(AliasVariableMapper alias)
void	setRendered(boolean rendered)
void	setRendererType(String rendererType)
boolean	visitTree(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

alias

protected transient AliasVariableMapper alias

Keep the alias transient: it's supposed to be set at build time by facelet handlers and does not need to be restored/saved.

Since:

6.0

Constructor Detail

UIAliasHolder

public UIAliasHolder()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getRendererType

public String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

setRendererType

public void setRendererType(String rendererType)

Overrides:

setRendererType in class javax.faces.component.UIComponentBase

isRendered

public boolean isRendered()

Overrides:

isRendered in class javax.faces.component.UIComponentBase

setRendered

public void setRendered(boolean rendered)

Overrides:

setRendered 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.UIComponentBase

processValidators

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

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

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

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

processFacetsAndChildren

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

processFacetsAndChildrenWithVariables

protected final void processFacetsAndChildrenWithVariables(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)

getAlias

public AliasVariableMapper getAlias()

Since:

6.0

setAlias

public void setAlias(AliasVariableMapper alias)

Since:

6.0

getAliasVariableMapper

protected AliasVariableMapper getAliasVariableMapper()

visitTree

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

Overrides:

visitTree in class javax.faces.component.UIComponent