Module jakarta.faces

Package com.sun.faces.renderkit.html_basic

Class CommandLinkRenderer

java.lang.Object

jakarta.faces.render.Renderer

com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

com.sun.faces.renderkit.html_basic.LinkRenderer

com.sun.faces.renderkit.html_basic.CommandLinkRenderer

public class CommandLinkRenderer
extends LinkRenderer

CommandLinkRenderer is a class that renders the current value of UICommand as a HyperLink that acts like a Button.

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

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.
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.
void	encodeEnd(FacesContext context, UIComponent component)	Render the ending of the current state of the specified UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered.
boolean	getRendersChildren()	Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render.
protected Object	getValue(UIComponent component)
protected void	renderAsActive(FacesContext context, UIComponent command)

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

renderAsDisabled, writeCommonLinkAttributes, writeValue

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

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

Methods inherited from class jakarta.faces.render.Renderer

getConvertedValue

Methods inherited from class java.lang.Object

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

Constructor Details

CommandLinkRenderer

public CommandLinkRenderer()

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

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

encodeEnd

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

Description copied from class: Renderer

Render the ending of the current state of the specified UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered.

Overrides:

encodeEnd in class HtmlBasicRenderer

Parameters:

context - FacesContext for the response we are creating

component - UIComponent to be rendered

Throws:

IOException - if an input/output error occurs while rendering

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

getValue

protected Object getValue(UIComponent component)

Overrides:

getValue in class HtmlBasicRenderer

renderAsActive

protected void renderAsActive(FacesContext context,
 UIComponent command)
                       throws IOException

Specified by:

renderAsActive in class LinkRenderer

Throws:

IOException