Project Documentation


Tag name: <tr:panelList>
UIComponent class: org.apache.myfaces.trinidad.component.core.layout.CorePanelList
Component type: org.apache.myfaces.trinidad.CorePanelList

The panelList component outputs each visible child in a list with a bullet next to it. The list can be split into columns. This is done by setting the "rows" attribute. This is the multiple of children at which to add another column. For example, if the "rows" attribute was set to 6 then if there were 1-6 visible children there would be one column, 7 to 12 visible children there would be 2 columns, and 13+ visible children would be shown in 3 columns. The number of columns is determined by the value set for "maxColumns" attribute. So if there were 100 visible children with "rows" set to 30 and "maxColumns" was set to 3 children, there will be 3 columns (and 34 rows). If "rows" attribute is not specified, all visible contents will be in one column. The "maxColumns" that can be set is dependent on the type of Agent. If the value set for "maxColumns" is greater than the default for the agent, then it is defaulted. The default maxColumns value is 2 for the PDA. Children are not displayed/rendered if value of "maxColumns" or "rows" is less than one. The split is based solely on the number of visible children and not on their size.

Code Example(s)

<tr:panelList rows="5">
  <tr:goLink text="link 1" destination=""/>
  <tr:goLink text="link 2" destination=""/>
  <tr:goLink text="link 3" destination=""/>
  <tr:goLink text="link 4" destination=""/>
  <tr:goLink text="link 5" destination=""/>
  <tr:goLink text="link 6" destination=""/>
  <tr:goLink text="link 7" destination=""/>
  <tr:goLink text="link 8" destination=""/>

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


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.
bindingorg.apache.myfaces.trinidad.component.core.layout.CorePanelListOnly 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.
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyleStringYes the CSS styles to use for this component.
listStyleStringYes Styles the list. For example, you can style the list to be squares like this: listStyle='list-style-type:square'
maxColumnsintYes Default Value: 3

Sets the maximum number of columns to show. This attribute defaults to 3 and defaults to 2 for PDA's
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
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.

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

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.
rowsintYes Default Value: 2147483647

Sets the number of rows after which to start a new column. This attribute defaults to Integer.MAX_VALUE. The number of rows actually rendered depends also on the "maxColumns" attribute. If the children will not fit in the given number of rows and columns, the number of rows will increase to accomodate the children.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.