Parent Project
Project Documentation


Tag Name: <tr:panelHeader>
Java Class: org.apache.myfaces.trinidad.component.core.layout.CorePanelHeader
Component Type: org.apache.myfaces.trinidad.CorePanelHeader

The panelHeader control places a label and optional icon at the top of a section.

panelHeader and Messaging Information

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:

  • error
  • information
  • warning
  • confirmation

Header Size

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

Code Example(s)

panelHeader displaying message information.

<tr:panelHeader messageType="error"/>

Supported Client Events for Client Behaviors

  • click (default)
  • dblclick
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup


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


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 org.apache.myfaces.trinidad.component.core.layout.CorePanelHeader 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.
icon String Yes the URI for the icon of the header.
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).
inlineStyle String Yes the CSS styles to use for this component.
messageType String Yes Valid Values: info, confirmation, warning, none, error
Default Value: none

Set if an error, info, confirmation, or warning header is needed.
onclick String Yes an onclick Javascript handler.
ondblclick String Yes an ondblclick Javascript handler.
onkeydown String Yes an onkeydown Javascript handler.
onkeypress String Yes an onkeypress Javascript handler.
onkeyup String Yes an onkeyup Javascript handler.
onmousedown String Yes an onmousedown Javascript handler.
onmousemove String Yes an onmousemove Javascript handler.
onmouseout String Yes an onmouseout Javascript handler.
onmouseover String Yes an onmouseover Javascript handler.
onmouseup String Yes an onmouseup Javascript handler.
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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

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.
size int Yes Default Value: -1

Size of this panelHeader. 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.
text String Yes the label of the header.