<html:p> 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 <html:strong>text</html:strong> 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. </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component should never have any width or height specified in its inlineStyle because it will always gets its dimensions from its ancestor component.</html:li> <html:li>This component cannot be used by itself, refer to the <af:panelAccordion> and <af:panelTabbed> tag documentation for more details about geometry management.</html:li> </html:ul> </section> <section name="Disclosure_Events"> <html:p> 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. </html:p> <html:p> If you have an af:panelTabbed or an af:panelAccordion (with discloseMany="false" and discloseNone="false"): </html:p> <html:ul> <html:li>On client: <html:ul> <html:li>showDetailItem 1 is showing but not showDetailItem 2</html:li> <html:li>user clicks to disclose item 2</html:li> <html:li>a client-only disclosure event gets kicked off to set disclosed to false for item 1</html:li> <html:li>if this first event is not canceled, another client disclosure event gets kicked off to set disclosed to true for item 2</html:li> <html:li>if this second event is not canceled, it gets sent to the server</html:li> <html:li>otherwise, no more disclosure changes</html:li> </html:ul></html:li> <html:li>On server: <html:ul> <html:li>the server disclosure event is kicked off to set disclosed to true on item 2</html:li> <html:li>if this first server event is not canceled, another server disclosure event gets kicked off to set disclosed to false for item 1</html:li> <html:li>if neither server event is canceled, the new states get rendered and the user will see the newly disclosed states on the client</html:li> <html:li>otherwise, the client looks the same as it was before</html:li> </html:ul></html:li> </html:ul> <html:p> 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. </html:p> <html:p> 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. </html:p> </section>

Events:

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 event might include the width of a column that supported client-side resizing.

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

setDisabled(boolean disabled)
Sets a boolean which if the value is "true", the component becomes non-interactive.

void

setDisplayIndex(int displayIndex)
Sets When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in.

void

setDontPersist(java.lang.String[] dontPersist)
Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.

getToolbar

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. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)

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. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

getInlineStyle

public final java.lang.String getInlineStyle()

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

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

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

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets 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'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets 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'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

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

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

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

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final 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. 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.

Returns:

the new unsecure value

setUnsecure

public final 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. 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.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

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

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

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

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated.This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final 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.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

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

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

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

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

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

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

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

setClientListeners

getPersist

public final java.lang.String[] getPersist()

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

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

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

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets 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".

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets 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".

Parameters:

dontPersist - the new dontPersist value

isDisabled

public final boolean isDisabled()

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

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

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

Parameters:

disabled - the new disabled value

getIcon

public final java.lang.String getIcon()

Gets the URI of an image to be displayed with the showDetailItem. This attribute supports these various types of URIs:

absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"

relative - a path located relatively to the source page, like "bullet.jpg"

context relative - a path relatively based on the web application's context root, like "/images/error.png"

server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Returns:

the new icon value

setIcon

public final void setIcon(java.lang.String icon)

Sets the URI of an image to be displayed with the showDetailItem. This attribute supports these various types of URIs:

absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"

relative - a path located relatively to the source page, like "bullet.jpg"

context relative - a path relatively based on the web application's context root, like "/images/error.png"

server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Parameters:

icon - the new icon value

getText

public final java.lang.String getText()

Gets the textual label of the showDetailItem.

Returns:

the new text value

setText

public final void setText(java.lang.String text)

Sets the textual label of the showDetailItem.

Parameters:

text - the new text value

getAccessKey

public final char getAccessKey()

Gets a character used to gain quick access to this showDetailItem.

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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Returns:

the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)

Sets a character used to gain quick access to this showDetailItem.

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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Parameters:

accessKey - the new accessKey value

getFlex

public final int getFlex()

Gets

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.

Returns:

the new flex value

setFlex

public final void setFlex(int flex)

Sets

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.

Parameters:

flex - the new flex value

getInflexibleHeight

public final int getInflexibleHeight()

Gets

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.

Returns:

the new inflexibleHeight value

setInflexibleHeight

public final void setInflexibleHeight(int inflexibleHeight)

Sets

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.

Parameters:

inflexibleHeight - the new inflexibleHeight value

getStretchChildren

public final java.lang.String getStretchChildren()

Gets The stretching behavior for children. Acceptable values include:

"none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)

"first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Returns:

the new stretchChildren value

setStretchChildren

public final void setStretchChildren(java.lang.String stretchChildren)

Sets The stretching behavior for children. Acceptable values include:

"none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)

"first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Parameters:

stretchChildren - the new stretchChildren value

getItemListener

public final javax.el.MethodExpression getItemListener()

Gets a method reference to an item listener

Returns:

the new itemListener value

setItemListener

public final void setItemListener(javax.el.MethodExpression itemListener)

Sets a method reference to an item listener

Parameters:

itemListener - the new itemListener value

getDisplayIndex

public final int getDisplayIndex()

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

Returns:

the new displayIndex value

setDisplayIndex

public final void setDisplayIndex(int displayIndex)

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

Parameters:

displayIndex - the new displayIndex value

getRemove

public final java.lang.String getRemove()

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

Returns:

the new remove value

setRemove

public final void setRemove(java.lang.String remove)

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