Project Documentation

Summary

Tag name: <t:collapsiblePanel>
UIComponent class: org.apache.myfaces.custom.collapsiblepanel.HtmlCollapsiblePanel
Tag class: org.apache.myfaces.custom.collapsiblepanel.HtmlCollapsiblePanelTag
Component type: org.apache.myfaces.HtmlCollapsiblePanel
Component family: javax.faces.Panel
Renderer type: org.apache.myfaces.CollapsiblePanel
Renderer class: org.apache.myfaces.custom.collapsiblepanel.HtmlCollapsiblePanelRenderer

A component which just renders as a single icon (with optional label) when "collapsed", hiding all child components. When open, the child components can be seen. The title attribute defines the label shown for the collapsible panel.

Supported Facets

Name Required Description
closedContent false
header false

Attributes

Name Type Supports EL? Description
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
id String Yes An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

indicatorStyle String Yes HTML: CSS styling instructions for the generated indicator. This attribute is ignored if a custom "header" facet is provided for the collapsible panel
indicatorStyleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute for the generated indicator span. This attribute is ignored if a custom "header" facet is provided for the collapsible panel
lang String Yes HTML: The base language of this document.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
titleStyle String Yes HTML: CSS styling instructions for the generated title. This attribute is ignored if a custom "header" facet is provided for the collapsible panel
titleStyleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute for the generated title. This attribute is ignored if a custom "header" facet is provided for the collapsible panel
titleVar String Yes This variable is defined to hold the value of the title component - you can use it for accessing this value in custom headers you define in a facet with name 'header'.
value Object Yes The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed
var String Yes The variable which you can use to check for the collapsed state of the enclosing component. This is especially useful for custom headers you define in a facet with name 'header'.
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.