public abstract class PartialRichDynamicDeclarativeComponent extends UIXDynamicDeclarativeComponent implements javax.faces.component.NamingContainer
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.
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>
| 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. |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static 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 |
CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEYVIEW_ID_KEYCOMPONENT_VAR_KEY, VAR_KEYBINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY| Modifier | Constructor and Description |
|---|---|
protected |
PartialRichDynamicDeclarativeComponent(String rendererType)
Construct an instance of the PartialRichDynamicDeclarativeComponent
with the specified renderer type.
|
| Modifier and Type | Method and Description |
|---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getFamily() |
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
getClientAttributes, isClientComponent, setClientAttributes, setClientComponentbroadcast, createFacesBean, getAttribute, getRenderedFacetsAndChildren, getViewId, invokeOnComponent, queueEvent, resumeContext, setAttribute, setupChildrenVisitingContext, suspendChange, suspendContext, tearDownChildrenVisitingContextgetComponentVar, getVar, setComponentVar, setVarfinishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext, setupVisitingContext, tearDownVisitingContextadaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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, updateChildrenImpl, validateChildren, validateChildrenImpladdPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTreeencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewpublic 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 String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichDynamicDeclarativeComponent(String rendererType)
rendererType - the renderer type
Construct an instance of the PartialRichDynamicDeclarativeComponent.@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId - the new customizationId valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers - the new partialTriggers valuepublic String getFamily()
getFamily in class UIXDynamicDeclarativeComponentprotected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType in class UIXDynamicDeclarativeComponent