Jakarta EE 11.0.0 · com.sun.faces.renderkit.html_basic.CheckboxRenderer

Modifier and Type	Field and Description
private static final Attribute[]	ATTRIBUTES

Access	Constructor and Description
public	CheckboxRenderer()

Method Summary

Modifier and Type	Method and Description
public void	decode(FacesContext `FacesContext` for the request we are processing context, UIComponent `UIComponent` to be decoded. component) Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.decode. Decode any new state of the specified `UIComponent` from the request contained in the specified `FacesContext`, and store that state on the `UIComponent`.
public void	encodeBegin(FacesContext `FacesContext` for the request we are processing context, UIComponent `UIComponent` to be rendered component) Overrides jakarta.faces.render.Renderer.encodeBegin. Render the beginning specified `UIComponent` to the output stream or writer associated with the response we are creating.
public Object	getConvertedValue(FacesContext `FacesContext` for the request we are processing context, UIComponent `UIComponent` to be decoded. component, Object a value stored on the component during `decode`. submittedValue) Overrides com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer.getConvertedValue. Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered `jakarta.faces.convert.Converter` for this component, if there is one).
protected void	getEndTextToRender(FacesContext the FacesContext for the current request context, UIComponent the UIComponent of interest component, String `component`'s current value currentValue) Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getEndTextToRender. Renderers override this method to write appropriate HTML content into the buffer.
private static boolean	Returns: "true" if the component was checked, otherise "false" isChecked(String the submitted value value)

Inherited from com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer:: getNonOnChangeBehaviors getNonOnClickSelectBehaviors getValue setSubmittedValue

ATTRIBUTES	back to summary
private static final Attribute[] ATTRIBUTES

CheckboxRenderer	back to summary
public CheckboxRenderer()

Method Detail

decode back to summary

decode	back to summary
public void decode(FacesContext context, UIComponent component) Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.decode. Doc from jakarta.faces.render.Renderer.decode. 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`. Parameters context:FacesContext `FacesContext` for the request we are processing component:UIComponent `UIComponent` to be decoded. Annotations @Override

public void decode(FacesContext context, UIComponent component)

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.decode.

Doc from jakarta.faces.render.Renderer.decode.

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.

Parameters

context:FacesContext: FacesContext for the request we are processing
component:UIComponent: UIComponent to be decoded.

Annotations

@Override

encodeBegin back to summary

encodeBegin	back to summary
public void encodeBegin(FacesContext context, UIComponent component) throws IOException Overrides jakarta.faces.render.Renderer.encodeBegin. Doc from jakarta.faces.render.Renderer.encodeBegin. 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. Parameters context:FacesContext `FacesContext` for the request we are processing component:UIComponent `UIComponent` to be rendered Annotations @Override Exceptions IOException: if an input/output error occurs while rendering

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

Overrides jakarta.faces.render.Renderer.encodeBegin.

Doc from jakarta.faces.render.Renderer.encodeBegin.

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.

Parameters

context:FacesContext: FacesContext for the request we are processing
component:UIComponent: UIComponent to be rendered

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs while rendering

getConvertedValue back to summary

getConvertedValue	back to summary
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException Overrides com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer.getConvertedValue. Doc from jakarta.faces.render.Renderer.getConvertedValue. Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered `jakarta.faces.convert.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. Parameters context:FacesContext `FacesContext` for the request we are processing component:UIComponent `UIComponent` to be decoded. submittedValue:Object a value stored on the component during `decode`. Returns:Object the converted value Annotations @Override Exceptions ConverterException: if the submitted value cannot be converted successfully.

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

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer.getConvertedValue.

Doc from jakarta.faces.render.Renderer.getConvertedValue.

Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered jakarta.faces.convert.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.

Parameters

context:FacesContext: FacesContext for the request we are processing
component:UIComponent: UIComponent to be decoded.
submittedValue:Object: a value stored on the component during decode.

Returns:Object

the converted value

Annotations

@Override

Exceptions

ConverterException:: if the submitted value cannot be converted successfully.

getEndTextToRender back to summary

getEndTextToRender	back to summary
protected void getEndTextToRender(FacesContext context, UIComponent component, String currentValue) throws IOException Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getEndTextToRender. Doc from com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getEndTextToRender. Renderers override this method to write appropriate HTML content into the buffer. Parameters context:FacesContext the FacesContext for the current request component:UIComponent the UIComponent of interest currentValue:String `component`'s current value Annotations @Override Exceptions IOException: if an error occurs rendering the text

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

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getEndTextToRender.

Doc from com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getEndTextToRender.

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

Parameters

context:FacesContext: the FacesContext for the current request
component:UIComponent: the UIComponent of interest
currentValue:String: component's current value

Annotations

@Override

Exceptions

IOException:: if an error occurs rendering the text

isChecked	back to summary
private static boolean isChecked(String value) Parameters value:String the submitted value Returns:boolean "true" if the component was checked, otherise "false"

public Class CheckboxRenderer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail