Mojarra 2.4.0 · com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

Modifier and Type	Class and Description
public static class	HtmlBasicRenderer.OptionComponentInfo Structure to hold common info used by Select* components to reduce the number of times component attributes are evaluated when rendering options.
public static class	HtmlBasicRenderer.Param Simple class to encapsulate the name and value of a `UIParameter`.

Modifier and Type	Field and Description
protected static final HtmlBasicRenderer.Param[]	EMPTY_PARAMS
private static final Set<SearchExpressionHint>	EXPRESSION_HINTS
protected static final Logger	logger

Access	Constructor and Description
public	HtmlBasicRenderer()

Method Summary

Modifier and Type	Method and Description
protected String	Returns: the (possibly augmented) `forValue.` `augmentIdReference(String - the basic id-reference value.forValue, UIComponent - the component that holds the code>forValue. fromComponent) Conditionally augment an id-reference value.`
public String	convertClientId(FacesContext `FacesContext` for the current request context, String the client identifier to be converted to client a specific format. clientId) Overrides javax.faces.render.Renderer.convertClientId. Convert the component generated client id to a form suitable for transmission to the client.
public void	decode(FacesContext `FacesContext` for the request we are processing context, UIComponent `UIComponent` to be decoded. component) Overrides javax.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`.
protected final String	decodeBehaviors(FacesContext context, UIComponent component)
public void	encodeEnd(FacesContext `FacesContext` for the response we are creating context, UIComponent `UIComponent` to be rendered component) Overrides javax.faces.render.Renderer.encodeEnd. 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.
protected void	encodeRecursive(FacesContext FacesContext for the current request context, UIComponent the component to recursively encode component) Render nested child components by invoking the encode methods on those components, but only when the `rendered` property is `true`.
private static UIComponent	Returns: the component with the the `id`forComponent otheriwse null if no match is found. findUIComponentBelow(UIComponent - the starting point in which to begin the search startPoint, String - the component to search for forComponent) Recursively searches for `NamingContainer`s from the given start point looking for the component with the `id` specified by `forComponent`.
protected Collection<ClientBehaviorContext.Parameter>	Returns: a collection of ClientBehaviorContext.Parameter instances. getBehaviorParameters(UIComponent the command which may have parameters command) Collections parameters for use with Behavior script rendering.
protected Iterator<UIComponent>	Returns: an Iterator over the children of the specified component, selecting only those that have a `rendered` property of `true`. getChildren(UIComponent `UIComponent` for which to extract children component)
protected String	Returns: the value to be rendered and formats it if required. Sets to empty string if value is null. getCurrentValue(FacesContext the FacesContext for the current request context, UIComponent the UIComponent whose value we're interested in component)
protected void	getEndTextToRender(FacesContext the FacesContext for the current request context, UIComponent the UIComponent of interest component, String `component`'s current value currentValue) Renderers override this method to write appropriate HTML content into the buffer.
protected UIComponent	Returns: the specified facet from the specified component, but only if its `rendered` property is set to `true`. getFacet(UIComponent Component from which to return a facet component, String Name of the desired facet name)
protected UIComponent	Returns: the component with the the `id`forComponent otheriwse null if no match is found. getForComponent(FacesContext the FacesContext for the current request context, String - the component to search for forComponent, UIComponent - the starting point in which to begin the search component) Locates the component identified by `forComponent`
protected String	Returns: the currentValue after any associated Converter has been applied getFormattedValue(FacesContext the FacesContext for the current request context, UIComponent UIComponent of interest component, Object the current value of `component` currentValue, Converter<T> the component's converter converter) Overloads getFormattedValue to take a advantage of a previously obtained converter.
protected String	Returns: the currentValue after any associated Converter has been applied getFormattedValue(FacesContext the FacesContext for the current request context, UIComponent UIComponent of interest component, Object the current value of `component` currentValue)
protected Iterator<E>	getMessageIter(FacesContext context, String forComponent, UIComponent component)
protected HtmlBasicRenderer.Param[]	Returns: an array of parameters getParamList(UIComponent the command which may have parameters command)
protected static Map<String, List<ClientBehavior>>	getPassThruBehaviors(UIComponent the component that we are rendering component, String the name of the dom-level event domEventName, String the name of the component-level event componentEventName) When rendering pass thru attributes, we need to take any attached Behaviors into account.
public boolean	getRendersChildren() Overrides javax.faces.render.Renderer.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 boolean	Returns: `true` if the behavior source is for the component being decoded, otherwise `false` isBehaviorSource(FacesContext the `FacesContext` for the current request ctx, String the ID of the behavior source behaviorSourceId, String the client ID of the component being decoded componentClientId)
protected void	rendererParamsNotNull(FacesContext context, UIComponent component)
protected void	setSubmittedValue(UIComponent the target component to which the submitted value will be set component, Object the value to set value) Renderers override this method to store the previous value of the associated component.
protected boolean	shouldDecode(UIComponent component)
protected boolean	shouldEncode(UIComponent component)
protected boolean	shouldEncodeChildren(UIComponent component)
protected boolean	Returns: true if this renderer should render an id attribute. shouldWriteIdAttribute(UIComponent the component of interest component)
protected String	writeIdAttributeIfNecessary(FacesContext context, ResponseWriter writer, UIComponent component)

Inherited from javax.faces.render.Renderer:: encodeBegin encodeChildren getConvertedValue

EMPTY_PARAMS	back to summary
protected static final HtmlBasicRenderer.Param[] EMPTY_PARAMS

EXPRESSION_HINTS	back to summary
private static final Set<SearchExpressionHint> EXPRESSION_HINTS

logger	back to summary
protected static final Logger logger

HtmlBasicRenderer	back to summary
public HtmlBasicRenderer()

Method Detail

augmentIdReference back to summary

augmentIdReference	back to summary
protected String augmentIdReference(String forValue, UIComponent fromComponent) Conditionally augment an id-reference value. If the `forValue` doesn't already include a generated suffix, but the id of the `fromComponent` does include a generated suffix, then append the suffix from the `fromComponent` to the `forValue`. Otherwise just return the `forValue` as is. Parameters forValue:String - the basic id-reference value. fromComponent:UIComponent - the component that holds the code>forValue. Returns:String the (possibly augmented) `forValue.`

protected String augmentIdReference(String forValue, UIComponent fromComponent)

Conditionally augment an id-reference value.

If the forValue doesn't already include a generated suffix, but the id of the fromComponent does include a generated suffix, then append the suffix from the fromComponent to the forValue. Otherwise just return the forValue as is.

Parameters

forValue:String: - the basic id-reference value.
fromComponent:UIComponent: - the component that holds the code>forValue.

Returns:String

the (possibly augmented) forValue.

convertClientId back to summary

convertClientId	back to summary
public String convertClientId(FacesContext context, String clientId) Overrides javax.faces.render.Renderer.convertClientId. Doc from javax.faces.render.Renderer.convertClientId. Convert the component generated client id to a form suitable for transmission to the client. The default implementation returns the argument `clientId` unchanged. Parameters context:FacesContext `FacesContext` for the current request clientId:String the client identifier to be converted to client a specific format. Returns:String the converted `clientId` Annotations @Override

public String convertClientId(FacesContext context, String clientId)

Overrides javax.faces.render.Renderer.convertClientId.

Doc from javax.faces.render.Renderer.convertClientId.

Convert the component generated client id to a form suitable for transmission to the client.

The default implementation returns the argument clientId unchanged.

Parameters

context:FacesContext: FacesContext for the current request
clientId:String: the client identifier to be converted to client a specific format.

Returns:String

the converted clientId

Annotations

@Override

decode back to summary

decode	back to summary
public void decode(FacesContext context, UIComponent component) Overrides javax.faces.render.Renderer.decode. Doc from javax.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 javax.faces.render.Renderer.decode.

Doc from javax.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

decodeBehaviors	back to summary
protected final String decodeBehaviors(FacesContext context, UIComponent component)

encodeEnd back to summary

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

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

Overrides javax.faces.render.Renderer.encodeEnd.

Doc from javax.faces.render.Renderer.encodeEnd.

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.

Parameters

context:FacesContext: FacesContext for the response we are creating
component:UIComponent: UIComponent to be rendered

Annotations

@Override

Exceptions

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

encodeRecursive back to summary

encodeRecursive	back to summary
protected void encodeRecursive(FacesContext context, UIComponent component) throws IOException Render nested child components by invoking the encode methods on those components, but only when the `rendered` property is `true`. Parameters context:FacesContext FacesContext for the current request component:UIComponent the component to recursively encode Exceptions IOException: if an error occurrs during the encode process

protected void encodeRecursive(FacesContext context, UIComponent component) throws IOException

Render nested child components by invoking the encode methods on those components, but only when the rendered property is true.

Parameters

context:FacesContext: FacesContext for the current request
component:UIComponent: the component to recursively encode

Exceptions

IOException:: if an error occurrs during the encode process

findUIComponentBelow back to summary

findUIComponentBelow	back to summary
private static UIComponent findUIComponentBelow(UIComponent startPoint, String forComponent) Recursively searches for `NamingContainer`s from the given start point looking for the component with the `id` specified by `forComponent`. Parameters startPoint:UIComponent - the starting point in which to begin the search forComponent:String - the component to search for Returns:UIComponent the component with the the `id`forComponent otheriwse null if no match is found.

private static UIComponent findUIComponentBelow(UIComponent startPoint, String forComponent)

Recursively searches for NamingContainers from the given start point looking for the component with the id specified by forComponent.

Parameters

startPoint:UIComponent: - the starting point in which to begin the search
forComponent:String: - the component to search for

Returns:UIComponent

the component with the the idforComponent otheriwse null if no match is found.

getBehaviorParameters	back to summary
protected Collection<ClientBehaviorContext.Parameter> getBehaviorParameters(UIComponent command) Collections parameters for use with Behavior script rendering. Similar to getParamList(), but returns a collection of ClientBehaviorContext.Parameter instances. Parameters command:UIComponent the command which may have parameters Returns:Collection<ClientBehaviorContext.Parameter> a collection of ClientBehaviorContext.Parameter instances.

getBehaviorParameters

back to summary

protected Collection<ClientBehaviorContext.Parameter> getBehaviorParameters(UIComponent command)

Collections parameters for use with Behavior script rendering. Similar to getParamList(), but returns a collection of ClientBehaviorContext.Parameter instances.

Parameters

command:UIComponent: the command which may have parameters

Returns:Collection<ClientBehaviorContext.Parameter>

a collection of ClientBehaviorContext.Parameter instances.

getChildren	back to summary
protected Iterator<UIComponent> getChildren(UIComponent component) Parameters component:UIComponent `UIComponent` for which to extract children Returns:Iterator<UIComponent> an Iterator over the children of the specified component, selecting only those that have a `rendered` property of `true`.

getCurrentValue	back to summary
protected String getCurrentValue(FacesContext context, UIComponent component) Parameters context:FacesContext the FacesContext for the current request component:UIComponent the UIComponent whose value we're interested in Returns:String the value to be rendered and formats it if required. Sets to empty string if value is null.

getEndTextToRender back to summary

getEndTextToRender	back to summary
protected void getEndTextToRender(FacesContext context, UIComponent component, String currentValue) throws IOException 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 Exceptions IOException: if an error occurs rendering the text

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

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

Exceptions

IOException:: if an error occurs rendering the text

getFacet	back to summary
protected UIComponent getFacet(UIComponent component, String name) Parameters component:UIComponent Component from which to return a facet name:String Name of the desired facet Returns:UIComponent the specified facet from the specified component, but only if its `rendered` property is set to `true`.

getForComponent back to summary

getForComponent	back to summary
protected UIComponent getForComponent(FacesContext context, String forComponent, UIComponent component) Locates the component identified by `forComponent` Parameters context:FacesContext the FacesContext for the current request forComponent:String - the component to search for component:UIComponent - the starting point in which to begin the search Returns:UIComponent the component with the the `id`forComponent otheriwse null if no match is found.

protected UIComponent getForComponent(FacesContext context, String forComponent, UIComponent component)

Locates the component identified by forComponent

Parameters

context:FacesContext: the FacesContext for the current request
forComponent:String: - the component to search for
component:UIComponent: - the starting point in which to begin the search

Returns:UIComponent

the component with the the idforComponent otheriwse null if no match is found.

getFormattedValue back to summary

getFormattedValue	back to summary
protected String getFormattedValue(FacesContext context, UIComponent component, Object currentValue, Converter<T> converter) throws ConverterException Overloads getFormattedValue to take a advantage of a previously obtained converter. Parameters context:FacesContext the FacesContext for the current request component:UIComponent UIComponent of interest currentValue:Object the current value of `component` converter:Converter<T> the component's converter Returns:String the currentValue after any associated Converter has been applied Exceptions ConverterException: if the value cannot be converted

protected String getFormattedValue(FacesContext context, UIComponent component, Object currentValue, Converter<T> converter) throws ConverterException

Overloads getFormattedValue to take a advantage of a previously obtained converter.

Parameters

context:FacesContext: the FacesContext for the current request
component:UIComponent: UIComponent of interest
currentValue:Object: the current value of component
converter:Converter<T>: the component's converter

Returns:String

the currentValue after any associated Converter has been applied

Exceptions

ConverterException:: if the value cannot be converted

getFormattedValue back to summary

getFormattedValue	back to summary
protected String getFormattedValue(FacesContext context, UIComponent component, Object currentValue) throws ConverterException Parameters context:FacesContext the FacesContext for the current request component:UIComponent UIComponent of interest currentValue:Object the current value of `component` Returns:String the currentValue after any associated Converter has been applied Exceptions ConverterException: if the value cannot be converted

protected String getFormattedValue(FacesContext context, UIComponent component, Object currentValue) throws ConverterException

Parameters

context:FacesContext: the FacesContext for the current request
component:UIComponent: UIComponent of interest
currentValue:Object: the current value of component

Returns:String

the currentValue after any associated Converter has been applied

Exceptions

ConverterException:: if the value cannot be converted

getMessageIter	back to summary
protected Iterator<E> getMessageIter(FacesContext context, String forComponent, UIComponent component)

getParamList	back to summary
protected HtmlBasicRenderer.Param[] getParamList(UIComponent command) Parameters command:UIComponent the command which may have parameters Returns:HtmlBasicRenderer.Param[] an array of parameters

getPassThruBehaviors	back to summary
protected static Map<String, List<ClientBehavior>> getPassThruBehaviors(UIComponent component, String domEventName, String componentEventName) When rendering pass thru attributes, we need to take any attached Behaviors into account. The presence of a non-empty Behaviors map can cause us to switch from optimized pass thru attribute rendering to the unoptimized code path. However, in two very common cases - attaching action behaviors to commands and attaching value change behaviors to editable value holders - the behaviors map is populated with behaviors that are not handled by the pass thru attribute code - ie. the behaviors are handled locally by the renderer. In order to optimize such cases, we check to see whether the component's behaviors map actually contains behaviors only for these non-pass thru attributes. If so, we can pass a null behavior map into renderPassThruAttributes(), thus ensuring that we can take advantage of the optimized pass thru rendering logic. Note that in all cases where we use this method, we actually have two behavior events that we want to check for - a low-level/dom event (eg. "click", or "change") plus a high-level component event (eg. "action", or "valueChange"). Parameters component:UIComponent the component that we are rendering domEventName:String the name of the dom-level event componentEventName:String the name of the component-level event

getPassThruBehaviors

back to summary

protected static Map<String, List<ClientBehavior>> getPassThruBehaviors(UIComponent component, String domEventName, String componentEventName)

When rendering pass thru attributes, we need to take any attached Behaviors into account. The presence of a non-empty Behaviors map can cause us to switch from optimized pass thru attribute rendering to the unoptimized code path. However, in two very common cases - attaching action behaviors to commands and attaching value change behaviors to editable value holders - the behaviors map is populated with behaviors that are not handled by the pass thru attribute code - ie. the behaviors are handled locally by the renderer. In order to optimize such cases, we check to see whether the component's behaviors map actually contains behaviors only for these non-pass thru attributes. If so, we can pass a null behavior map into renderPassThruAttributes(), thus ensuring that we can take advantage of the optimized pass thru rendering logic. Note that in all cases where we use this method, we actually have two behavior events that we want to check for - a low-level/dom event (eg. "click", or "change") plus a high-level component event (eg. "action", or "valueChange").

Parameters

component:UIComponent: the component that we are rendering
domEventName:String: the name of the dom-level event
componentEventName:String: the name of the component-level event

getRendersChildren back to summary

getRendersChildren	back to summary
public boolean getRendersChildren() Overrides javax.faces.render.Renderer.getRendersChildren. Doc from javax.faces.render.Renderer.getRendersChildren. 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`. Returns:boolean the current value of the flag Annotations @Override

