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.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.html.HtmlCellFormatOnly 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.
columnSpanintYes the number of cells wide the child layout element will be.
halignStringYes 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".
headerbooleanYes 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.
headersStringYes 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.
heightStringYes the preferred height of the enclosed layout elements.
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 inline CSS style for this element
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.
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.
rowSpanintYes the number of cells high the child layout element will be.
shortDescStringYes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
shortTextStringYes 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).
styleClassStringYes the CSS style class of the bean.
valignStringYes Valid Values: middle, top, bottom

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

whether automatic text wrapping should be disabled for this cell.