Top Fields Constructors Methods
com.sun.faces.renderkit.html_basic

public abstract Class OutcomeTargetRenderer

extends HtmlBasicRenderer
Class Inheritance
Known Direct Subclasses
com.sun.faces.renderkit.html_basic.OutcomeTargetButtonRenderer, com.sun.faces.renderkit.html_basic.OutcomeTargetLinkRenderer
Imports
java.io.IOException, java.util.ArrayList, .LinkedHashMap, .List, .Map, java.util.logging.Level, com.sun.faces.application.NavigationHandlerImpl, com.sun.faces.flow.FlowHandlerImpl, com.sun.faces.renderkit.Attribute, .RenderKitUtils, com.sun.faces.util.Util, jakarta.faces.application.ConfigurableNavigationHandler, .NavigationCase, .NavigationHandler, .ViewHandler, jakarta.faces.component.UIComponent, .UIOutcomeTarget, jakarta.faces.context.FacesContext, .ResponseWriter, jakarta.faces.event.ActionListener, jakarta.faces.flow.FlowHandler, jakarta.faces.lifecycle.ClientWindow

Field Summary

Inherited from com.sun.faces.renderkit.html_basic.HtmlBasicRenderer:
EMPTY_PARAMSlogger

Constructor Summary

AccessConstructor and Description
public
OutcomeTargetRenderer()

Method Summary

Modifier and TypeMethod and Description
protected void
addNavigationParams(NavigationCase navCase, Map<String, List<String>> existingParams)

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.

protected String

Returns:

an encoded URL for the provided navigation case
getEncodedTargetURL(FacesContext
the FacesContext for the current request
context, UIComponent
the target UIComponent
component, NavigationCase
the target navigation case
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(UIComponent component)

protected String
getLabel(UIComponent component)

protected NavigationCase

Returns:

the NavigationCase represeting the outcome target
getNavigationCase(FacesContext
the FacesContext for the current request
context, UIComponent
the target UIComponent
component)

Invoke the NavigationHandler preemptively to resolve a NavigationCase for the outcome declared on the UIOutcomeTarget component.

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

protected Object
getValue(UIComponent component)

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

protected boolean
isIncludeViewParams(UIComponent component, NavigationCase navcase)

protected void
renderPassThruAttributes(FacesContext ctx, ResponseWriter writer, UIComponent component, Attribute[] attributes, List<E> excludedAttributes)

Inherited from com.sun.faces.renderkit.html_basic.HtmlBasicRenderer:
augmentIdReferenceconvertClientIddecodeBehaviorsencodeEndencodeRecursivegetBehaviorParametersgetChildrengetCurrentValuegetEndTextToRendergetFacetgetForComponentgetFormattedValuegetFormattedValuegetMessageItergetParamListgetPassThruBehaviorsgetRendersChildrenisBehaviorSourcerendererParamsNotNullsetSubmittedValueshouldDecodeshouldEncodeshouldEncodeChildrenshouldWriteIdAttributewriteIdAttributeIfNecessary

Constructor Detail

OutcomeTargetRendererback to summary
public OutcomeTargetRenderer()

Method Detail

addNavigationParamsback to summary
protected void addNavigationParams(NavigationCase navCase, Map<String, List<String>> existingParams)
decodeback 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
getEncodedTargetURLback to summary
protected String getEncodedTargetURL(FacesContext context, UIComponent component, 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:FacesContext

the FacesContext for the current request

component:UIComponent

the target UIComponent

navCase:NavigationCase

the target navigation case

Returns:String

an encoded URL for the provided navigation case

getFragmentback to summary
protected String getFragment(UIComponent component)
getLabelback to summary
protected String getLabel(UIComponent component)
getNavigationCaseback to summary
protected NavigationCase getNavigationCase(FacesContext context, 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:FacesContext

the FacesContext for the current request

component:UIComponent

the target UIComponent

Returns:NavigationCase

the NavigationCase represeting the outcome target

getParamOverridesback to summary
protected Map<String, List<String>> getParamOverrides(UIComponent component)
getValueback to summary
protected Object getValue(UIComponent component)

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

Annotations
@Override
isIncludeViewParamsback to summary
protected boolean isIncludeViewParams(UIComponent component, NavigationCase navcase)
renderPassThruAttributesback to summary
protected void renderPassThruAttributes(FacesContext ctx, ResponseWriter writer, UIComponent component, Attribute[] attributes, List<E> excludedAttributes) throws IOException