Summary
Tag name:
<tr:panelLabelAndMessage>
UIComponent class:
org.apache.myfaces.trinidad.component.core.layout.CorePanelLabelAndMessage
Component type:
org.apache.myfaces.trinidad.CorePanelLabelAndMessage
This component lays out a label, children, tip, and associated message.
Typically, the only child of this component will be an
input element of some sort, but as many children as necessary can
be added. When using panelLabelAndMessage with a Trinidad
input component, you should always
set simple="true"
on the input
component. Non-simple Trinidad input components already
effectively have all the functionality of
panelLabelAndMessage.
Note that the label and messages that are rendered only apply to the "for" component so messages and labels will not be shown if there are multiple input child components.
To lay out multiple panelLabelAndMessage components - or multiple non-simple Trinidad input components - you can use the panelForm component. When panelLabelAndMessage components are placed inside a panelForm the labels will line up.
Example(s):
<tr:panelLabelAndMessage for="selectDate"> <f:facet name="help"> <tr:outputText value="Pick a date"/> </f:facet> <tr:inputDate id="selectDate" simple="true"/> </tr:panelLabelAndMessage>
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 events might include the width of a column that supported client-side resizing. |
Supported Facets
Name | Description |
---|---|
end | Component to render after the children. |
help | This facet should contain field level help. |
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". |
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. |
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. |
for | String | Yes | The ID of the component that this component's label refers to. |
id | String | No | the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
|
inlineStyle | String | Yes | the CSS styles to use for this component. |
label | String | Yes | the label of the bean. |
labelAndAccessKey | String | Yes | An attribute that will simultaneously set both the "label" and "accessKey" attributes from a single value, using conventional ampersand notation. For example, setting this attribute to "T&ext" will set the label to "Text" and the access key to 'e'. |
labelStyle | String | Yes | Specifies inline styles for the label portion of the component, e.g. "vertical-align: bottom;" to align the label to the bottom of the container. |
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 | 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). |
shortDesc | String | Yes | The short description of the component. This text is commonly used by user agents to display tooltip help text. |
showRequired | boolean | Yes | whether the panel should show an indicator that its contents are required. |
styleClass | String | Yes | a CSS style class to use for this component. |