public boolean getRendersChildren()

Overrides javax.faces.render.Renderer.getRendersChildren.

Doc from javax.faces.render.Renderer.getRendersChildren.

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.

Returns:boolean

the current value of the flag

Annotations

@Override

getValue	back to summary
protected Object getValue(UIComponent component)

isBehaviorSource back to summary

isBehaviorSource	back to summary
protected boolean isBehaviorSource(FacesContext ctx, String behaviorSourceId, String componentClientId) Parameters ctx:FacesContext the `FacesContext` for the current request behaviorSourceId:String the ID of the behavior source componentClientId:String the client ID of the component being decoded Returns:boolean `true` if the behavior source is for the component being decoded, otherwise `false`

protected boolean isBehaviorSource(FacesContext ctx, String behaviorSourceId, String componentClientId)

Parameters

ctx:FacesContext: the FacesContext for the current request
behaviorSourceId:String: the ID of the behavior source
componentClientId:String: the client ID of the component being decoded

Returns:boolean

true if the behavior source is for the component being decoded, otherwise false

rendererParamsNotNull	back to summary
protected void rendererParamsNotNull(FacesContext context, UIComponent component)

setSubmittedValue	back to summary
protected void setSubmittedValue(UIComponent component, Object value) Renderers override this method to store the previous value of the associated component. Parameters component:UIComponent the target component to which the submitted value will be set value:Object the value to set

