Module jakarta.faces

Package com.sun.faces.renderkit.html_basic

Class CheckboxRenderer

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.CheckboxRenderer

public class CheckboxRenderer
extends HtmlBasicInputRenderer

CheckboxRenderer is a class that renders the current value of UISelectBoolean as a checkbox.

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
CheckboxRenderer()

Method Summary

Modifier and Type	Method	Description
void	decode(FacesContext context, UIComponent component)	Decode any new state of the specified UIComponent from the request contained in the specified FacesContext, and store that state on the UIComponent.
void	encodeBegin(FacesContext context, UIComponent component)	Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating.
Object	getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)	Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered Converter for this component, if there is one).
protected void	getEndTextToRender(FacesContext context, UIComponent component, String currentValue)	Renderers override this method to write appropriate HTML content into the buffer.

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

getNonOnChangeBehaviors, getNonOnClickSelectBehaviors, getValue, setSubmittedValue

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

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

Methods inherited from class jakarta.faces.render.Renderer

encodeChildren

Methods inherited from class java.lang.Object

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

Constructor Details

CheckboxRenderer

public CheckboxRenderer()

Method Details

decode

public void decode(FacesContext context,
 UIComponent component)

Description copied from class: Renderer

Decode any new state of the specified UIComponent from the request contained in the specified FacesContext, and store that state on the UIComponent.

During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling queueEvent() on the associated UIComponent.

Overrides:

decode in class HtmlBasicRenderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be decoded.

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

getConvertedValue

public Object getConvertedValue(FacesContext context,
 UIComponent component,
 Object submittedValue)
                         throws ConverterException

Description copied from class: Renderer

Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered Converter for this component, if there is one). If conversion is successful, the new value should be returned from this method; if not, a ConverterException should be thrown.

Overrides:

getConvertedValue in class HtmlBasicInputRenderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be decoded.

submittedValue - a value stored on the component during decode.

Returns:

the converted value

Throws:

ConverterException - if the submitted value cannot be converted successfully.

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