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

# <af:showDetailHeader>

af:showDetailHeader showDetailHeader show detail header

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

The showDetailHeader provides a means of toggling the contents under a header between being disclosed(shown) or undisclosed(hidden).

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

## Appearance

If the "disclosed" property on the showDetailHeader is set to false, the icon arrow will point sideways, and the children of the showDetailHeader will not be rendered. If the "disclosed" property of the showDetailHeader is set to true, the icon arrow will point down and the children of the showDetailHeader will be rendered.

## Events

Clicking on the icon of the showDetailHeader will deliver a `DisclosureEvent` to the server.

Note: The lifecycle (including validation) is not run for any components in a showDetailHeader which is not disclosed. The lifecycle is only run on the children of a showDetailHeader which is disclosed.

## Geometry Management

- This component will be stretched if:
  - type="default" and its parent layout component is stretching the showDetailHeader (e.g. panelDashboard)
  - type="stretch"
- This component will not be stretched if:
  - type="default" and its parent layout component is not stretching the showDetailHeader (e.g. panelGroupLayout)
  - type="flow"
- The showDetailHeader component will only stretch its children if it is being stretched by its parent (or if type="stretch"). If the children are being stretched but you don't want them to be stretched, simply wrap the children in a panelGroupLayout layout="scroll".

## Screen Shot(s)

ShowDetailHeader component.

## Code Example(s)

    <af:showDetailHeader text="ShowDetail Header" id="showDetail1" >
      <af:panelHeader text="Header" id="ph1"/>
    </af:showDetailHeader>

## Events

Type | Phases | Description
--- | --- | ---
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.

## Supported Facets

Name | Description
--- | ---
context | A Facet that can be used to display contextual information on the header. The contextual information is displayed next to the header text
help | This facet is deprecated, helpTopicId should be used for providing help. Both help facet when rendered inline and helpTopicId with instructions text are rendered in the same spot, so if helpTopicId is specified and it has instructions text, the help facet will not be rendered if specified inline. This facet will not be rendered if the header is being stretched since there would be no space allocated for it. Help content that is displayed to the user. The content of the help is displayed inline inside the header content or as a popup through a link. The attribute helpType controls whether the help is displayed inline or in a popup.
info | A facet that displays addition information inside the header content. This information is displayed end aligned under the header. This facet will not be rendered if the header is being stretched since there would be no space allocated for it.
legend | A Facet that can be used to display legend information on the header. If the help facet has a child and it is visible, the contents of the legend facet will be rendered beneath the task stamps. If the legend facet is not visible or no children exist, then it gets rendered below the title. This facet will not be rendered if the header is being stretched since there would be no space allocated for it.
menuBar | MenuBar component that is rendered on the header.
toolbar | Toolbar component that is rendered on the header.

## 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.RichShowDetailHeader | 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, 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".
contentStyle | String | Yes | the inline style of the content region.
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.
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) Not supported on the following renderkits: oracle.adf.rich
disclosureListener | javax.el.MethodExpression | Only EL | a method reference to a disclosure listener
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".
handleDisclosure | String | Yes | Valid Values: client, server Default Value: server 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
headerLevel | int | Yes | Valid Values: -1, 1, 2, 3, 4, 5, 6 Default Value: -1 allows the default HTML header level assignment (H1 through H6) of the header to be overridden. Header components are assigned HTML header level assignments of H1 through H6. (Similar to size) the header level assigned is determined based on containment within other header components. For example, a header that is not contained by another header component will automatically render as an H1 header level. A child header contained inside this header would automatically render as an H2 header level. While the display of header components is determined by the size skinning selector assigned, HTML header level is important for correct page structure, especially when used with screen reader applications. The headerLevel attribute by default is -1, where the HTML header level is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned header levels. Alternately, setting the headerLevel attribute to values 1 through 6 will force the corresponding HTML header level to render as part of the header component, regardless of its containment with other header components on the page. Plesae be careful if overriding the header level! The HTML header level assignments (H1 through H6) controlled by this attribute are relied upon by screen reader applications to appropriately identify the underlying structure of the page. Make sure your use of header components and assignment of header levels make sense for your page. When using an override value, consider the effects of having headers inside disclosable sections of the page.
helpTopicId | String | Yes | the id used to look up a topic in a helpProvider.
helpType | String | Yes | Valid Values: inline, link Default Value: inline Along with the help facet this is deprecated, helpTopicId should be used for providing help. Controls if the help is displayed inline or as a link to a popup.
icon | String | Yes | the URI of an image to be displayed in the header. 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"
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).
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.
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.
maximizeListener | javax.el.MethodExpression | Only EL | a method reference to a maximize listener
maximized | boolean | Yes | Default Value: false whether the children are currently maximized
messageType | String | Yes | Valid Values: info, confirmation, warning, none, error Default Value: none whether an error, info, confirmation, or warning header is needed.
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.
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. 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.
showMaximize | String | Yes | Valid Values: never, auto, always Default Value: auto Whether to display the maximize control to allow this component to be maximized. The default value, `auto`, allows the framework to determine whether the maximize control should be displayed beased on a number of factors, including the platform that the component is being displayed on.
size | int | Yes | Valid Values: -1, 0, 1, 2, 3, 4, 5 Default Value: -1 allows the default skinning size of the header to be overridden. Sizes for skinning start at size 0 (the largest) and progress to size 5 (the smallest). The size is determined based on containment within other header components, and is accomplished via the assignment of skinning keys. For example, a header that is not contained by another header component will automatically be displayed as size 0. A child header contained inside this header would automatically be displayed as size 1. The size attribute by default is -1, where the size is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned sizes. Alternately, setting the size attribute to values 0 through 5 will force that size skinning value assignment on the header component, regardless of its containment with other header components on the page. Please note that while header components support a total of six levels of skinning differentiation, less than this may be defined in your skin. Also, setting the header size to something greater then the supported value will style the header the same as the largest supported value. Please see the Skinning Selectors documentation for the assigned skinning keys used by the component.
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 label of the header.
type | String | Yes | Valid Values: default, flow, stretch Default Value: default how the component will handle geometry management. Options are: default - either flow or stretch, depending on the component's parent container component flow - does not support being stretched and will not attempt to stretch the children; the height of the component will be determined by the browser based on the children stretch - supports being stretched and will attempt to stretch the sole child or will wrap the children without stretching them; the height of this component is in no way determined by the children. If helpTopicId is also specified, no instruction text will be displayed when stretched because there would be no space allocated for it. Similarly, the "help", "info", and "legend" facets will not be displayed.
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