setSubmittedValue

back to summary

protected void setSubmittedValue(UIComponent component, Object value)

Renderers override this method to store the previous value of the associated component.

Parameters

component:UIComponent: the target component to which the submitted value will be set
value:Object: the value to set

shouldDecode	back to summary
protected boolean shouldDecode(UIComponent component)

shouldEncode	back to summary
protected boolean shouldEncode(UIComponent component)

shouldEncodeChildren	back to summary
protected boolean shouldEncodeChildren(UIComponent component)

shouldWriteIdAttribute	back to summary
protected boolean shouldWriteIdAttribute(UIComponent component) Parameters component:UIComponent the component of interest Returns:boolean true if this renderer should render an id attribute.

writeIdAttributeIfNecessary	back to summary
protected String writeIdAttributeIfNecessary(FacesContext context, ResponseWriter writer, UIComponent component)

Modifier and Type	Field and Description
pack-priv boolean	disabled
pack-priv String	disabledClass
pack-priv String	enabledClass
pack-priv boolean	hideNoSelection
pack-priv String	selectedClass
pack-priv String	unselectedClass

public abstract Class HtmlBasicRenderer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HtmlBasicRenderer.OptionComponentInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HtmlBasicRenderer.Param

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Method and Description
public String	getDisabledClass()
public String	getEnabledClass()
public String	getSelectedClass()
public String	getUnselectedClass()
public boolean	isDisabled()
public boolean	isHideNoSelection()