Project Documentation

Summary

Tag name: <tr:panelChoice>
UIComponent class: org.apache.myfaces.trinidad.component.core.layout.CorePanelChoice
Component type: org.apache.myfaces.trinidad.CorePanelChoice
The panelChoice control can be used to display a group of contents belonging to a showDetailItem. A choice control with each individual option representing a showDetailItem child is displayed. An option within choice control corresponding to showDetailItem that is disclosed is shown as selected and contents of selected showDetailItem is displayed. If none of the showDetailItem children are selected, the first showDetailItem that is enabled is considered to be selected.

Code Example(s)

The following is an example of panelChoice.

<tr:panelChoice labelAndAccessKey="Current &Bug Status" position="top" alignment="end">
  <tr:showDetailItem text="10.1.3">
    <tr:panelHeader text="10.1.3 Open Bugs"/>
  </tr:showDetailItem>
  <tr:showDetailItem text="10.1.2 R2" >
    <tr:panelHeader text="10.1.2 R2 Open Bugs"/>
  </tr:showDetailItem>
  <tr:showDetailItem text="Untriaged Bugs">
    <tr:panelHeader text="Untriaged Bugs per component"/>
  </tr:showDetailItem>
</tr:panelChoice>

Supported Client Events for Client Behaviors

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

Events

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.

Attributes

Name Type Supports EL? Description
accessKeycharYes Character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

alignmentStringYes Valid Values: top, start, end, bottom, center
Default Value: center

alignment of the elements. Defaults to "center", if not specified. Other values are "start", "end", "top", and "bottom".
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.CorePanelChoiceOnly 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.
labelStringYes the user-visible text of the item
labelAndAccessKeyStringYes An attribute that will simultaneously set both the "value" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.

For example, setting this attribute to "L&amp;abel" will set the label to "Label" and the access key to 'a'.

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

positionStringYes Valid Values: top, start
Default Value: start

position of the control elements. Defaults to "start", if not specified. Other value supported is"top".
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.
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.