HtmlTableLayoutRenderer (Metawidget API Documentation)

java.lang.Object
- javax.faces.render.Renderer
- - org.metawidget.faces.renderkit.html.HtmlLayoutRenderer
  - - org.metawidget.faces.renderkit.html.HtmlTableLayoutRenderer

```
public class HtmlTableLayoutRenderer
extends HtmlLayoutRenderer
```
Layout to arrange components in a table, with one column for labels and another for the component.
This implementation recognizes the following <f:facet> names:
- header
This implementation recognizes the following <f:param> parameters: tableStyle - CSS styles to apply to outer table tag tableStyleClass - CSS style class to apply to outer table tag columns - number of columns. Each label/component pair is considered one column columnClasses - comma delimited string of CSS style classes to apply to table columns in order of: label, component, required labelStyle - CSS styles to apply to label column componentStyle - CSS styles to apply to component column requiredStyle - CSS styles to apply to required column (ie. the star) headerStyle - CSS styles to apply to table header headerStyleClass - CSS style class to apply to table header footerStyle - CSS styles to apply to table footer footerStyleClass - CSS style class to apply to table footer rowClasses - comma delimited string of CSS style classes to apply to alternating table rows labelSuffix - suffix to put after the label name. Defaults to a colon (ie. 'Name:') The parameters columns and columnClasses might more properly be named numberOfColumns and columnStyleClasses, but we are trying to follow the javax.faces.component.html.HtmlDataTable convention.
Author: Richard Kennard










Constructor Summary

Constructors 

Constructor and Description


HtmlTableLayoutRenderer() 









Method Summary

Methods 

Modifier and Type
Method and Description


void
encodeBegin(javax.faces.context.FacesContext context,
           javax.faces.component.UIComponent metawidgetComponent) 


void
encodeChildren(javax.faces.context.FacesContext context,
              javax.faces.component.UIComponent metawidget) 


void
encodeEnd(javax.faces.context.FacesContext context,
         javax.faces.component.UIComponent metawidget) 


protected String
getCssId(javax.faces.component.UIComponent metawidget) 


protected boolean
hasHtmlInputHiddenChildren(javax.faces.component.UIComponent metawidget)
Determines if the Metawidget has children which are instances of
 javax.faces.component.html.HtmlInputHidden.



protected void
layoutAfterChild(javax.faces.context.FacesContext context,
                javax.faces.component.UIComponent metawidget,
                javax.faces.component.UIComponent childComponent) 


protected void
layoutBeforeChild(javax.faces.context.FacesContext context,
                 javax.faces.component.UIComponent metawidget,
                 javax.faces.component.UIComponent childComponent) 


protected void
layoutHtmlInputHiddenChildren(javax.faces.context.FacesContext context,
                             javax.faces.component.UIComponent metawidget)
Layout any javax.faces.component.html.HtmlInputHidden children first, before the
 <table>.



protected boolean
layoutLabel(javax.faces.context.FacesContext context,
           javax.faces.component.UIComponent metawidget,
           javax.faces.component.UIComponent componentNeedingLabel)
Render the label text.



protected void
layoutRequired(javax.faces.context.FacesContext context,
              javax.faces.component.UIComponent metawidget,
              javax.faces.component.UIComponent child) 


protected void
writeColumnStyleClass(javax.faces.component.UIComponent metawidget,
                     javax.faces.context.ResponseWriter writer,
                     int columnStyleClass) 


protected void
writeRowStyleClass(javax.faces.component.UIComponent metawidget,
                  javax.faces.context.ResponseWriter writer,
                  int rowStyleClass) 






Methods inherited from class org.metawidget.faces.renderkit.html.HtmlLayoutRenderer
createInlineMessage, createLabel, getLabelText, getRendersChildren, layoutChild, writeStyleAndClass





Methods inherited from class javax.faces.render.Renderer
convertClientId, decode, getConvertedValue





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





HtmlTableLayoutRenderer
public HtmlTableLayoutRenderer()









Method Detail





encodeBegin
public void encodeBegin(javax.faces.context.FacesContext context,
               javax.faces.component.UIComponent metawidgetComponent)
                 throws IOException

Overrides:
encodeBegin in class HtmlLayoutRenderer
Throws:
IOException







hasHtmlInputHiddenChildren
protected boolean hasHtmlInputHiddenChildren(javax.faces.component.UIComponent metawidget)
Determines if the Metawidget has children which are instances of
 javax.faces.component.html.HtmlInputHidden. If so, the hidden fields will be
 written as siblings of the <table> and the whole thing wrapped in an outer
 <div>.







