HtmlDivLayoutRenderer (Metawidget API Documentation)

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

```
public class HtmlDivLayoutRenderer
extends HtmlLayoutRenderer
```
Layout to arrange widgets in HTML DIV tags, with one DIV per label and per widget, and a wrapper DIV around both.
This implementation recognizes the following <f:param> parameters:
- divStyleClasses - comma separated list of style classes to apply to the DIVs, in order of outer, label, required, component, errors
- outerStyle - CSS styles to apply to the outer DIV
- labelStyle - CSS styles to apply to the label DIV
- componentStyle - this is the style applied to the DIV around the component, not to the component itself. The component itself can be styled using the style attribute on the Metawidget tag
- requiredStyle - CSS styles to apply to the required DIV
Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

HtmlDivLayoutRenderer()

Constructors
Constructor and Description
`HtmlDivLayoutRenderer()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected javax.faces.component.UIComponent`	`createInlineMessage(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, String messageFor)` Creates an inline `HtmlMessage` attached to the given `messageFor` id.
`void`	`encodeBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidgetComponent)`
`void`	`encodeChildren(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)`
`void`	`encodeEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget)`
`protected void`	`layoutAfterChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent child)`
`protected void`	`layoutBeforeChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent componentChild)`
`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`	`writeStyleClass(javax.faces.component.UIComponent metawidget, javax.faces.context.ResponseWriter writer, int styleClass)`

Methods inherited from class org.metawidget.faces.renderkit.html.HtmlLayoutRenderer
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
- HtmlDivLayoutRenderer
```
public HtmlDivLayoutRenderer()
```

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

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context,
                  javax.faces.component.UIComponent component)
                    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

createInlineMessage

protected javax.faces.component.UIComponent createInlineMessage(javax.faces.context.FacesContext context,
                                                    javax.faces.component.UIComponent metawidget,
                                                    String messageFor)

Description copied from class: HtmlLayoutRenderer

Creates an inline HtmlMessage attached to the given messageFor id.

Subclasses can override this method to create a different messaging object, such as an HtmlMessages (with an 's').

Overrides:: createInlineMessage in class HtmlLayoutRenderer

layoutBeforeChild

protected void layoutBeforeChild(javax.faces.context.FacesContext context,
                     javax.faces.component.UIComponent metawidget,
                     javax.faces.component.UIComponent componentChild)
                          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

layoutRequired

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

Throws:: IOException

layoutAfterChild

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

Parameters:: metawidget - the Metawidget doing the layout; child - the component being laid out
Throws:: IOException

writeStyleClass

protected void writeStyleClass(javax.faces.component.UIComponent metawidget,
                   javax.faces.context.ResponseWriter writer,
                   int styleClass)
                        throws IOException

Throws:: IOException

Class HtmlDivLayoutRenderer

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

HtmlDivLayoutRenderer