Parent Project
Project Documentation

Summary

Tag name: <trh:cellFormat>
UIComponent class: org.apache.myfaces.trinidad.component.html.HtmlCellFormat
Component type: org.apache.myfaces.trinidad.HtmlCellFormat
Required Ancestor Tag: trh:rowLayout
CellFormat components are used to format cells in a rowLayout. It is a container of other layout elements which allows its contents to take additional formatting, such as vertical alignment, width, or colspan.

Code Example(s)

<trh:tableLayout width="75%"
                 borderWidth="3"
                 cellSpacing="10"
                 halign="center">
  <trh:rowLayout halign="right">
    <!-- First Column -->
    <trh:cellFormat valign="bottom"/>
    <!-- SecondColumn -->
    </trh:cellFormat>
    <tr:panelGroupLayout laytout="horizontal">
      <!-- Third Column -->
      <tr:spacer height="100" width="1"/>
    </tr:panelGroupLayout>
  </trh:rowLayout>
  <trh:rowLayout>
    <tr:panelHeader text="Apache Trinidad Components"/>
    <trh:cellFormat columnSpan="2">
      <tr:panelHeader text="Faces Servlet"/>
    </trh:cellFormat>
  </trh:rowLayout>
</trh:tableLayout>

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.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
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.html.HtmlCellFormat 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.
columnSpan int Yes the number of cells wide the child layout element will be.
halign String Yes Valid Values: right, start, left, end, center

the horizontal alignment of the grid row elements. The acceptable values are "center", "left", "right", "start", and "end".
header boolean Yes Indicates whether or not this table cell is a header cell or a data cell. Setting this attribute to 'true' will mark this cell as a header cell.
headers String Yes Indicates which table cells are the headers for this cell. This attribute is used by screen readers to associate header information with data cells. This must be set to a space-separated list of IDs. Each ID must be the ID of a pertinent header cell.
height String Yes the preferred height of the enclosed layout elements.
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 inline CSS style for this element
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.
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.
rowSpan int Yes the number of cells high the child layout element will be.
shortDesc String Yes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
shortText String Yes This attribute should be used to provide an abbreviated form of the cell's content, and may be rendered by user agents when appropriate in place of the cell's content. Abbreviated names should be short since user agents may render them repeatedly (especially if this cell is a header cell).
styleClass String Yes the CSS style class of the bean.
valign String Yes Valid Values: middle, top, bottom

the vertical alignment of the grid row elements. The acceptable values are "middle", "top", and "bottom".
width String Yes the preferred width of the enclosed layout elements.
wrappingDisabled boolean Yes Default Value: false

whether automatic text wrapping should be disabled for this cell.