|
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
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichDecorativeBox
public class RichDecorativeBox
The decorativeBox component can be used to apply a bordered look to its children (i.e. rounded corners). It also supports changing of the rendered theme of its children, so can act as a look and feel transition between areas on a page. For example, a page that has a dark background for its template can use the decorative box to transition to a white background for its main area. This component stretches the child component in the center facet to fill all of available space. It is bordered by eight styled areas that are controlled using skinning keys. The areas listed below are documented in the skinning documentation: <html:ul> <html:li>top-start</html:li> <html:li>top</html:li> <html:li>top-end</html:li> <html:li>start</html:li> <html:li>end</html:li> <html:li>bottom-start</html:li> <html:li>bottom</html:li> <html:li>bottom-end</html:li> </html:ul> The height of the top area of the component depends on whether or not a component has been put into the top facet. When the facet is set, the topHeight attribute is used to specify the size the content should occupy. Without a component in the top facet, the -tr-height skin property will be used to determine the height. See the skinning keys documentation for more information on the available skinning keys and properties for the decorative box component. <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 if the dimensionsFrom attribute of this decorativeBox is set to "parent".</html:li> <html:li>This component uses <f:facet name="top"> and <f:facet name="center"> to organize content into each box. Examples of child components that can be stretched inside of these facets include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></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></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 you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <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 do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></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:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="children" for the decorativeBox to be as tall as the children. When using this "children" setting, the topHeight attribute will still be honored (unless percent units are specified) but any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the decorativeBox get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin.</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the decorativeBox is being stretched by its parent.</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 |
CENTER_FACET |
static java.lang.String |
CENTER_LANDMARK_BANNER |
static java.lang.String |
CENTER_LANDMARK_COMPLEMENTARY |
static java.lang.String |
CENTER_LANDMARK_CONTENTINFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CENTER_LANDMARK_KEY |
static java.lang.String |
CENTER_LANDMARK_MAIN |
static java.lang.String |
CENTER_LANDMARK_NAVIGATION |
static java.lang.String |
CENTER_LANDMARK_NONE |
static java.lang.String |
CENTER_LANDMARK_SEARCH |
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 org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static java.lang.String |
DIMENSIONS_FROM_AUTO |
static java.lang.String |
DIMENSIONS_FROM_CHILDREN |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static java.lang.String |
DIMENSIONS_FROM_PARENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
THEME_KEY |
static java.lang.String |
TOP_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TOP_HEIGHT_KEY |
static java.lang.String |
TOP_LANDMARK_BANNER |
static java.lang.String |
TOP_LANDMARK_COMPLEMENTARY |
static java.lang.String |
TOP_LANDMARK_CONTENTINFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TOP_LANDMARK_KEY |
static java.lang.String |
TOP_LANDMARK_MAIN |
static java.lang.String |
TOP_LANDMARK_NAVIGATION |
static java.lang.String |
TOP_LANDMARK_NONE |
static java.lang.String |
TOP_LANDMARK_SEARCH |
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 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 |
Constructor Summary | |
---|---|
|
RichDecorativeBox() Construct an instance of the RichDecorativeBox. |
protected |
RichDecorativeBox(java.lang.String rendererType) Construct an instance of the RichDecorativeBox. |
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
javax.faces.component.UIComponent |
getCenter() Content to be stretched in the center of the layout. |
java.lang.String |
getCenterLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the center facet. |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
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 |
getDefaultEventName() |
java.lang.String |
getDimensionsFrom() Gets |
java.util.Collection<java.lang.String> |
getEventNames() |
java.lang.String |
getFamily() |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getTheme() Gets The component style theme to apply to this component. |
javax.faces.component.UIComponent |
getTop() Content to be rendered above the center facet. |
java.lang.String |
getTopHeight() Gets the height of the top facet specified as a CSS length. |
java.lang.String |
getTopLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the top facet. |
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 |
isVisible() Gets the visibility of the component. |
void |
setCenter(javax.faces.component.UIComponent centerFacet) Content to be stretched in the center of the layout. |
void |
setCenterLandmark(java.lang.String centerLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the center facet. |
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 |
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 |
setDimensionsFrom(java.lang.String dimensionsFrom) Sets |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setTheme(java.lang.String theme) Sets The component style theme to apply to this component. |
void |
setTop(javax.faces.component.UIComponent topFacet) Content to be rendered above the center facet. |
void |
setTopHeight(java.lang.String topHeight) Sets the height of the top facet specified as a CSS length. |
void |
setTopLandmark(java.lang.String topLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the top facet. |
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, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, 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 java.lang.String DIMENSIONS_FROM_AUTO
public static final java.lang.String DIMENSIONS_FROM_CHILDREN
public static final java.lang.String DIMENSIONS_FROM_PARENT
public static final java.lang.String TOP_LANDMARK_NONE
public static final java.lang.String TOP_LANDMARK_BANNER
public static final java.lang.String TOP_LANDMARK_COMPLEMENTARY
public static final java.lang.String TOP_LANDMARK_CONTENTINFO
public static final java.lang.String TOP_LANDMARK_MAIN
public static final java.lang.String TOP_LANDMARK_NAVIGATION
public static final java.lang.String TOP_LANDMARK_SEARCH
public static final java.lang.String CENTER_LANDMARK_NONE
public static final java.lang.String CENTER_LANDMARK_BANNER
public static final java.lang.String CENTER_LANDMARK_COMPLEMENTARY
public static final java.lang.String CENTER_LANDMARK_CONTENTINFO
public static final java.lang.String CENTER_LANDMARK_MAIN
public static final java.lang.String CENTER_LANDMARK_NAVIGATION
public static final java.lang.String CENTER_LANDMARK_SEARCH
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOP_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOP_LANDMARK_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CENTER_LANDMARK_KEY
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 THEME_KEY
public static final java.lang.String CENTER_FACET
public static final java.lang.String TOP_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichDecorativeBox()
protected RichDecorativeBox(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getCenter()
public final void setCenter(javax.faces.component.UIComponent centerFacet)
public final javax.faces.component.UIComponent getTop()
public final void setTop(javax.faces.component.UIComponent topFacet)
public final java.lang.String getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>public final void setDimensionsFrom(java.lang.String dimensionsFrom)
determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>dimensionsFrom
- the new dimensionsFrom valuepublic final java.lang.String getTopHeight()
public final void setTopHeight(java.lang.String topHeight)
topHeight
- the new topHeight valuepublic final java.lang.String getTopLandmark()
public final void setTopLandmark(java.lang.String topLandmark)
topLandmark
- the new topLandmark valuepublic final java.lang.String getCenterLandmark()
public final void setCenterLandmark(java.lang.String centerLandmark)
centerLandmark
- the new centerLandmark valuepublic 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 getTheme()
public final void setTheme(java.lang.String theme)
theme
- the new theme valuepublic java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public java.util.Map<java.lang.String,java.util.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(java.lang.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 java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel
|
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 |