Summary

Tag Name:<af:showDetail>
Java Class:oracle.adf.view.rich.component.rich.layout.RichShowDetail
Component Type:oracle.adf.RichShowDetail
The showDetail provides a means of toggling a group of components between being disclosed or undisclosed. A showDetail should be used to:
  • hide/show an entire section or a part of a section of information within the contents of a page such as:
    • show more information / hide more information
    • show details / hide details
    • show "section name" / hide "section name"
    • show graph/hide graph, etc.
  • hide/show functionality such as:
    • simple/advance search
  • hide/show details of a table row

On mobile devices the showDetail renders nothing itself, but does renders its children.

Appearance

The appearance of the showDetail is dependent upon the disclosed, disclosedText, and undisclosedText properties, as well as the presence of a prompt facet.
  • If the "disclosed" property is set to false, the showDetail is considered closed. An open "+" icon will be rendered next to the undisclosedText and the showDetail children will not be shown.
  • If the "disclosed" property is set to true, the showDetail is considered opened. A close "-" icon will be rendered next to the disclosedText and the showDetail children will be shown.
If you do not specify a "disclosedText" property for the component, the text "Hide" will be used instead. If you do not specify an "undisclosedText" property for the component, the text "Show" will be used instead. Alternatively, you can specify your own prompt by using the "prompt" facet.

Events

Clicking on the icon of the showDetail will deliver a DisclosureEvent to the server. If a "prompt" facet is used, changing the value of the disclosed attribute on this component will also deliver the event.

Geometry Management

  • This component cannot be stretched by a parent layout component.
  • This component does not have support for stretching its children.

Screenshot(s)

showDetail screenshot
ShowDetail component.

Code Example(s)

An interactive showDetail

<af:showDetail id="showDetail1">
  <af:panelHeader text="Header" />
</af:showDetail>

Supported Client Events for Client Behaviors

  • blur
  • click
  • contextMenu
  • dblClick
  • disclosure (default)
  • focus
  • keyDown
  • keyPress
  • keyUp
  • mouseDown
  • mouseMove
  • mouseOut
  • mouseOver
  • mouseUp
  • propertyChange

Events

Type Phases Description
org.apache.myfaces.trinidad.event.DisclosureEventApply Request Values,
Invoke Application
The disclosure event is delivered when a node is disclosed.
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke 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.

Supported Facets

Name Description
promptComponent rendered next to the hide or show icon. If this facet is present, this will be used instead of the disclosedText and undisclosedText attributes.

Attributes

Name Type Supports EL? Description
attributeChangeListenerjavax.el.MethodExpressionOnly 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.
bindingoracle.adf.view.rich.component.rich.layout.RichShowDetailOnly 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.
childCreationStringNo 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.
clientComponentbooleanYes 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.
contentDeliveryStringYes Valid Values: immediate, lazy, lazyUncached
Default Value: lazyUncached

Whether the undisclosed content is delivered with the initial page. When contentDelivery is "immediate", the content is inlined into the initial page. If contentDelivery is "lazy", the content will be delivered to the client only after the first request to disclose the component. If contentDelivery is "lazyUncached", the content will be delivered each and every time the component's disclosure changes. By default, contentDelivery is "lazyUncached".
customizationIdStringYes This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
disclosedbooleanYes Default Value: false

whether or not to disclose the children
disclosedTextStringYes the text to display when the children are disclosed. If this attribute is set and the undisclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
disclosureListenerjavax.el.MethodExpressionOnly EL a method reference to a disclosure listener
dontPersistString[]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".
handleDisclosureStringYes Valid Values: client, server
Default Value: server

This attribute is deprecated. The "contentDelivery" attribute should be used instead. The value of "client" would correspond to a content delivery of "lazy" and a "server" would correspond to a value of "lazyUncached".

How the disclosure is handled. If client side, the disclosure state of the client component is not propagated to the server until another event triggers a round trip to the server.

This attribute is deprecated. The contentDelivery attribute should be used instead.


Not supported on the following renderkits: org.apache.myfaces.trinidad.core
idStringNo 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).
immediatebooleanYes 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.
inlineStyleStringYes 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.
partialTriggersString[]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.
persistString[]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.
renderedbooleanYes 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.
shortDescStringYes 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.

styleClassStringYes 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'.
undisclosedTextStringYes the text to display when the children are undisclosed. If this attribute is set and the disclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
unsecurejava.util.SetYes 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.
visiblebooleanYes 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