public abstract class PartialUIXRegion
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.NamingContainer
<af:region value="#{mybean.myRegionModel}"/></html:p>
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. |
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 |
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
protected |
PartialUIXRegion(String rendererType)
Construct an instance of the PartialUIXRegion.
|
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.
|
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, 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
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
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 DISCLOSURE_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey REGION_NAVIGATION_LISTENER_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialUIXRegion(String rendererType)
public final javax.el.MethodExpression getDisclosureListener()
public final void setDisclosureListener(javax.el.MethodExpression disclosureListener)
disclosureListener
- the new disclosureListener valuepublic final boolean isDisclosed()
public final void setDisclosed(boolean disclosed)
disclosed
- the new disclosed valuepublic final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate valuepublic final String getHelpTopicId()
public final void setHelpTopicId(String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final RegionModel getValue()
This is a required property on the component.
public final void setValue(RegionModel value)
This is a required property on the component.
value
- the new value valuepublic final javax.el.MethodExpression getRegionNavigationListener()
public final void setRegionNavigationListener(javax.el.MethodExpression regionNavigationListener)
regionNavigationListener
- the new regionNavigationListener valuepublic final void addRegionRemoteRefreshListener(RegionRemoteRefreshListener listener)
listener
- the regionRemoteRefresh listener to addpublic final void removeRegionRemoteRefreshListener(RegionRemoteRefreshListener listener)
listener
- the regionRemoteRefresh listener to removepublic final RegionRemoteRefreshListener[] getRegionRemoteRefreshListeners()
public final void addRegionNavigationListener(RegionNavigationListener listener)
listener
- the regionNavigation listener to addpublic final void removeRegionNavigationListener(RegionNavigationListener listener)
listener
- the regionNavigation listener to removepublic final RegionNavigationListener[] getRegionNavigationListeners()
public final void addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)
listener
- the disclosure listener to addpublic final void removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)
listener
- the disclosure listener to removepublic final org.apache.myfaces.trinidad.event.DisclosureListener[] getDisclosureListeners()
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase