|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.UIXRegion
public class UIXRegion
<html:p> 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}"/>
</html:p>
Type | Phases | Description |
---|---|---|
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.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 |
---|
bindings |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
UIXRegion() Construct an instance of the UIXRegion. |
protected |
UIXRegion(java.lang.String rendererType) Construct an instance of the UIXRegion. |
Method Summary | ||
---|---|---|
void |
addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Adds a disclosure listener. |
|
void |
addRegionNavigationListener(RegionNavigationListener listener) Adds a regionNavigation listener. |
|
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() |
|
java.lang.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. |
|
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. |
|
java.lang.String |
getFamily() |
|
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
|
RegionModel |
getRegionModel() This is the same as calling getValue() . |
|
javax.el.MethodExpression |
getRegionNavigationListener() Gets a method reference to a RegionNavigationListener method |
|
RegionNavigationListener[] |
getRegionNavigationListeners() Returns an array of attached regionNavigation listeners. |
|
RegionModel |
getValue() Gets the model for this region. |
|
boolean |
invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) |
|
boolean |
isDisclosed() Gets whether or not to disclose the children |
|
boolean |
isImmediate() Gets whether data validation - client-side or server-side - should be skipped when events are generated by this component. |
|
boolean |
isRendered() |
|
|
processRegion(javax.faces.context.FacesContext context, java.util.concurrent.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 |
removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Removes a disclosure listener. |
|
void |
removeRegionNavigationListener(RegionNavigationListener listener) Removes a regionNavigation listener. |
|
void |
setDisclosed(boolean disclosed) Sets whether or not to disclose the children |
|
void |
setDisclosureListener(javax.el.MethodExpression disclosureListener) Sets a method reference to a disclosure listener |
|
void |
setHelpTopicId(java.lang.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 |
setRegionModel(RegionModel model) Sets the cached RegionModel. |
|
void |
setRegionNavigationListener(javax.el.MethodExpression regionNavigationListener) Sets a method reference to a RegionNavigationListener method |
|
protected void |
setupVisitingContext(javax.faces.context.FacesContext context) |
|
void |
setValue(RegionModel value) Sets the model for this region. |
|
protected void |
tearDownVisitingContext(javax.faces.context.FacesContext context) |
|
protected void |
updateChildrenImpl(javax.faces.context.FacesContext fc) |
|
protected void |
validateChildrenImpl(javax.faces.context.FacesContext fc) |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSURE_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_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 java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIXRegion()
protected UIXRegion(java.lang.String rendererType)
Method Detail |
---|
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 java.io.IOException
encodeBegin
in class org.apache.myfaces.trinidad.component.UIXComponentBase
java.io.IOException
public void encodeEnd(javax.faces.context.FacesContext fc) throws java.io.IOException
encodeEnd
in class org.apache.myfaces.trinidad.component.UIXComponentBase
java.io.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()
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, java.util.concurrent.Callable<S> processor) throws java.lang.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.java.lang.NullPointerException
- if context
or processor
is null
.java.lang.Exception
- if the Callableprotected void setupVisitingContext(javax.faces.context.FacesContext context)
setupVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
protected void tearDownVisitingContext(javax.faces.context.FacesContext context)
tearDownVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.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
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 java.lang.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)
public final boolean isDisclosed()
public final void setDisclosed(boolean disclosed)
disclosed
- the new disclosed valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final javax.el.MethodExpression getDisclosureListener()
public final void setDisclosureListener(javax.el.MethodExpression disclosureListener)
disclosureListener
- the new disclosureListener valuepublic final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate 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 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 java.lang.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
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |