|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
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.RichPanelAccordion
public class RichPanelAccordion
The panelAccordion control can be used to display a set of contents belonging to showDetailItem components. Each disclosed showDetailItem is shown as expanded and its contents are displayed; if the showDetailItem is not disclosed, only the title bar is displayed. Typically you would put one or more showDetailItem components inside of the panelAccordion but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelAccordion as long as these wrappers provide showDetailItem components as a result of their execution. <section name="Disabled_showDetailItem_Children"> A disabled showDetailItem child does not display any mechanisms to have its disclosed state changed. However, it can be still be changed programmatically as well as if required to do so when the disclosed state of a sibling showDetailItem changes (depending upon the rules specified in the panelAccordion's discloseMany and discloseNone attributes). </section> <section name="Item_Flexibility"> <html:ul> <html:li>If a showDetailItem has a non-zero flex attribute value assigned to it and if it has only one child, that child will be stretched (regardless of discloseMany setting)</html:li> <html:li>The contents of a showDetailItem in a panelAccordion will not be stretched if the flex attribute for that showDetailItem is set to zero</html:li> <html:li>If every disclosed showDetailItem has a flex attribute value of zero, the last item (the one furthest down) will be stretched as if it had a flex value of 1 (however, if there is more than one child in that showDetailItem, the children will not be stretched)</html:li> </html:ul> </section> <section name="Printable_Pages"> If you use an <af:showPrintablePageBehavior> within one of the panes of the accordion, only that pane will be present for printing when the user activates that behavior. </section> <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 panelAccordion is set to "parent".</html:li> <html:li>This component uses <af:showDetailItem> to organize content into each accordion panel. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelAccordion has dimensionsFrom="parent"</html:li> <html:li>It contains a single child</html:li> <html:li>It has stretchChildren="first" specified</html:li> <html:li>The child has no width, height, margin, border, and padding</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:showDetailItem> 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 panelAccordion to be as tall as the currently-disclosed af:showDetailItem children. When using this "children" setting, the stretchChildren, flex, and inflexibleHeight attributes on af:showDetailItem and any height assignment (e.g. inlineStyle or styleClass) on the panelAccordion 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 panelAccordion 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 (stretchChildren, flex, inflexibleHeight on af:showDetailItem will be honored).</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelAccordion 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 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 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 |
DISCLOSE_MANY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISCLOSE_NONE_KEY |
static java.lang.String |
DISCLOSURE_EVENT_BROADCAST When a disclosure event is queued in an accordion, the accordion will track to see if that event has been broadcast. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static java.lang.String |
REORDER_DISABLE |
static java.lang.String |
REORDER_ENABLE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
REORDER_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.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 |
---|
bindings |
Constructor Summary | |
---|---|
|
RichPanelAccordion() Construct an instance of the RichPanelAccordion. |
protected |
RichPanelAccordion(java.lang.String rendererType) Construct an instance of the RichPanelAccordion. |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event) |
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 |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String |
getDimensionsFrom() Gets |
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 |
getReorder() Gets Sets if reordering of the panel accordion's items should be allowed. |
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.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 |
isDiscloseMany() Gets whether more than one detail item may be disclosed at a time. |
boolean |
isDiscloseNone() Gets whether a minimum of one detail item must be disclosed at a time. |
boolean |
isVisible() Gets the visibility of the component. |
java.lang.Object |
processSaveState(javax.faces.context.FacesContext context) |
void |
queueEvent(javax.faces.event.FacesEvent event) |
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 |
setDiscloseMany(boolean discloseMany) Sets whether more than one detail item may be disclosed at a time. |
void |
setDiscloseNone(boolean discloseNone) Sets whether a minimum of one detail item must be disclosed at a time. |
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 |
setReorder(java.lang.String reorder) Sets Sets if reordering of the panel accordion's items should be allowed. |
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 |
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, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, 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 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 REORDER_ENABLE
public static final java.lang.String REORDER_DISABLE
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 DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSE_NONE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSE_MANY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey REORDER_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String DISCLOSURE_EVENT_BROADCAST
Constructor Detail |
---|
public RichPanelAccordion()
protected RichPanelAccordion(java.lang.String rendererType)
Method Detail |
---|
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.Object processSaveState(javax.faces.context.FacesContext context)
processSaveState
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public 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 getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the panelAccordion come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelAccordion is inside; if the panelAccordion is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelAccordion will get its dimensions from the currently disclosed showDetailItem children. As a result, the stretchChildren, flex, and inflexibleHeight attributes on each af:showDetailItem and any height assignment (e.g. inlineStyle, styleClass, or manual pane resizing) on the panelAccordion 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 panelAccordion 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 (stretchChildren, flex, and inflexibleHeight on af:showDetailItem will be honored)</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 panelAccordion come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelAccordion is inside; if the panelAccordion is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelAccordion will get its dimensions from the currently disclosed showDetailItem children. As a result, the stretchChildren, flex, and inflexibleHeight attributes on each af:showDetailItem and any height assignment (e.g. inlineStyle, styleClass, or manual pane resizing) on the panelAccordion 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 panelAccordion 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 (stretchChildren, flex, and inflexibleHeight on af:showDetailItem will be honored)</html:li> </html:ul>dimensionsFrom
- the new dimensionsFrom valuepublic final boolean isDiscloseNone()
public final void setDiscloseNone(boolean discloseNone)
discloseNone
- the new discloseNone valuepublic final boolean isDiscloseMany()
public final void setDiscloseMany(boolean discloseMany)
discloseMany
- the new discloseMany valuepublic final java.lang.String getReorder()
After a reorder, an event is sent to the server. If all the children components of the panel accordion are <c>RichShowDetailItem</c> components, the display indexes will be updated to reflect the new order. The accordion will update as many items as needed to ensure they appear in the proper order. This means that if there are five items all with the default index of -1, and the first is moved to position 3, the items now first, second and third (where the third is the old first) will have their display indexes updated to 0, 1 and 2 respectively.
The updating of display indexes in flattened components is not supported at this time.
public final void setReorder(java.lang.String reorder)
After a reorder, an event is sent to the server. If all the children components of the panel accordion are <c>RichShowDetailItem</c> components, the display indexes will be updated to reflect the new order. The accordion will update as many items as needed to ensure they appear in the proper order. This means that if there are five items all with the default index of -1, and the first is moved to position 3, the items now first, second and third (where the third is the old first) will have their display indexes updated to 0, 1 and 2 respectively.
The updating of display indexes in flattened components is not supported at this time.
reorder
- the new reorder valuepublic 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 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |