public class UIXRegion extends PartialUIXRegion implements javax.faces.component.NamingContainer
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
COMPONENT_FAMILY, COMPONENT_TYPE, DISCLOSED_KEY, DISCLOSURE_LISTENER_KEY, HELP_TOPIC_ID_KEY, IMMEDIATE_KEY, REGION_NAVIGATION_LISTENER_KEY, VALUE_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
UIXRegion()
Construct an instance of the UIXRegion.
|
protected |
UIXRegion(String rendererType)
Construct an instance of the UIXRegion.
|
Modifier and Type | Method and Description |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event) |
protected void |
decodeChildrenImpl(javax.faces.context.FacesContext fc) |
void |
encodeBegin(javax.faces.context.FacesContext fc) |
void |
encodeEnd(javax.faces.context.FacesContext fc) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
String |
getContainerClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent uiComponent)
Provides additional context to a naming container for constructing a client ID that contains a token or an index of the page fragment that is currently in use.
|
RegionModel |
getRegionModel()
This is the same as calling
PartialUIXRegion.getValue() . |
boolean |
invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) |
boolean |
isRemoteRegionModel() |
boolean |
isRendered() |
void |
processEvent(javax.faces.event.ComponentSystemEvent event) |
<S> S |
processRegion(javax.faces.context.FacesContext context, Callable<S> processor)
Executes the
processor inside the Region's context, returning the result and throwing anu processor exception. |
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
refresh(javax.faces.context.FacesContext context)
Refreshes this region's model.
|
void |
setRegionModel(RegionModel model)
Sets the cached RegionModel.
|
protected void |
setupChildrenVisitingContext(javax.faces.context.FacesContext context) |
protected void |
setupFacetsAndChildren(javax.faces.context.FacesContext context)
This method can be used by derived classes to setup any facets or children needed during decode.
|
protected void |
tearDownChildrenVisitingContext(javax.faces.context.FacesContext context) |
protected void |
updateChildrenImpl(javax.faces.context.FacesContext fc) |
protected void |
validateChildrenImpl(javax.faces.context.FacesContext fc) |
protected boolean |
visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback) |
addDisclosureListener, addRegionNavigationListener, addRegionRemoteRefreshListener, getDisclosureListener, getDisclosureListeners, getFamily, getHelpTopicId, getRegionNavigationListener, getRegionNavigationListeners, getRegionRemoteRefreshListeners, getValue, isDisclosed, isImmediate, removeDisclosureListener, removeRegionNavigationListener, removeRegionRemoteRefreshListener, setDisclosed, setDisclosureListener, setHelpTopicId, setImmediate, setRegionNavigationListener, setValue
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public UIXRegion()
protected UIXRegion(String rendererType)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class PartialUIXRegion
public boolean isRendered()
isRendered
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void encodeBegin(javax.faces.context.FacesContext fc) throws IOException
encodeBegin
in class org.apache.myfaces.trinidad.component.UIXComponentBase
IOException
public void encodeEnd(javax.faces.context.FacesContext fc) throws IOException
encodeEnd
in class org.apache.myfaces.trinidad.component.UIXComponentBase
IOException
public void refresh(javax.faces.context.FacesContext context)
RegionModel.refresh(javax.faces.context.FacesContext)
, and adds this region as a PPR target
if the view ID has changed. This method must only be called during PhaseId.INVOKE_APPLICATION
phase. A RegionNavigationEvent
is queued if the view ID has changed.public final void setRegionModel(RegionModel model)
model
- use null to clear the cached RegionModel and re-execute the EL expression for this region's value.public final RegionModel getRegionModel()
PartialUIXRegion.getValue()
. However, this method caches the result. The cache is cleared at the start of the encode phase.public <S> S processRegion(javax.faces.context.FacesContext context, Callable<S> processor) throws Exception
processor
inside the Region's context, returning the result and throwing anu processor
exception. The Region Component must be in scope when this method is called.context
- the current FacesContextprocessor
- Callable to execute within the Region's context.processor
or null
if the Region has no RegionModel.NullPointerException
- if context
or processor
is null
.Exception
- if the Callableprotected void setupChildrenVisitingContext(javax.faces.context.FacesContext context)
setupChildrenVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
protected void tearDownChildrenVisitingContext(javax.faces.context.FacesContext context)
tearDownChildrenVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.FacesException
protected void decodeChildrenImpl(javax.faces.context.FacesContext fc)
decodeChildrenImpl
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public final boolean isRemoteRegionModel()
protected void setupFacetsAndChildren(javax.faces.context.FacesContext context)
protected void updateChildrenImpl(javax.faces.context.FacesContext fc)
updateChildrenImpl
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected void validateChildrenImpl(javax.faces.context.FacesContext fc)
validateChildrenImpl
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getContainerClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent uiComponent)
getContainerClientId
in class org.apache.myfaces.trinidad.component.UIXComponentBase
UIXComponentBase.getClientId(FacesContext context)
protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)
visitChildren
in class org.apache.myfaces.trinidad.component.UIXComponent
public void processEvent(javax.faces.event.ComponentSystemEvent event) throws javax.faces.event.AbortProcessingException
processEvent
in interface javax.faces.event.ComponentSystemEventListener
processEvent
in class javax.faces.component.UIComponent
javax.faces.event.AbortProcessingException