com.sun.faces.renderkit.html_basic

Class OutcomeTargetRenderer

java.lang.Object

jakarta.faces.render.Renderer

com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

com.sun.faces.renderkit.html_basic.OutcomeTargetRenderer

Direct Known Subclasses:

OutcomeTargetButtonRenderer, OutcomeTargetLinkRenderer

public abstract class OutcomeTargetRenderer
extends HtmlBasicRenderer

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 and Description
OutcomeTargetRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	addNavigationParams(jakarta.faces.application.NavigationCase navCase, Map<String,List<String>> existingParams)
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.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.
protected String	getEncodedTargetURL(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, jakarta.faces.application.NavigationCase navCase) Resolve the target view id and then delegate to ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) to produce a redirect URL, which will add the page parameters if necessary and properly prioritizing the parameter overrides.
protected String	getFragment(jakarta.faces.component.UIComponent component)
protected String	getLabel(jakarta.faces.component.UIComponent component)
protected jakarta.faces.application.NavigationCase	getNavigationCase(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Invoke the NavigationHandler preemptively to resolve a NavigationCase for the outcome declared on the UIOutcomeTarget component.
protected Map<String,List<String>>	getParamOverrides(jakarta.faces.component.UIComponent component)
protected Object	getValue(jakarta.faces.component.UIComponent component)
protected boolean	isIncludeViewParams(jakarta.faces.component.UIComponent component, jakarta.faces.application.NavigationCase navcase)
protected void	renderPassThruAttributes(jakarta.faces.context.FacesContext ctx, jakarta.faces.context.ResponseWriter writer, jakarta.faces.component.UIComponent component, Attribute[] attributes, List excludedAttributes)

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

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

Methods inherited from class jakarta.faces.render.Renderer

encodeBegin, encodeChildren, getConvertedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

OutcomeTargetRenderer

public OutcomeTargetRenderer()

Method Detail

decode

public void decode(jakarta.faces.context.FacesContext context,
                   jakarta.faces.component.UIComponent component)

Description copied from class: jakarta.faces.render.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.

renderPassThruAttributes

protected void renderPassThruAttributes(jakarta.faces.context.FacesContext ctx,
                                        jakarta.faces.context.ResponseWriter writer,
                                        jakarta.faces.component.UIComponent component,
                                        Attribute[] attributes,
                                        List excludedAttributes)
                                 throws IOException

Throws:

IOException

getLabel

protected String getLabel(jakarta.faces.component.UIComponent component)

getFragment

protected String getFragment(jakarta.faces.component.UIComponent component)

getValue

protected Object getValue(jakarta.faces.component.UIComponent component)

Overrides:

getValue in class HtmlBasicRenderer

isIncludeViewParams

protected boolean isIncludeViewParams(jakarta.faces.component.UIComponent component,
                                      jakarta.faces.application.NavigationCase navcase)

getNavigationCase

protected jakarta.faces.application.NavigationCase getNavigationCase(jakarta.faces.context.FacesContext context,
                                                                     jakarta.faces.component.UIComponent component)

Invoke the NavigationHandler preemptively to resolve a NavigationCase for the outcome declared on the UIOutcomeTarget component. The current view id is used as the from-view-id when matching navigation cases and the from-action is assumed to be null.

Parameters:

context - the FacesContext for the current request

component - the target UIComponent

Returns:

the NavigationCase represeting the outcome target

getEncodedTargetURL

protected String getEncodedTargetURL(jakarta.faces.context.FacesContext context,
                                     jakarta.faces.component.UIComponent component,
                                     jakarta.faces.application.NavigationCase navCase)

Resolve the target view id and then delegate to ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) to produce a redirect URL, which will add the page parameters if necessary and properly prioritizing the parameter overrides.

Parameters:

context - the FacesContext for the current request

component - the target UIComponent

navCase - the target navigation case

Returns:

an encoded URL for the provided navigation case

addNavigationParams

protected void addNavigationParams(jakarta.faces.application.NavigationCase navCase,
                                   Map<String,List<String>> existingParams)

getParamOverrides

protected Map<String,List<String>> getParamOverrides(jakarta.faces.component.UIComponent component)