HtmlLayoutRenderer (Metawidget API Documentation)

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

Direct Known Subclasses:

HtmlDivLayoutRenderer, HtmlTableLayoutRenderer
```
public abstract class HtmlLayoutRenderer
extends javax.faces.render.Renderer
```
Base class for all JSF HTML layout renderers. This implementation recognizes the following <f:param> parameters:
- inlineMessages - whether to wrap input components with inline <h:message> tags. True by default
- messageStyle
- messageStyleClass
- labelSuffix
Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

HtmlLayoutRenderer()

Constructors
Constructor and Description
`HtmlLayoutRenderer()`

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.
`protected javax.faces.component.UIOutput`	`createLabel(javax.faces.context.FacesContext context, javax.faces.component.UIComponent componentNeedingLabel)` Create a label component for the given `UIComponent`.
`void`	`encodeBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidgetComponent)`
`protected String`	`getLabelText(javax.faces.component.UIComponent componentNeedingLabel)`
`boolean`	`getRendersChildren()` Denotes that this Renderer renders its own children (eg.
`protected void`	`layoutChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent childComponent)`
`protected boolean`	`layoutLabel(javax.faces.context.FacesContext context, javax.faces.component.UIComponent metawidget, javax.faces.component.UIComponent componentNeedingLabel)` Render the label text.
`protected void`	`writeStyleAndClass(UIMetawidget metawidget, javax.faces.context.ResponseWriter writer, String style)`

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

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

Constructor Detail
- HtmlLayoutRenderer
```
public HtmlLayoutRenderer()
```

Method Detail

encodeBegin

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

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

getRendersChildren
```
public boolean getRendersChildren()
```
Denotes that this Renderer renders its own children (eg. JSF should not call encodeBegin on each child for us)

Overrides:

getRendersChildren in class javax.faces.render.Renderer

getLabelText

protected String getLabelText(javax.faces.component.UIComponent componentNeedingLabel)

layoutLabel
```
protected boolean layoutLabel(javax.faces.context.FacesContext context,
                  javax.faces.component.UIComponent metawidget,
                  javax.faces.component.UIComponent componentNeedingLabel)
                       throws IOException
```
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.

Returns:
whether a label was written

Throws:

IOException

createLabel

protected javax.faces.component.UIOutput createLabel(javax.faces.context.FacesContext context,
                                         javax.faces.component.UIComponent componentNeedingLabel)

Create a label component for the given UIComponent. Clients may override this method to create a different type of label component.

layoutChild

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

Throws:: IOException

createInlineMessage

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.

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

writeStyleAndClass

protected void writeStyleAndClass(UIMetawidget metawidget,
                      javax.faces.context.ResponseWriter writer,
                      String style)
                           throws IOException

Throws:: IOException

Class HtmlLayoutRenderer

Constructor Summary

Method Summary

Methods inherited from class javax.faces.render.Renderer

Methods inherited from class java.lang.Object

Constructor Detail

HtmlLayoutRenderer