Parent Project

Project Documentation

Summary

Tag name: <tr:panelChoice>
UIComponent class:org.apache.myfaces.trinidad.component.core.layout.CorePanelChoiceComponent 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.

Supported Client Events for Client Behaviors

Events

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.

Attributes

Name

Type

Supports EL?

Description

accessKey

char

Yes

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

alignment

String

Yes

Valid Values: top, start, end, bottom, centerDefault Value: center

alignment of the elements. Defaults to
"center", if not specified. Other values are "start",
"end", "top", and "bottom".

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

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.

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.

label

String

Yes

the user-visible text of the item

labelAndAccessKey

String

Yes

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

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.

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

position

String

Yes

Valid Values: top, startDefault Value: start

position of the control elements. Defaults to
"start", if not specified. Other value supported is"top".

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.