Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by oracle.adf.view.rich.component.fragment.UIXRegion

All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder
Direct Known Subclasses:
RichRegion

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

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

Events:

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()
           
<S> S
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

TYPE

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

DISCLOSED_KEY

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

HELP_TOPIC_ID_KEY

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

DISCLOSURE_LISTENER_KEY

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

IMMEDIATE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_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 java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

UIXRegion

public UIXRegion()
Construct an instance of the UIXRegion.

UIXRegion

protected UIXRegion(java.lang.String rendererType)
Construct an instance of the UIXRegion.

Method Detail

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 java.io.IOException
Overrides:
encodeBegin in class org.apache.myfaces.trinidad.component.UIXComponentBase
Throws:
java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext fc)
               throws java.io.IOException
Overrides:
encodeEnd in class org.apache.myfaces.trinidad.component.UIXComponentBase
Throws:
java.io.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 ID has changed.

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 getValue(). However, this method caches the result. The cache is cleared at the start of the encode phase.

processRegion

public <S> S processRegion(javax.faces.context.FacesContext context,
                           java.util.concurrent.Callable<S> processor)
                throws java.lang.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.
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:
java.lang.NullPointerException - if context or processor is null.
java.lang.Exception - if the Callable

setupVisitingContext

protected void setupVisitingContext(javax.faces.context.FacesContext context)
Overrides:
setupVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownVisitingContext

protected void tearDownVisitingContext(javax.faces.context.FacesContext context)
Overrides:
tearDownVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.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

decodeChildrenImpl

protected void decodeChildrenImpl(javax.faces.context.FacesContext fc)
Overrides:
decodeChildrenImpl in class org.apache.myfaces.trinidad.component.UIXComponentBase

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 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.
Overrides:
getContainerClientId in class org.apache.myfaces.trinidad.component.UIXComponentBase
See Also:
UIXComponentBase.getClientId(FacesContext context)

isDisclosed

public final boolean isDisclosed()
Gets whether or not to disclose the children
Returns:
the new disclosed value

setDisclosed

public final void setDisclosed(boolean disclosed)
Sets whether or not to disclose the children
Parameters:
disclosed - the new disclosed value

getHelpTopicId

public final java.lang.String getHelpTopicId()
Gets the id used to look up a topic in a helpProvider.
Returns:
the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)
Sets the id used to look up a topic in a helpProvider.
Parameters:
helpTopicId - the new helpTopicId value

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

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

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

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 java.lang.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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.