oracle.adf.view.rich.component.fragment

Class UIXRegion

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.rich.component.fragment.PartialUIXRegion

oracle.adf.view.rich.component.fragment.UIXRegion

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

PartialRichRegion

public class UIXRegion
extends PartialUIXRegion
implements javax.faces.component.NamingContainer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.rich.component.fragment.PartialUIXRegion

COMPONENT_FAMILY, COMPONENT_TYPE, DISCLOSED_KEY, DISCLOSURE_LISTENER_KEY, HELP_TOPIC_ID_KEY, IMMEDIATE_KEY, REGION_NAVIGATION_LISTENER_KEY, VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
	UIXRegion() Construct an instance of the UIXRegion.
protected	UIXRegion(String rendererType) Construct an instance of the UIXRegion.

Method Summary

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) The jsf components calls this method to get container's client id.
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().
protected javax.faces.event.FacesEvent	getUpdatedRegionEvent(javax.faces.event.FacesEvent event)
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)

Methods inherited from class oracle.adf.view.rich.component.fragment.PartialUIXRegion

addDisclosureListener, addRegionNavigationListener, addRegionRemoteRefreshListener, getDisclosureListener, getDisclosureListeners, getFamily, getHelpTopicId, getRegionNavigationListener, getRegionNavigationListeners, getRegionRemoteRefreshListeners, getValue, isDisclosed, isImmediate, removeDisclosureListener, removeRegionNavigationListener, removeRegionRemoteRefreshListener, setDisclosed, setDisclosureListener, setHelpTopicId, setImmediate, setRegionNavigationListener, setValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

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

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

Constructor Detail

UIXRegion

public UIXRegion()

Construct an instance of the UIXRegion.

UIXRegion

protected UIXRegion(String rendererType)

Construct an instance of the UIXRegion.

Parameters:

rendererType - Render type string

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class PartialUIXRegion

isRendered

public boolean isRendered()

Overrides:

isRendered in class org.apache.myfaces.trinidad.component.UIXComponentBase

broadcast

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

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

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

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

encodeBegin

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

Overrides:

encodeBegin in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

IOException

encodeEnd

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

Overrides:

encodeEnd in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

IOException

refresh

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

Refreshes this region's model. This method calls 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 Handle has changed.

Parameters:

context - the current FacesContext

setRegionModel

public final void setRegionModel(RegionModel model)

Sets the cached RegionModel. Typically users do not need to call this method.

Parameters:

model - use null to clear the cached RegionModel and re-execute the EL expression for this region's value.

getRegionModel

public final RegionModel getRegionModel()

This is the same as calling PartialUIXRegion.getValue(). However, this method caches the result. The cache is cleared at the start of the encode phase.

Returns:

an instance of region model

isRemoteRegionModel

public final boolean isRemoteRegionModel()

processRegion

public <S> S processRegion(javax.faces.context.FacesContext context,
                           Callable<S> processor)
                    throws Exception

Executes the 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.

Type Parameters:

S - The result type of method

Parameters:

context - the current FacesContext

processor - Callable to execute within the Region's context.

Returns:

The result of the processor or null if the Region has no RegionModel.

Throws:

NullPointerException - if context or processor is null.

Exception - if the Callable

setupChildrenVisitingContext

protected void setupChildrenVisitingContext(javax.faces.context.FacesContext context)

Overrides:

setupChildrenVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownChildrenVisitingContext

protected void tearDownChildrenVisitingContext(javax.faces.context.FacesContext context)

Overrides:

tearDownChildrenVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

invokeOnComponent

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

Overrides:

invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.FacesException

getUpdatedRegionEvent

protected javax.faces.event.FacesEvent getUpdatedRegionEvent(javax.faces.event.FacesEvent event)

decodeChildrenImpl

protected void decodeChildrenImpl(javax.faces.context.FacesContext fc)

Overrides:

decodeChildrenImpl in class org.apache.myfaces.trinidad.component.UIXComponentBase

setupFacetsAndChildren

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. When components are marked transient when partial state saving is enabled, they may not be present in the component tree and so need to be recreated especially if these components need to decode themselves. This method should always be called in context of the region's children.

Parameters:

context - the current FacesContext

updateChildrenImpl

protected void updateChildrenImpl(javax.faces.context.FacesContext fc)

Overrides:

updateChildrenImpl in class org.apache.myfaces.trinidad.component.UIXComponentBase

validateChildrenImpl

protected void validateChildrenImpl(javax.faces.context.FacesContext fc)

Overrides:

validateChildrenImpl in class org.apache.myfaces.trinidad.component.UIXComponentBase

getContainerClientId

public 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.

Overrides:

getContainerClientId in class org.apache.myfaces.trinidad.component.UIXComponentBase

See Also:

UIXComponentBase.getClientId(FacesContext context)

getContainerClientId

public String getContainerClientId(javax.faces.context.FacesContext context)

The jsf components calls this method to get container's client id.

Overrides:

getContainerClientId in class javax.faces.component.UIComponent

visitChildren

protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext,
                                javax.faces.component.visit.VisitCallback callback)

Overrides:

visitChildren in class org.apache.myfaces.trinidad.component.UIXComponent

processEvent

public void processEvent(javax.faces.event.ComponentSystemEvent event)
                  throws javax.faces.event.AbortProcessingException

Specified by:

processEvent in interface javax.faces.event.ComponentSystemEventListener

Overrides:

processEvent in class javax.faces.component.UIComponent

Throws:

javax.faces.event.AbortProcessingException