|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
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.ContextSwitchingComponent
oracle.adf.view.rich.component.fragment.UIXInclude
oracle.adf.view.rich.component.fragment.UIXDynamicDeclarativeComponent
oracle.adf.view.rich.component.rich.fragment.RichDynamicDeclarativeComponent
public class RichDynamicDeclarativeComponent
Defines a dynamic declarative component without a need for a specific tag. Dynamic declarative components allow the UI definition of a component to be defined in terms of a composition of other components and then treated as a single component.
You can pass attributes using JSP tag attributes, or by using <f:attribute>
. Facets can also be set as normal using <f:facet>
tags. The definition can refer to the attributes of the component by using the "var" EL variable and the component itself using the "componentVar" EL variable that are setup on the <af:componentDef>
tag. The definition can reference a facet using the <af:facetRef>
tag. Each facet can only be referenced once.
If you put a component as a child of a declarative component but fail to put it inside of a facet and fail to reference that facet in the component definition file (via facetRef), that component will not be rendered.
Dynamic declarative components support flattened chlidren. This means that children of the declarative component can be seen by the declarative component parent. So for example, input components at the root level of the declarative component will be correctly rendered if the declarative component resides in a panelFormLayout component.
Dynamic declarative components support being a partial trigger as well as a partial target. The component will trigger partial updates when any of its children broadcast an event. So for example, a value change event in an input text component that is a child of the declarative component will trigger components listening on the declarative components. By using #{attrs.partialTriggers} (assuming var is 'attrs'), child components may partially update when an action triggers the declarative component. One difference from other components is that the declarative component itself is not re-rendered. Therefore, to be able to change the viewId of the declarative component during a partial update, the parent of the declarative component must be updated.
Note about stretching layouts and flowing/scrolling layouts:
With today's web browsers, it is not reliable to have vertically-stretched content inside of areas that also have scroll bars. If you want the outer areas of your page structure to stretch, you need to be careful of how you assemble your component tree.
Rules of thumb:
If you believe that you need to break one of these rules, this is an indication that your page structure is not following the page structure guidelines and you will likely have troubles getting your application to render consistently across various web browsers and computing platforms.
Example:
<af:declarativeComponent id="weather" viewid="pagefragments_weatherBox_jsff" zip="94065" description="Redwood Shores, CA"> <f:facet name="forecastSummary"> <af:outputText value="Partly Cloudy"/> </f:facet> <f:facet name="forecastDetail"> <af:panelGroupLayout layout="vertical"> <af:outputText value="72'F"/> <af:outputText value="Partly Cloudy"/> <af:outputText value="Wind: W at 16 mph"/> <af:outputText value="Humidity: 46%"/> </af:panelGroupLayout> </f:facet> </af:declarativeComponent>
And this is the corresponding pagefragments/weatherBox.jsff:
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:f="http://java.sun.com/jsf/core" xmlns:af="http://xmlns.oracle.com/adf/faces/rich" version="2.1"> <af:componentDef var="attrs"> <af:xmlContent> <component xmlns="http://xmlns.oracle.com/adf/faces/rich/component"> <description> This component will show weather forecasts in a box. </description> <facet> <facet-name>forecastSummary</facet-name> <description>This child draws out the summary forecast</description> </facet> <facet> <facet-name>forecastDetail</facet-name> <description>This child draws out the detailed forecast</description> </facet> <attribute> <attribute-name>zip</attribute-name> <description>The Zip code of the area</description> <required>true</required> </attribute> <attribute> <attribute-name>description</attribute-name> <default-value>Unknown</default-value> <description>The city/state of the zip code </description> </attribute> </component> </af:xmlContent> <af:panelHeader text="Weather Forecast for Zip:#{attrs.zip}, #{attrs.description}" partialTriggers="#{attrs.partialTriggers}"> <af:facetRef facetname="forecastSummary"/> <af:showDetail> <af:facetRef facetname="forecastDetail"/> </af:showDetail> </af:panelHeader> </af:componentDef> </jsp:root>
<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter.</html:li> <html:li>You can only safely stretch a declarativeComponent if you can guarantee that inside of it, there is only a single root component and that single component supports being stretched by an ancestor. Otherwise, you may get different results in different web browsers.</html:li> </html:ul> </section>
Type | Phases | Description |
---|---|---|
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. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
Fields inherited from class oracle.adf.view.rich.component.fragment.UIXDynamicDeclarativeComponent |
---|
CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY |
Fields inherited from class oracle.adf.view.rich.component.fragment.UIXInclude |
---|
COMPONENT_VAR_KEY, VAR_KEY, VIEW_ID_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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
RichDynamicDeclarativeComponent() Construct an instance of the RichDynamicDeclarativeComponent. |
protected |
RichDynamicDeclarativeComponent(java.lang.String rendererType) Construct an instance of the RichDynamicDeclarativeComponent. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
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 |
getFamily() |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
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. |
protected void |
setPartialTarget(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.PartialPageContext partialContext) |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
Methods inherited from class oracle.adf.view.rich.component.fragment.UIXDynamicDeclarativeComponent |
---|
getClientAttributes, isClientComponent, setClientAttributes, setClientComponent |
Methods inherited from class oracle.adf.view.rich.component.fragment.UIXInclude |
---|
broadcast, createFacesBean, getAttribute, getComponentVar, getRenderedFacetsAndChildren, getVar, getViewId, invokeOnComponent, queueEvent, resumeContext, setAttribute, setComponentVar, setupChildrenVisitingContext, setVar, suspendChange, suspendContext, tearDownChildrenVisitingContext |
Methods inherited from class oracle.adf.view.rich.component.fragment.ContextSwitchingComponent |
---|
finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
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
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichDynamicDeclarativeComponent()
protected RichDynamicDeclarativeComponent(java.lang.String rendererType)
Method Detail |
---|
protected void setPartialTarget(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.PartialPageContext partialContext)
setPartialTarget
in class org.apache.myfaces.trinidad.component.UIXComponent
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic java.lang.String getFamily()
getFamily
in class UIXDynamicDeclarativeComponent
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXDynamicDeclarativeComponent
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |