public abstract class PartialRichRegion extends UIXRegion implements javax.faces.component.behavior.ClientBehaviorHolder
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="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 event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
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 String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
CONTENT_DELIVERY_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_DELIVERY_KEY |
static 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 |
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 String |
SHOW_HEADER_ALWAYS |
static String |
SHOW_HEADER_IF_NEEDED |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_HEADER_KEY |
static String |
SHOW_HEADER_NEVER |
static String |
SHOW_MAXIMIZE_ALWAYS |
static String |
SHOW_MAXIMIZE_AUTO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_MAXIMIZE_KEY |
static 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 |
UNCOMMITTED_DATA_WARNING_KEY |
static String |
UNCOMMITTED_DATA_WARNING_OFF |
static String |
UNCOMMITTED_DATA_WARNING_ON |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
DISCLOSED_KEY, DISCLOSURE_LISTENER_KEY, HELP_TOPIC_ID_KEY, IMMEDIATE_KEY, REGION_NAVIGATION_LISTENER_KEY, VALUE_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
protected |
PartialRichRegion(String rendererType)
Construct an instance of the PartialRichRegion.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getContentDelivery()
Gets whether the undisclosed content is delivered with the initial page.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
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.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
javax.el.MethodExpression |
getMaximizeListener()
Gets a method reference to a maximize listener
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
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.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getShowHeader()
Gets the display strategy for the region's header.
|
String |
getShowMaximize()
Gets Whether to display the maximize control to allow this component to be maximized.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getText()
Gets the header text of the Region.
|
String |
getUncommittedDataWarning()
Gets Specifies whether the framework should be tracking uncommitted data for this region.
|
Set<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 |
setClientAttributes(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(String contentDelivery)
Sets whether the undisclosed content is delivered with the initial page.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setDontPersist(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 |
setInlineStyle(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(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setPersist(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(String shortDesc)
Sets the short description of the component.
|
void |
setShowDisclosure(boolean showDisclosure)
Sets Whether or not to render the disclosure icon.
|
void |
setShowHeader(String showHeader)
Sets the display strategy for the region's header.
|
void |
setShowMaximize(String showMaximize)
Sets Whether to display the maximize control to allow this component to be maximized.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setText(String text)
Sets the header text of the Region.
|
void |
setUncommittedDataWarning(String uncommittedDataWarning)
Sets Specifies whether the framework should be tracking uncommitted data for this region.
|
void |
setUnsecure(Set<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.
|
broadcast, decodeChildrenImpl, encodeBegin, encodeEnd, getContainerClientId, getRegionModel, getUpdatedRegionEvent, invokeOnComponent, isRemoteRegionModel, isRendered, processEvent, processRegion, queueEvent, refresh, setRegionModel, setupChildrenVisitingContext, setupFacetsAndChildren, tearDownChildrenVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren
addDisclosureListener, addRegionNavigationListener, addRegionRemoteRefreshListener, getDisclosureListener, getDisclosureListeners, getHelpTopicId, getRegionNavigationListener, getRegionNavigationListeners, getRegionRemoteRefreshListeners, getValue, isDisclosed, isImmediate, removeDisclosureListener, removeRegionNavigationListener, removeRegionRemoteRefreshListener, setDisclosed, setDisclosureListener, setHelpTopicId, setImmediate, setRegionNavigationListener, setValue
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, 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, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String SHOW_MAXIMIZE_NEVER
public static final String SHOW_MAXIMIZE_AUTO
public static final String SHOW_MAXIMIZE_ALWAYS
public static final String CONTENT_DELIVERY_IMMEDIATE
public static final String CONTENT_DELIVERY_LAZY_UNCACHED
public static final String SHOW_HEADER_NEVER
public static final String SHOW_HEADER_IF_NEEDED
public static final String SHOW_HEADER_ALWAYS
public static final String UNCOMMITTED_DATA_WARNING_ON
public static final String UNCOMMITTED_DATA_WARNING_OFF
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 TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_HEADER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNCOMMITTED_DATA_WARNING_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichRegion(String rendererType)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String[] getPersist()
public final void setPersist(String[] persist)
persist
- the new persist valuepublic final String[] getDontPersist()
public final void setDontPersist(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 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(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 String getContentDelivery()
public final void setContentDelivery(String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final String getText()
public final void setText(String text)
text
- the new text valuepublic final String getShowHeader()
public final void setShowHeader(String showHeader)
showHeader
- the new showHeader valuepublic final String getUncommittedDataWarning()
public final void setUncommittedDataWarning(String uncommittedDataWarning)
uncommittedDataWarning
- the new uncommittedDataWarning valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class PartialUIXRegion
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXRegion