Google Git
Sign in
apache / tomee-site-pub / 14ef54cb4240e1bb450ae2914088fc5c011a3518 / . / jakartaee-10.0 / javadoc / jakarta / faces / render / Renderer.html
blob: a2409accc274f05e4a754a7edfedfbf9d607424d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Renderer</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Renderer";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/render/FacesRenderer.html" title="annotation in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/RendererWrapper.html" title="class in jakarta.faces.render"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/render/Renderer.html" target="_top">Frames</a></li>
<li><a href="Renderer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.faces.render</div>
<h2 title="Class Renderer" class="title">Class Renderer&lt;T extends <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.faces.render.Renderer&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The component class.</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../jakarta/faces/render/RendererWrapper.html" title="class in jakarta.faces.render">RendererWrapper</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Renderer&lt;T extends <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;</span>
extends java.lang.Object</pre>
<div class="block"><p>
A <strong class="changed_modified_2_0 changed_modified_2_2">Renderer</strong> converts the internal representation of
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s into the output stream (or writer) associated with the response we are creating for a particular
request. Each <code>Renderer</code> knows how to render one or more <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> types (or classes), and
advertises a set of render-dependent attributes that it recognizes for each supported <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p>
<p>
Families of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>s are packaged as a <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, and together support the rendering of all of the
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s in a view associated with a <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>. Within the set of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>s for a
particular <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, each must be uniquely identified by the <code>rendererType</code> property.
</p>
<p>
Individual <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instances will be instantiated as requested during the rendering process, and will remain
in existence for the remainder of the lifetime of a web application. Because each instance may be invoked from more
than one request processing thread simultaneously, they MUST be programmed in a thread-safe manner.
</p>
<div class="changed_added_2_0">
<p>
If the <a href="../../../jakarta/faces/event/ListenerFor.html" title="annotation in jakarta.faces.event"><code>ListenerFor</code></a> annotation is attached to the class definition of a
<code>Renderer</code>, that class must also implement <a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><code>ComponentSystemEventListener</code></a>, and
the action pertaining to the processing of <code>ResourceDependency</code> on a <code>Renderer</code> described in
<a href="../../../jakarta/faces/event/ListenerFor.html" title="annotation in jakarta.faces.event"><code>ListenerFor</code></a> must be taken.
</p>
<p>
If the <a href="../../../jakarta/faces/application/ResourceDependency.html" title="annotation in jakarta.faces.application"><code>ResourceDependency</code></a> annotation is attached to the class definition of a
<code>Renderer</code>, the action pertaining to the processing of <code>ResourceDependency</code> on a
<code>Renderer</code> described in <a href="../../../jakarta/faces/component/UIComponent.html#getChildren--"><code>UIComponent.getChildren()</code></a> must be taken.
</p>
</div>
<div class="changed_modified_4_0">
The generic parameter T represents the component class.
</div></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#PASSTHROUGH_RENDERER_LOCALNAME_KEY">PASSTHROUGH_RENDERER_LOCALNAME_KEY</a></span></code>
<div class="block"><p class="changed_added_2_2">
The key in the component passthrough attributes <code>Map</code> for the localName of the element corresponding to the
component.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#Renderer--">Renderer</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#convertClientId-jakarta.faces.context.FacesContext-java.lang.String-">convertClientId</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.String&nbsp;clientId)</code>
<div class="block">
Convert the component generated client id to a form suitable for transmission to the client.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#decode-jakarta.faces.context.FacesContext-T-">decode</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)</code>
<div class="block">
Decode any new state of the specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> from the request contained in the specified
<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>, and store that state on the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#encodeBegin-jakarta.faces.context.FacesContext-T-">encodeBegin</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)</code>
<div class="block">
Render the beginning specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to the output stream or writer associated with the response we are
creating.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#encodeChildren-jakarta.faces.context.FacesContext-T-">encodeChildren</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)</code>
<div class="block">
Render the child components of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, following the rules described for <code>encodeBegin()</code>
to acquire the appropriate value to be rendered.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#encodeEnd-jakarta.faces.context.FacesContext-T-">encodeEnd</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)</code>
<div class="block">
Render the ending of the current state of the specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, following the rules described for
<code>encodeBegin()</code> to acquire the appropriate value to be rendered.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#getConvertedValue-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-java.lang.Object-">getConvertedValue</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component,
java.lang.Object&nbsp;submittedValue)</code>
<div class="block">
Attempt to convert previously stored state information into an object of the type required for this component
(optionally using the registered <a href="../../../jakarta/faces/convert/Converter.html" title="interface in jakarta.faces.convert"><code>Converter</code></a> for this component, if there is one).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/Renderer.html#getRendersChildren--">getRendersChildren</a></span>()</code>
<div class="block">
Return a flag indicating whether this <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> is responsible for rendering the children the component it is
asked to render.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PASSTHROUGH_RENDERER_LOCALNAME_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PASSTHROUGH_RENDERER_LOCALNAME_KEY</h4>
<pre>public static final&nbsp;java.lang.String PASSTHROUGH_RENDERER_LOCALNAME_KEY</pre>
<div class="block"><p class="changed_added_2_2">
The key in the component passthrough attributes <code>Map</code> for the localName of the element corresponding to the
component.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#jakarta.faces.render.Renderer.PASSTHROUGH_RENDERER_LOCALNAME_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Renderer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Renderer</h4>
<pre>public&nbsp;Renderer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="decode-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a><a name="decode-jakarta.faces.context.FacesContext-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public&nbsp;void&nbsp;decode(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)</pre>
<div class="block"><p>
Decode any new state of the specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> from the request contained in the specified
<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>, and store that state on the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p>
<p>
During decoding, events may be enqueued for later processing (by event listeners that have registered an interest),
by calling <code>queueEvent()</code> on the associated <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
<dd><code>component</code> - <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to be decoded.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>component</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="encodeBegin-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a><a name="encodeBegin-jakarta.faces.context.FacesContext-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBegin</h4>
<pre>public&nbsp;void&nbsp;encodeBegin(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)
throws java.io.IOException</pre>
<div class="block"><p>
Render the beginning specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to the output stream or writer associated with the response we are
creating. If the conversion attempted in a previous call to <code>getConvertedValue()</code> for this component
failed, the state information saved during execution of <code>decode()</code> should be used to reproduce the
incorrect input.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
<dd><code>component</code> - <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to be rendered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>component</code> is null</dd>
</dl>
</li>
</ul>
<a name="encodeChildren-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a><a name="encodeChildren-jakarta.faces.context.FacesContext-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeChildren</h4>
<pre>public&nbsp;void&nbsp;encodeChildren(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)
throws java.io.IOException</pre>
<div class="block"><p>
Render the child components of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, following the rules described for <code>encodeBegin()</code>
to acquire the appropriate value to be rendered. This method will only be called if the <code>rendersChildren</code>
property of this component is <code>true</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the response we are creating</dd>
<dd><code>component</code> - <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> whose children are to be rendered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>component</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="encodeEnd-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a><a name="encodeEnd-jakarta.faces.context.FacesContext-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeEnd</h4>
<pre>public&nbsp;void&nbsp;encodeEnd(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/render/Renderer.html" title="type parameter in Renderer">T</a>&nbsp;component)
throws java.io.IOException</pre>
<div class="block"><p>
Render the ending of the current state of the specified <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, following the rules described for
<code>encodeBegin()</code> to acquire the appropriate value to be rendered.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the response we are creating</dd>
<dd><code>component</code> - <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to be rendered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>component</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="convertClientId-jakarta.faces.context.FacesContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertClientId</h4>
<pre>public&nbsp;java.lang.String&nbsp;convertClientId(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.String&nbsp;clientId)</pre>
<div class="block"><p>
Convert the component generated client id to a form suitable for transmission to the client.
</p>
<p>
The default implementation returns the argument <code>clientId</code> unchanged.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the current request</dd>
<dd><code>clientId</code> - the client identifier to be converted to client a specific format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the converted <code>clientId</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>clientId</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getRendersChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRendersChildren</h4>
<pre>public&nbsp;boolean&nbsp;getRendersChildren()</pre>
<div class="block"><p>
Return a flag indicating whether this <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> is responsible for rendering the children the component it is
asked to render. The default implementation returns <code>false</code>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current value of the flag</dd>
</dl>
</li>
</ul>
<a name="getConvertedValue-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConvertedValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getConvertedValue(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component,
java.lang.Object&nbsp;submittedValue)
throws <a href="../../../jakarta/faces/convert/ConverterException.html" title="class in jakarta.faces.convert">ConverterException</a></pre>
<div class="block"><p>
Attempt to convert previously stored state information into an object of the type required for this component
(optionally using the registered <a href="../../../jakarta/faces/convert/Converter.html" title="interface in jakarta.faces.convert"><code>Converter</code></a> for this component, if there is one). If
conversion is successful, the new value should be returned from this method; if not, a <a href="../../../jakarta/faces/convert/ConverterException.html" title="class in jakarta.faces.convert"><code>ConverterException</code></a>
should be thrown.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
<dd><code>component</code> - <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to be decoded.</dd>
<dd><code>submittedValue</code> - a value stored on the component during <code>decode</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the converted value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/faces/convert/ConverterException.html" title="class in jakarta.faces.convert">ConverterException</a></code> - if the submitted value cannot be converted successfully.</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> or <code>component</code> is <code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/render/FacesRenderer.html" title="annotation in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/RendererWrapper.html" title="class in jakarta.faces.render"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/render/Renderer.html" target="_top">Frames</a></li>
<li><a href="Renderer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>