public class UIXInclude extends PartialUIXInclude implements javax.faces.component.NamingContainer
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VIEW_ID_KEY |
COMPONENT_FAMILY, COMPONENT_TYPE, COMPONENT_VAR_KEY, VAR_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
UIXInclude()
Construct an instance of the UIXInclude.
|
protected |
UIXInclude(String rendererType)
Construct an instance of the UIXInclude.
|
Modifier and Type | Method and Description |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event) |
protected org.apache.myfaces.trinidad.bean.FacesBean |
createFacesBean(String rendererType) |
protected Object |
getAttribute(Object key) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
protected Iterator<javax.faces.component.UIComponent> |
getRenderedFacetsAndChildren(javax.faces.context.FacesContext facesContext) |
String |
getViewId()
Gets the view ID.
|
boolean |
invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
Override to always setup the visiting context before invoking the callback, or our children
|
void |
queueEvent(javax.faces.event.FacesEvent evt) |
void |
resumeContext(javax.faces.context.FacesContext facesContext)
Resume the include's context that has been suspended.
|
protected Object |
setAttribute(Object key, Object value)
Sets the attribute of a component via the value expression.
|
protected void |
setupChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
Sets up EL variables including the attribute map for use by the children of this include.
|
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult |
suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange)
Called by the
suspendContext(FacesContext) method to determine how far back to suspend the application context changes. |
void |
suspendContext(javax.faces.context.FacesContext facesContext)
Suspend the include component that is currently in context.
|
protected void |
tearDownChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
Restores the previous values of all the EL variables maintained by this component.
|
getComponentVar, getFamily, getVar, setComponentVar, setVar
finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext, setupVisitingContext, tearDownVisitingContext
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VIEW_ID_KEY
public UIXInclude()
protected UIXInclude(String rendererType)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class PartialUIXInclude
public void queueEvent(javax.faces.event.FacesEvent evt)
queueEvent
in class ContextSwitchingComponent
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class ContextSwitchingComponent
javax.faces.event.AbortProcessingException
public boolean invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
ContextSwitchingComponent
invokeOnComponent
in class ContextSwitchingComponent
javax.faces.FacesException
ContextSwitchingComponent.setupVisitingContext(javax.faces.context.FacesContext)
, ContextSwitchingComponent.tearDownVisitingContext(javax.faces.context.FacesContext)
protected void setupChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
setupChildrenVisitingContext
in class ContextSwitchingComponent
protected void tearDownChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
tearDownChildrenVisitingContext
in class ContextSwitchingComponent
public void suspendContext(javax.faces.context.FacesContext facesContext) throws IllegalStateException
facesContext
- the faces contextIllegalStateException
- if the include is not currently in contextpublic void resumeContext(javax.faces.context.FacesContext facesContext) throws IllegalStateException
facesContext
- the faces contextIllegalStateException
- if the include is not suspendedpublic String getViewId()
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange)
suspendContext(FacesContext)
method to determine how far back to suspend the application context changes.contextChange
- The change to considerprotected Object setAttribute(Object key, Object value)
getAttributes().put(Object, Object)
is that this method will update the value expression rather than updating the component attribute if the key corresponds to a writable value expression.key
- The key of the attribute to set (should be a string)value
- The value to setprotected org.apache.myfaces.trinidad.bean.FacesBean createFacesBean(String rendererType)
createFacesBean
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected Iterator<javax.faces.component.UIComponent> getRenderedFacetsAndChildren(javax.faces.context.FacesContext facesContext)
getRenderedFacetsAndChildren
in class org.apache.myfaces.trinidad.component.UIXComponentBase