Module jakarta.faces

Package com.sun.faces.renderkit.html_basic

Class TextRenderer

java.lang.Object

jakarta.faces.render.Renderer

com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer

com.sun.faces.renderkit.html_basic.TextRenderer

Direct Known Subclasses:

FileRenderer

public class TextRenderer
extends HtmlBasicInputRenderer

TextRenderer is a class that renders the current value of UIInput or UIOutput component as a input field or static text.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

HtmlBasicRenderer.OptionComponentInfo, HtmlBasicRenderer.Param

Field Summary

Fields inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

EMPTY_PARAMS, logger

Fields inherited from class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor	Description
TextRenderer()

Method Summary

Modifier and Type	Method	Description
void	encodeBegin(FacesContext context, UIComponent component)	Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating.
void	encodeChildren(FacesContext context, UIComponent component)	Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered.
protected void	getEndTextToRender(FacesContext context, UIComponent component, String currentValue)	Renderers override this method to write appropriate HTML content into the buffer.
boolean	getRendersChildren()	Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render.

Methods inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer

getConvertedValue, getNonOnChangeBehaviors, getNonOnClickSelectBehaviors, getValue, setSubmittedValue

Methods inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

augmentIdReference, convertClientId, decode, decodeBehaviors, encodeEnd, encodeRecursive, getBehaviorParameters, getChildren, getCurrentValue, getFacet, getForComponent, getFormattedValue, getFormattedValue, getMessageIter, getParamList, getPassThruBehaviors, isBehaviorSource, rendererParamsNotNull, shouldDecode, shouldEncode, shouldEncodeChildren, shouldWriteIdAttribute, writeIdAttributeIfNecessary

Methods inherited from class java.lang.Object

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

Constructor Details

TextRenderer

public TextRenderer()

Method Details

encodeBegin

public void encodeBegin(FacesContext context,
 UIComponent component)
                 throws IOException

Description copied from class: Renderer

Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating. If the conversion attempted in a previous call to getConvertedValue() for this component failed, the state information saved during execution of decode() should be used to reproduce the incorrect input.

Overrides:

encodeBegin in class Renderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be rendered

Throws:

IOException - if an input/output error occurs while rendering

getEndTextToRender

protected void getEndTextToRender(FacesContext context,
 UIComponent component,
 String currentValue)
                           throws IOException

Description copied from class: HtmlBasicRenderer

Renderers override this method to write appropriate HTML content into the buffer.

Overrides:

getEndTextToRender in class HtmlBasicRenderer

Parameters:

context - the FacesContext for the current request

component - the UIComponent of interest

currentValue - component's current value

Throws:

IOException - if an error occurs rendering the text

getRendersChildren

public boolean getRendersChildren()

Description copied from class: Renderer

Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render. The default implementation returns false.

Overrides:

getRendersChildren in class HtmlBasicRenderer

Returns:

the current value of the flag

encodeChildren

public void encodeChildren(FacesContext context,
 UIComponent component)
                    throws IOException

Description copied from class: Renderer

Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property of this component is true.

Overrides:

encodeChildren in class Renderer

Parameters:

context - FacesContext for the response we are creating

component - UIComponent whose children are to be rendered

Throws:

IOException - if an input/output error occurs while rendering