Project Documentation

Summary

Tag name: <tr:group>
UIComponent class: org.apache.myfaces.trinidad.component.UIXGroup
Component type: org.apache.myfaces.trinidad.Group
The group component is an invisible control that aggregates semantically-related children; the group itself has no associated client representation (visual or API). Some parent components may have special representation for groups like adding separators around the group but this is a special case and is not always rendered this way. In most cases, only the children of the group will be rendered directly to the page. There will be no layout applied to the children so the natural layout behavior of the underlying HTML elements will apply. If you require a more predictable layout, you should use a layout component such as panelGroupLayout.

Code Example(s)

<tr:panelFormLayout labelWidth="33%" fieldWidth="67%">
  <tr:inputText label="non-group item 1"/>
  <tr:group>
    <tr:inputText label="group item 1"/>
    <tr:inputText label="group item 2"/>
    <tr:inputText label="group item 3"/>
  </tr:group>
  <tr:inputText label="non-group item 2"/>
</tr:panelFormLayout>

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
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.UIXGroupOnly 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.
endBoundaryStringYes Valid Values: show, hide, dontCare
Default Value: dontCare

indicates if a visual group end boundary is desired. The default value of 'dontCare' indicates no preference. A value of 'show' indicates a preference to show an end boundary. A value of 'hide' indicates a preference to not show an end boundary. Regardless of the end boundary value, whether a visual boundary will be displayed is up to the group's parent component.
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 ('-').
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.
startBoundaryStringYes Valid Values: show, hide, dontCare
Default Value: dontCare

indicates if a visual group start boundary is desired. The default value of 'dontCare' indicates no preference. A value of 'show' indicates a preference to show a start boundary. A value of 'hide' indicates a preference to not show a start boundary. Regardless of the start boundary value, whether a visual boundary will be displayed is up to the group's parent component.
titleStringYes a title value for the group. Whether anything is done with this title value is up to the group's parent component.