Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81455-03

# <af:panelAccordion>

af:panelAccordion panelAccordion panel accordion

UIComponent class: oracle.adf.view.rich.component.rich.layout.RichPanelAccordion
Component type: oracle.adf.RichPanelAccordion

Unsupported agents: pda

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.

## 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).

## Item Flexibility

- 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)
- The contents of a showDetailItem in a panelAccordion will not be stretched if the flex attribute for that showDetailItem is set to zero
- 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)

## 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.

## Geometry Management

- 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".
- This component uses <af:showDetailItem> to organize content into each accordion panel. The <af:showDetailItem> will allow stretching if:
  - The panelAccordion has dimensionsFrom="parent"
  - It contains a single child
  - It has stretchChildren="first" specified
  - The child has no width, height, margin, border, and padding
  - The child must be capable of being stretched
  Examples of components that can be stretched inside of a <af:showDetailItem> include:
  - <af:decorativeBox>
  - <af:panelAccordion>
  - <af:panelBox>
  - <af:panelCollection>
  - <af:panelGroupLayout layout="scroll">
  - <af:panelGroupLayout layout="vertical">
  - <af:panelHeader>
  - <af:panelSplitter>
  - <af:panelStretchLayout>
  - <af:panelTabbed>
  - <af:region>
  - <af:table>
  - <af:tree>
  - <af:treeTable>
  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:
  - <af:panelBorderLayout>
  - <af:panelFormLayout>
  - <af:panelGroupLayout layout="default">
  - <af:panelGroupLayout layout="horizontal">
  - <af:panelLabelAndMessage>
  - <af:panelList>
  - <trh:tableLayout>

There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor:

- 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.
- 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).
- Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelAccordion is being stretched by its parent.

## Screen Shot(s)

A panelAccordion component with 4 showDetailItem children.

## Code Example(s)

The following is an example of panelAccordion.

    <af:panelAccordion id="pa1">
      <af:showDetailItem text="ADF Faces Components" id="sdi1">
        <af:panelHeader text="ADF Faces Components First Child" id="ph1"/>
        <af:panelHeader text="ADF Faces Components Second Child" id="ph2"/>
      </af:showDetailItem>
      <af:showDetailItem text="Architecture" disabled="true" id="sdi2">
        <af:panelHeader text="Architecture First Child" id="ph3"/>
        <af:panelHeader text="Architecture Second Child" id="ph4"/>
      </af:showDetailItem>
      <af:showDetailItem text="Release" id="sdi3">
        <af:panelHeader text="Release First Child" id="ph5"/>
        <af:panelHeader text="Release Second Child" id="ph6"/>
      </af:showDetailItem>
    </af:panelAccordion>

## Events

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.

## Attributes

Name | Type | Supports EL? | Description
attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. 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.
binding | oracle.adf.view.rich.component.rich.layout.RichPanelAccordion | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
childCreation | String | No | Valid Values: immediate, lazy, lazyUncached Default Value: immediate Controls when the children components are created. Introduces a server-side performance enhancement by postponing construction of the components under the undisclosed disclosure components. The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator). Legal values are: "immediate": Children components will be created immediately "lazy": Children will be populated when the disclore component is disclosed and will be kept in memory thereafter. "lazyUncached": Children will be populated when the disclore component is disclosed and may be removed when undisclosed.
clientComponent | boolean | Yes | Default Value: false whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
contentDelivery | String | Yes | Valid Values: immediate, lazyUncached Default Value: lazyUncached This property is not currently supported for general use, and is intended to remain in its default lazyUncached state. It is currently only used when the page is rendered in attachment mode, and the contentDelivery is forced to an immediate setting. Determines whether content is delivered with the initial page. When contentDelivery is "immediate", the accordion item content is inlined into the initial page. By default, contentDelivery is lazyUncached.
customizationId | String | Yes | This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dimensionsFrom | String | Yes | Valid Values: auto, children, parent Default Value: parent determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from: 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 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. parent - 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 If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".
discloseMany | boolean | Yes | Default Value: false whether more than one detail item may be disclosed at a time. Use "false" (the default) to keep a maximum of one detail item disclosed at all times. Use "true" to make it possible for multiple detail items to be disclosed.
discloseNone | boolean | Yes | Default Value: false whether a minimum of one detail item must be disclosed at a time. Use "false" (the default) to keep a minimum of one detail item disclosed at all times. Use "true" to make it possible for zero detail items to be disclosed.
id | String | No | the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle | String | Yes | the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rendered | boolean | Yes | Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
reorder | String | Yes | Valid Values: enable, disable Default Value: disable Sets if reordering of the panel accordion's items should be allowed. After a reorder, an event is sent to the server. If all the children components of the panel accordion are `RichShowDetailItem` 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.
shortDesc | String | Yes | the short description of the component. The shortDesc text may be used in two different ways, depending on the component. 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.
styleClass | String | Yes | a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
toolbarVisibility | String | Yes | Valid Values: auto, always, disclosed Default Value: auto Whether to show toolbar only in disclosed state or always in panelAccordion. Use "auto" (the default) will choose either "always" or "disclosed" depending on internal implementation of panelAccordion. Use "always" to show toolbar on all detail items irrespective of its disclosed state. Use "disclosed" to show toolbar only if detail item is in desclosed state.
unsecure | java.util.Set | Yes | A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
visible | boolean | Yes | Default Value: true the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core