layoutHtmlInputHiddenChildren
protected void layoutHtmlInputHiddenChildren(javax.faces.context.FacesContext context,
                                 javax.faces.component.UIComponent metawidget)
                                      throws IOException
Layout any javax.faces.component.html.HtmlInputHidden children first, before the
 <table>.
Throws:
IOException







encodeChildren
public void encodeChildren(javax.faces.context.FacesContext context,
                  javax.faces.component.UIComponent metawidget)
                    throws IOException

Overrides:
encodeChildren in class javax.faces.render.Renderer
Throws:
IOException







encodeEnd
public void encodeEnd(javax.faces.context.FacesContext context,
             javax.faces.component.UIComponent metawidget)
               throws IOException

Overrides:
encodeEnd in class javax.faces.render.Renderer
Throws:
IOException







layoutBeforeChild
protected void layoutBeforeChild(javax.faces.context.FacesContext context,
                     javax.faces.component.UIComponent metawidget,
                     javax.faces.component.UIComponent childComponent)
                          throws IOException
Throws:
IOException







layoutLabel
protected boolean layoutLabel(javax.faces.context.FacesContext context,
                  javax.faces.component.UIComponent metawidget,
                  javax.faces.component.UIComponent componentNeedingLabel)
                       throws IOException
Description copied from class: HtmlLayoutRenderer
Render the label text. Rendering is done via an HtmlOutputText renderer, so that
 it is properly escaped. Any JSF EL expressions embedded in the label should have already been
 evaluated by FacesInspectionResultProcessor.

Overrides:
layoutLabel in class HtmlLayoutRenderer
Returns:
whether a label was written
Throws:
IOException







layoutAfterChild
protected void layoutAfterChild(javax.faces.context.FacesContext context,
                    javax.faces.component.UIComponent metawidget,
                    javax.faces.component.UIComponent childComponent)
                         throws IOException
Throws:
IOException







layoutRequired
protected void layoutRequired(javax.faces.context.FacesContext context,
                  javax.faces.component.UIComponent metawidget,
                  javax.faces.component.UIComponent child)
                       throws IOException
Throws:
IOException







getCssId
protected String getCssId(javax.faces.component.UIComponent metawidget)







writeColumnStyleClass
protected void writeColumnStyleClass(javax.faces.component.UIComponent metawidget,
                         javax.faces.context.ResponseWriter writer,
                         int columnStyleClass)
                              throws IOException
Throws:
IOException







writeRowStyleClass
protected void writeRowStyleClass(javax.faces.component.UIComponent metawidget,
                      javax.faces.context.ResponseWriter writer,
                      int rowStyleClass)
                           throws IOException
Throws:
IOException

Modifier and Type	Method and Description
`void`	`encodeBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidgetComponent)`
`void`	`encodeChildren(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget)`
`void`	`encodeEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget)`
`protected String`	`getCssId(javax.faces.component.UIComponent metawidget)`
`protected boolean`	`hasHtmlInputHiddenChildren(javax.faces.component.UIComponent metawidget)` Determines if the Metawidget has children which are instances of `javax.faces.component.html.HtmlInputHidden`.
`protected void`	`layoutAfterChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent childComponent)`
`protected void`	`layoutBeforeChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent childComponent)`
`protected void`	`layoutHtmlInputHiddenChildren(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget)` Layout any `javax.faces.component.html.HtmlInputHidden` children first, before the <table>.
`protected boolean`	`layoutLabel(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent componentNeedingLabel)` Render the label text.
`protected void`	`layoutRequired(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent child)`
`protected void`	`writeColumnStyleClass(javax.faces.component.UIComponent metawidget, javax.faces.context.ResponseWriter writer, int columnStyleClass)`
`protected void`	`writeRowStyleClass(javax.faces.component.UIComponent metawidget, javax.faces.context.ResponseWriter writer, int rowStyleClass)`

Class HtmlTableLayoutRenderer

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.faces.renderkit.html.HtmlLayoutRenderer

Methods inherited from class javax.faces.render.Renderer

Methods inherited from class java.lang.Object

Constructor Detail

HtmlTableLayoutRenderer

Method Detail

encodeBegin

hasHtmlInputHiddenChildren

layoutHtmlInputHiddenChildren

encodeChildren

encodeEnd

layoutBeforeChild

layoutLabel

layoutAfterChild

layoutRequired

getCssId

writeColumnStyleClass

writeRowStyleClass