UIComponent class: oracle.adf.view.rich.component.rich.layout.RichPanelHeader
Component type: oracle.adf.RichPanelHeader
The Header Panel control places a label and optional icon at the top of a section.
On mobile devices the panelHeader renders nothing itself, but does renders its children.
The panelHeader can also be used at the top of an application page to give the user important messaging information. The types of messages, set by the
messageType attribute are:
panelHeader does not support setting the CSS style, but does support setting a size. A large header (H1 in HTML) corresponds to 0, medium to 1, and small to 2. Some render kits and skins support sizes up to 5 (equiv. H6 - HTML's maximum header value) but most renderkits and skins will only support up to 2 (in compliance with the BLAF and BLAF+ specs. Setting the header size to something greater then the supported value will style the header the same as the largest supported value (ie. size="6" will be displayed the same as either a size="5" if supported or a size="2").
<af:panelHeader text="This is a panelHeader"> <af:goLink text="Oracle" destination="http://www.oracle.com"/> <af:panelHeader text="This is a Sub-panelHeader" > <af:goLink text="Oracle" destination="http://www.oracle.com"/> </af:panelHeader> </af:panelHeader>
panelHeader displaying message information.
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.|
|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. 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 informtion is displayed end aligned under the header|
|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.|
|menuBar||MenuBar component that is rendered on the header.|
|toolbar||Toolbar component that is rendered on the header.|
|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.RichPanelHeader||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.|
|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.|
|helpTopicId||String||Yes||the id used to look up a topic in a helpProvider.|
|helpType||String||Yes||Valid Values: inline, link
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:
|id||String||No||the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|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.|
|messageType||String||Yes||Valid Values: info, confirmation, warning, none, error
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.|
|rendered||boolean||Yes||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.|
|size||int||Yes||the size of this header. The largest is 0 and corresponds to an H1 header the smallest is 5 and corresponds to an H6 Header. Note that this version of the tag will display all sizes above 2 the same as size 2. Setting the size to a negative number will allow the header to be calculated according to its parent header. The default value for this property is -1.|
|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
how the component will handle geometry management. Options are:
|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||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