|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
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
oracle.adf.view.rich.component.rich.fragment.RichRegion
public class RichRegion
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. Regions support nesting (one af:region component can contain another af:region component). Regions are not allowed to be placed inside of af:forEach, c:forEach, or other forEach-like tags because of limitations in how JSF handles component IDs and component state which would manifest in your application in obscure manners such as loss of component state. Regions are also not allowed to be placed inside of af:iterator because the region requires bindings to be established at the tag execution phase in order to perform its JSP include operations and the variables for iterators are not established until later in the life-cycle.
Regions in release 11g are reusable page flows. They have their own navigation rules, managed beans and ADFm page definitions. Each page within the region is a page fragment (jsff). Do not confuse the 11g af:region component with the 10.1.3 or Trinidad region. The 10.1.3 and Trinidad region components are single page fragments that do not have multiple pages, navigation rules nor managed beans. The 10.1.3 region is similar to the 11g page templates and declarative components.
<section name="Attachment_Mode"> Region navigation is not supported. </section> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children only if the region header is not present. If the header is present and you put the region in a location that will stretch it or if you define styles to attempt to stretch it, you will see unpredictable results across web browsers. Instead, you may need to wrap the region in a transition component such as <af:panelGroupLayout layout="scroll" to prevent automatic stretching.</html:li> <html:li>This component gets children dynamically depending on what view is included from its RegionModel. The <af:region> will not stretch all included children, but it will stretch an included child if all of the following are true: <html:ul> <html:li>The region itself does not have a header</html:li> <html:li>The region itself is being stretched</html:li> <html:li>There is only a single included child</html:li> <html:li>The child must be capable of being stretched</html:li> </html:ul> Examples of components that can be stretched inside of a <af:region> include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox type="stretch"></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader type="stretch"></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If the region itself is being stretched and the included child cannot be stretched, you will then need to wrap it in another layout component that does not stretch its children. For example, a common wrapper is the <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that cannot be stretched inside of a <af:region> include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelBox type="flow"></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelHeader type="flow"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> </section>
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
CONTENT_DELIVERY_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_DELIVERY_KEY |
static java.lang.String |
CONTENT_DELIVERY_LAZY_UNCACHED |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DONT_PERSIST_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TOPIC_ID_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAXIMIZE_LISTENER_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAXIMIZED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PERSIST_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_DISCLOSURE_KEY |
static java.lang.String |
SHOW_HEADER_ALWAYS |
static java.lang.String |
SHOW_HEADER_IF_NEEDED |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_HEADER_KEY |
static java.lang.String |
SHOW_HEADER_NEVER |
static java.lang.String |
SHOW_MAXIMIZE_ALWAYS |
static java.lang.String |
SHOW_MAXIMIZE_AUTO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_MAXIMIZE_KEY |
static java.lang.String |
SHOW_MAXIMIZE_NEVER |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TEXT_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Fields inherited from class oracle.adf.view.rich.component.fragment.UIXRegion |
---|
DISCLOSED_KEY, DISCLOSURE_LISTENER_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 |
---|
bindings |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
RichRegion() Construct an instance of the RichRegion. |
protected |
RichRegion(java.lang.String rendererType) Construct an instance of the RichRegion. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.String |
getContentDelivery() Gets whether the undisclosed content is delivered with the initial page. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String[] |
getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
java.lang.String |
getFamily() |
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
javax.el.MethodExpression |
getMaximizeListener() Gets a method reference to a maximize listener |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String[] |
getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getShowHeader() Gets the display strategy for the Regions's header. |
java.lang.String |
getShowMaximize() Gets Whether to display the maximize control to allow this component to be maximized. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getText() Gets the header text of the Region. |
java.util.Set<java.lang.String> |
getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isMaximized() Gets whether the children are currently maximized |
boolean |
isShowDisclosure() Gets Whether or not to render the disclosure icon. |
boolean |
isVisible() Gets the visibility of the component. |
void |
queueActionEventInRegion(javax.el.MethodExpression actionExpression, javax.el.MethodExpression launchListenerMethodExpression, javax.el.MethodExpression returnListenerMethodExpression, java.lang.Boolean useWindow, java.lang.Integer windowWidth, java.lang.Integer windowHeight, javax.faces.event.PhaseId phaseId) Queues an ActionEvent so that it behaves as if you queued it on a UIXCommand component that exists inside of the region where that UIXCommand had all of these action-related settings assigned. |
void |
setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names. |
void |
setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated. |
void |
setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners. |
void |
setContentDelivery(java.lang.String contentDelivery) Sets whether the undisclosed content is delivered with the initial page. |
void |
setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setDontPersist(java.lang.String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
void |
setHelpTopicId(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setMaximized(boolean maximized) Sets whether the children are currently maximized |
void |
setMaximizeListener(javax.el.MethodExpression maximizeListener) Sets a method reference to a maximize listener |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setPersist(java.lang.String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setShowDisclosure(boolean showDisclosure) Sets Whether or not to render the disclosure icon. |
void |
setShowHeader(java.lang.String showHeader) Sets the display strategy for the Regions's header. |
void |
setShowMaximize(java.lang.String showMaximize) Sets Whether to display the maximize control to allow this component to be maximized. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setText(java.lang.String text) Sets the header text of the Region. |
void |
setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
void |
setVisible(boolean visible) Sets the visibility of the component. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, 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 java.lang.String SHOW_MAXIMIZE_NEVER
public static final java.lang.String SHOW_MAXIMIZE_AUTO
public static final java.lang.String SHOW_MAXIMIZE_ALWAYS
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
public static final java.lang.String CONTENT_DELIVERY_LAZY_UNCACHED
public static final java.lang.String SHOW_HEADER_NEVER
public static final java.lang.String SHOW_HEADER_IF_NEEDED
public static final java.lang.String SHOW_HEADER_ALWAYS
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_DISCLOSURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_MAXIMIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZE_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_HEADER_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichRegion()
protected RichRegion(java.lang.String rendererType)
Method Detail |
---|
public void queueActionEventInRegion(javax.el.MethodExpression actionExpression, javax.el.MethodExpression launchListenerMethodExpression, javax.el.MethodExpression returnListenerMethodExpression, java.lang.Boolean useWindow, java.lang.Integer windowWidth, java.lang.Integer windowHeight, javax.faces.event.PhaseId phaseId)
actionExpression
- a reference to an action method sent by the command component, or the static outcome of an actionlaunchListenerMethodExpression
- the launch listener that will be used to create a method expression if the action corresponds to a dialog navigationreturnListenerMethodExpression
- the return listener that will be used to create a method expression if the action corresponds to a dialog navigationuseWindow
- whether processes launched by this command should be launched in a secondary dialog window. "useWindow" works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Setting useWindow to "false" for the dialog to be opened in the existing window is not possible for regions since regions require fragment content when inline.windowWidth
- the width of the window, if this command is used to launch a windowwindowHeight
- the height of the window, if this command is used to launch a windowphaseId
- the ID of the phase the action event should be executedpublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist valuepublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final boolean isShowDisclosure()
public final void setShowDisclosure(boolean showDisclosure)
showDisclosure
- the new showDisclosure valuepublic final boolean isMaximized()
public final void setMaximized(boolean maximized)
maximized
- the new maximized valuepublic final java.lang.String getShowMaximize()
auto
, allows the framework to determine whether the maximize control should be displayed beased on a number of factors, including the platform that the component is being displayed on.public final void setShowMaximize(java.lang.String showMaximize)
auto
, allows the framework to determine whether the maximize control should be displayed beased on a number of factors, including the platform that the component is being displayed on.showMaximize
- the new showMaximize valuepublic final javax.el.MethodExpression getMaximizeListener()
public final void setMaximizeListener(javax.el.MethodExpression maximizeListener)
maximizeListener
- the new maximizeListener valuepublic final java.lang.String getContentDelivery()
public final void setContentDelivery(java.lang.String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final java.lang.String getHelpTopicId()
getHelpTopicId
in class UIXRegion
public final void setHelpTopicId(java.lang.String helpTopicId)
setHelpTopicId
in class UIXRegion
helpTopicId
- the new helpTopicId valuepublic final java.lang.String getText()
public final void setText(java.lang.String text)
text
- the new text valuepublic final java.lang.String getShowHeader()
public final void setShowHeader(java.lang.String showHeader)
showHeader
- the new showHeader valuepublic java.lang.String getFamily()
getFamily
in class UIXRegion
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXRegion
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |