oracle.adf.view.rich.component.fragment

Class PartialUIXRegion

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

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:

UIXRegion

public abstract class PartialUIXRegion
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.NamingContainer

The region tag allows dynamic content to be included in a master page. This tag is bound to a RegionModel. The model decides which viewId is to be included. The model has methods that allow pre and post processing of an include. See the javadoc for oracle.adf.view.rich.model.RegionModel. This component does not support any facets.

 <af:region value="#{mybean.myRegionModel}"/>
         

Events:

Type	Phases	Description
oracle.adf.view.rich.event.RegionRemoteRefreshEvent	Invoke Application	This event is triggered when a remote region needs to be visited during the invoke application phase. This is needed for event handling and some PPR actions.
oracle.adf.view.rich.event.RegionNavigationEvent	Invoke Application	This event is triggered when the fragment that a region is displaying changes.
org.apache.myfaces.trinidad.event.DisclosureEvent	Apply Request Values Invoke Application	The disclosure event is delivered when a node is disclosed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

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 String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSURE_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	IMMEDIATE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	REGION_NAVIGATION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	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
protected	PartialUIXRegion(String rendererType) Construct an instance of the PartialUIXRegion with the specified renderer type.

Method Summary

Modifier and Type	Method and Description
void	addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Adds a disclosure listener.
void	addRegionNavigationListener(RegionNavigationListener listener) Adds a regionNavigation listener.
void	addRegionRemoteRefreshListener(RegionRemoteRefreshListener listener) Adds a regionRemoteRefresh listener.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.el.MethodExpression	getDisclosureListener() Gets a method reference to a disclosure listener
org.apache.myfaces.trinidad.event.DisclosureListener[]	getDisclosureListeners() Returns an array of attached disclosure listeners.
String	getFamily()
String	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
javax.el.MethodExpression	getRegionNavigationListener() Gets a method reference to a RegionNavigationListener method
RegionNavigationListener[]	getRegionNavigationListeners() Returns an array of attached regionNavigation listeners.
RegionRemoteRefreshListener[]	getRegionRemoteRefreshListeners() Returns an array of attached regionRemoteRefresh listeners.
RegionModel	getValue() Gets the model for this region.
boolean	isDisclosed() Gets whether the children are currently disclosed
boolean	isImmediate() Gets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
void	removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Removes a disclosure listener.
void	removeRegionNavigationListener(RegionNavigationListener listener) Removes a regionNavigation listener.
void	removeRegionRemoteRefreshListener(RegionRemoteRefreshListener listener) Removes a regionRemoteRefresh listener.
void	setDisclosed(boolean disclosed) Sets whether the children are currently disclosed
void	setDisclosureListener(javax.el.MethodExpression disclosureListener) Sets a method reference to a disclosure listener
void	setHelpTopicId(String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setImmediate(boolean immediate) Sets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
void	setRegionNavigationListener(javax.el.MethodExpression regionNavigationListener) Sets a method reference to a RegionNavigationListener method
void	setValue(RegionModel value) Sets the model for this region.

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, 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, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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

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, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, 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

DISCLOSURE_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSURE_LISTENER_KEY

DISCLOSED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_KEY

IMMEDIATE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

REGION_NAVIGATION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey REGION_NAVIGATION_LISTENER_KEY

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialUIXRegion

protected PartialUIXRegion(String rendererType)

Construct an instance of the PartialUIXRegion with the specified renderer type.

Parameters:

rendererType - the renderer type Construct an instance of the PartialUIXRegion.

Method Detail

getDisclosureListener

public final javax.el.MethodExpression getDisclosureListener()

Gets a method reference to a disclosure listener

Returns:

the new disclosureListener value

setDisclosureListener

public final void setDisclosureListener(javax.el.MethodExpression disclosureListener)

Sets a method reference to a disclosure listener

Parameters:

disclosureListener - the new disclosureListener value

isDisclosed

public final boolean isDisclosed()

Gets whether the children are currently disclosed

Returns:

the new disclosed value

setDisclosed

public final void setDisclosed(boolean disclosed)

Sets whether the children are currently disclosed

Parameters:

disclosed - the new disclosed value

isImmediate

public final boolean isImmediate()

Gets whether data validation - client-side or server-side - should be skipped when events are generated by this component. When immediate is false (the default), the disclosure event will be delivered during the Invoke Application phase, which will trigger validation. When set to true, the disclosure event will be executed during the Apply Request Values phase.

Returns:

the new immediate value

setImmediate

public final void setImmediate(boolean immediate)

Sets whether data validation - client-side or server-side - should be skipped when events are generated by this component. When immediate is false (the default), the disclosure event will be delivered during the Invoke Application phase, which will trigger validation. When set to true, the disclosure event will be executed during the Apply Request Values phase.

Parameters:

immediate - the new immediate value

getHelpTopicId

public final String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(String helpTopicId)

Sets the id used to look up a topic in a helpProvider.

Parameters:

helpTopicId - the new helpTopicId value

getValue

public final RegionModel getValue()

Gets the model for this region.

This is a required property on the component.

Returns:

the new value value

setValue

public final void setValue(RegionModel value)

Sets the model for this region.

This is a required property on the component.

Parameters:

value - the new value value

getRegionNavigationListener

public final javax.el.MethodExpression getRegionNavigationListener()

Gets a method reference to a RegionNavigationListener method

Returns:

the new regionNavigationListener value

setRegionNavigationListener

public final void setRegionNavigationListener(javax.el.MethodExpression regionNavigationListener)

Sets a method reference to a RegionNavigationListener method

Parameters:

regionNavigationListener - the new regionNavigationListener value

addRegionRemoteRefreshListener

public final void addRegionRemoteRefreshListener(RegionRemoteRefreshListener listener)

Adds a regionRemoteRefresh listener.

Parameters:

listener - the regionRemoteRefresh listener to add

removeRegionRemoteRefreshListener

public final void removeRegionRemoteRefreshListener(RegionRemoteRefreshListener listener)

Removes a regionRemoteRefresh listener.

Parameters:

listener - the regionRemoteRefresh listener to remove

getRegionRemoteRefreshListeners

public final RegionRemoteRefreshListener[] getRegionRemoteRefreshListeners()

Returns an array of attached regionRemoteRefresh listeners.

Returns:

an array of attached regionRemoteRefresh listeners.

addRegionNavigationListener

public final void addRegionNavigationListener(RegionNavigationListener listener)

Adds a regionNavigation listener.

Parameters:

listener - the regionNavigation listener to add

removeRegionNavigationListener

public final void removeRegionNavigationListener(RegionNavigationListener listener)

Removes a regionNavigation listener.

Parameters:

listener - the regionNavigation listener to remove

getRegionNavigationListeners

public final RegionNavigationListener[] getRegionNavigationListeners()

Returns an array of attached regionNavigation listeners.

Returns:

an array of attached regionNavigation listeners.

addDisclosureListener

public final void addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)

Adds a disclosure listener.

Parameters:

listener - the disclosure listener to add

removeDisclosureListener

public final void removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)

Removes a disclosure listener.

Parameters:

listener - the disclosure listener to remove

getDisclosureListeners

public final org.apache.myfaces.trinidad.event.DisclosureListener[] getDisclosureListeners()

Returns an array of attached disclosure listeners.

Returns:

an array of attached disclosure listeners.

getFamily

public String getFamily()

Specified by:

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

getBeanType

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

Overrides:

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