de.larmic.butterfaces.component.base.renderer

Class HtmlBasicRenderer

java.lang.Object

javax.faces.render.Renderer

de.larmic.butterfaces.component.base.renderer.HtmlBasicRenderer

Direct Known Subclasses:

ActivateLibrariesRenderer, AutoCompleteRenderer, LabeledContainerRenderer, ModalPanelRenderer, PrettyPrintRenderer, SectionRenderer, TooltipRenderer, TreeRenderer, WaitingPanelRenderer

public class HtmlBasicRenderer
extends javax.faces.render.Renderer

Base butterfaces component renderer class. Should be used if possible.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_CLASS
static String	ATTRIBUTE_ID
static String	ATTRIBUTE_STYLE
static String	ELEMENT_DIV
static String	ELEMENT_SECTION
static String	ELEMENT_SPAN

Fields inherited from class javax.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor and Description
HtmlBasicRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	encodeRecursive(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Render nested child components by invoking the encode methods on those components, but only when the rendered property is true.
protected Iterator<javax.faces.component.UIComponent>	getChildren(javax.faces.component.UIComponent component)
protected javax.faces.component.UIComponent	getFacet(javax.faces.component.UIComponent component, String name)
protected void	rendererParamsNotNull(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
protected boolean	shouldEncode(javax.faces.component.UIComponent component)
protected boolean	shouldWriteIdAttribute(javax.faces.component.UIComponent component)
protected String	writeIdAttribute(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component)
protected String	writeIdAttributeIfNecessary(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component)

Methods inherited from class javax.faces.render.Renderer

convertClientId, decode, encodeBegin, encodeChildren, encodeEnd, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ELEMENT_DIV

public static final String ELEMENT_DIV

See Also:

Constant Field Values

ELEMENT_SPAN

public static final String ELEMENT_SPAN

See Also:

Constant Field Values

ELEMENT_SECTION

public static final String ELEMENT_SECTION

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final String ATTRIBUTE_ID

See Also:

Constant Field Values

ATTRIBUTE_STYLE

public static final String ATTRIBUTE_STYLE

See Also:

Constant Field Values

ATTRIBUTE_CLASS

public static final String ATTRIBUTE_CLASS

See Also:

Constant Field Values

Constructor Detail

HtmlBasicRenderer

public HtmlBasicRenderer()

Method Detail

rendererParamsNotNull

protected void rendererParamsNotNull(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component)

shouldEncode

protected boolean shouldEncode(javax.faces.component.UIComponent component)

writeIdAttributeIfNecessary

protected String writeIdAttributeIfNecessary(javax.faces.context.FacesContext context,
                                             javax.faces.context.ResponseWriter writer,
                                             javax.faces.component.UIComponent component)
                                      throws IOException

Throws:

IOException

writeIdAttribute

protected String writeIdAttribute(javax.faces.context.FacesContext context,
                                  javax.faces.context.ResponseWriter writer,
                                  javax.faces.component.UIComponent component)
                           throws IOException

Throws:

IOException

shouldWriteIdAttribute

protected boolean shouldWriteIdAttribute(javax.faces.component.UIComponent component)

Parameters:

component - the component of interest

Returns:

true if this renderer should render an id attribute.

encodeRecursive

protected void encodeRecursive(javax.faces.context.FacesContext context,
                               javax.faces.component.UIComponent component)
                        throws IOException

Render nested child components by invoking the encode methods on those components, but only when the rendered property is true.

Parameters:

context - FacesContext for the current request

component - the component to recursively encode

Throws:

IOException - if an error occurrs during the encode process

getChildren

protected Iterator<javax.faces.component.UIComponent> getChildren(javax.faces.component.UIComponent component)

Parameters:

component - UIComponent for which to extract children

Returns:

an Iterator over the children of the specified component, selecting only those that have a rendered property of true.

getFacet

protected javax.faces.component.UIComponent getFacet(javax.faces.component.UIComponent component,
                                                     String name)

Parameters:

component - Component from which to return a facet

name - Name of the desired facet

Returns:

the specified facet from the specified component, but only if its rendered property is set to true.