Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 11g Release 1 (11.1.1.5.0) E12419-07 |
UIComponent class: oracle.adf.view.rich.component.rich.layout.RichShowDetailItem
Component type: oracle.adf.RichShowDetailItem
The showDetailItem component is used inside of a panelAccordion or panelTabbed component to contain a group of children. It is identified visually by the the text attribute value and lays out its children. Note the difference between "disclosed" and "rendered": if "rendered" is false, it means that this the accordion header bar or tab link and its corresponding contents are not available at all to the user, whereas if "disclosed" is false, it means that the contents of the item are not currently visible, but may be made visible by the user since the accordion header bar or tab link are still visible.
The lifecycle (including validation) is not run for any components in a showDetailItem which is not disclosed. The lifecycle is only run on the showDetailItem(s) which is disclosed.
The af:showDetailItem component inside of af:panelAccordion and af:panelTabbed supports queuing of disclosure events so that validation can properly be handled--both on the server and on the client.
If you have an af:panelTabbed or an af:panelAccordion (with discloseMany="false" and discloseNone="false"):
For af:panelAccordion with discloseMany="false" and discloseNone="true", the process is the same as above only when the disclosure change forces a paired change (when 2 disclosed states are involved). If only one disclosure change is involved, there will just be 1 client and 1 server disclosure event.
For af:panelAccordion with discloseMany="true" (and any discloseNone setting), only one disclosure change is involved; there will just be 1 client and 1 server disclosure event.
The disclosedTransient
attribute is not supported by the rich client renderers and may only be used with the Apache MyFaces Trinidad RenderKit. If this attribute is set to true in an ADF page, the component will not function correctly. This attribute appears in ADF due to it being inherited from UIXShowDetail
. The value must either not be set, or must be set to false, a value of true will cause problems.
Two showDetailItems, the first of which is "disclosed":
<af:panelTabbed id="pt1"> <af:showDetailItem text="First" disclosed="true" id="sdi1"/> <af:showDetailItem text="Second" id="sdi2"/> </af:panelTabbed>
Type | Phases | Description |
---|---|---|
oracle.adf.view.rich.event.ItemEvent | Invoke Application, Apply Request Values |
The itemEvent is triggered when a containing object has an event on one of its child items. For example, a panelTabbed will launch an itemEvent of type 'remove' for one of its child tabs. |
org.apache.myfaces.trinidad.event.DisclosureEvent | Apply Request Values, Invoke Application |
The disclosure event is delivered when a node is disclosed. |
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. |
Name | Description |
---|---|
toolbar |
The content for the toolbar region of the accordion header bar. It will be displayed when the disclosed="true". This facet is only applicable when used with the panelAccordion. |
Name | Type | Supports EL? | Description |
---|---|---|---|
accessKey | char | Yes | a character used to gain quick access to this showDetailItem. For accessibility reasons, this functionality is not supported in screen reader mode.
If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. This attribute is sometimes referred to as the "mnemonic". Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey. |
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.RichShowDetailItem | 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. |
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. |
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. |
disabled | boolean | Yes | Default Value: false a boolean which if the value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior. |
disclosed | boolean | Yes | Default Value: false whether or not to disclose the children |
disclosedTransient | boolean | Yes | Default Value: false stops the local value of disclosed from being set by renderers. This allows the value to always be taken from the value of the disclosed value expression. Disclosed values must be updated in other ways (i.e. from a disclosure listener) |
disclosureListener | javax.el.MethodExpression | Only EL | a method reference to a disclosure listener |
displayIndex | int | Yes | Default Value: -1 When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in. It will be updated when the component is reordered in the parent. A display index of -1 (default) means that items will appear at the end, in the order they appear in the component tree. All values at 0 or above appear before the -1 values in ascending order. |
dontPersist | String[] | Yes | a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist". |
flex | int | Yes | Default Value: 0 a non-negative integer that indicates the flexibility of this component in its container. If the container supports it, flex is used to determine how space is distributed among its children. Components with larger flex values will be made larger than components with lower flex values. This is done so at the ratio determined by the flex of each of the two components. The actual value is only relevant if there are other flexible components (components with flex values larger than zero) within the same container. This attribute is only applicable when used with the panelAccordion. |
icon | String | Yes | the URI of an image to be displayed with the showDetailItem. This attribute supports these various types of URIs:
|
id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
immediate | boolean | Yes | Default Value: false whether data validation - client-side or server-side - should be skipped when events are generated by this component. When immediate is false (the default), the disclosure event will be delivered during the Invoke Application phase, which will trigger validation. When set to true, the disclosure event will be executed during the Apply Request Values phase. |
inflexibleHeight | int | Yes | Default Value: 100 the number of pixels that the item will use when in a container that allocates size among multiple sibling items. If this item has flex="0", this is the size that will be used and the remaining space will be dispersed among the non-zero flex items. If this item cannot fit within its container using this number of pixels, other nearby items may be pushed out into overflow menus. This attribute is only applicable when used with the panelAccordion. |
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. 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. |
itemListener | javax.el.MethodExpression | Only EL | a method reference to an item listener |
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. |
persist | String[] | Yes | a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included. |
remove | String | Yes | Valid Values: inherit, no, disabled Default Value: inherit sets the remove ability of the showDetailItem. The default value of "inherit" means that the item inherits its remove ability from its parent container. A value of "no" means that when in a container that supports item removal, this item is not allowed to be removed. A value of "disabled" means that when in a container that supports item removal, this item is not allowed to be removed and it should have a disabled remove indicator. Currently, only panelTabbed supports item removal of child showDetailItems. |
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. |
shortDesc | String | Yes | the short description of the component. This text is commonly used by user agents to display tooltip help text, in which 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 it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant. |
stretchChildren | String | Yes | Valid Values: none, first Default Value: none The stretching behavior for children. Acceptable values include:
|
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'. |
text | String | Yes | the textual label of the showDetailItem. |
textAndAccessKey | String | Yes | an attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.
For example, setting this attribute to "T&ext" will set the text to "Text" and the access key to 'e'. |
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. |
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 |