Google Git
Sign in
apache / tomee-site-pub / d63ad4575738d0254e721c23504f9337b87b8f69 / . / jakartaee-10.0 / javadoc / jakarta / faces / render / RenderKit.html
blob: 395a22a31ce51c475f67cd2cb84520a926e348c1 [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>RenderKit</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="RenderKit";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":6,"i3":6,"i4":10,"i5":10,"i6":10,"i7":6,"i8":10,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RendererWrapper.html" title="class in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/RenderKitFactory.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/RenderKit.html" target="_top">Frames</a></li>
<li><a href="RenderKit.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>Field&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>Field&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 RenderKit" class="title">Class RenderKit</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.faces.render.RenderKit</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../jakarta/faces/render/RenderKitWrapper.html" title="class in jakarta.faces.render">RenderKitWrapper</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">RenderKit</span>
extends java.lang.Object</pre>
<div class="block"><p>
<span class="changed_modified_2_0"><strong>RenderKit</strong></span> represents a collection of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>
instances that, together, know how to render Jakarta Faces <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> instances for a specific
client. Typically, <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>s are specialized for some combination of client device type, markup language,
and/or user <code>Locale</code>. A <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a> also acts as a Factory for associated <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>
instances, which perform the actual rendering process for each component.
</p>
<p>
A typical Jakarta Faces implementation will configure one or more <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a> instances at web
application startup. They are made available through calls to the <code>getRenderKit()</code> methods of
<a href="../../../jakarta/faces/render/RenderKitFactory.html" title="class in jakarta.faces.render"><code>RenderKitFactory</code></a>. Because <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a> instances are shared, they must be implemented in a thread-safe
manner. Due to limitations in the current specification having multiple <code>RenderKit</code> instances at play in
the same application requires a custom <a href="../../../jakarta/faces/application/ViewHandler.html" title="class in jakarta.faces.application"><code>ViewHandler</code></a> instance that is aware of how to
deal with this case. This limitation will be lifted in a future version of the spec.
</p>
<p>
The <code>RenderKit</code> instance must also vend a <a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render"><code>ResponseStateManager</code></a> instance, which is used in the
process of saving and restoring tree structure and state.
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/RenderKit.html#RenderKit--">RenderKit</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#addClientBehaviorRenderer-java.lang.String-jakarta.faces.render.ClientBehaviorRenderer-">addClientBehaviorRenderer</a></span>(java.lang.String&nbsp;type,
<a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render">ClientBehaviorRenderer</a>&nbsp;renderer)</code>
<div class="block">
Register the specified <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance, associated with the specified component
<code>type</code>, to the set of <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a>s registered with this <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, replacing
any previously registered <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> for this type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#addRenderer-java.lang.String-java.lang.String-jakarta.faces.render.Renderer-">addRenderer</a></span>(java.lang.String&nbsp;family,
java.lang.String&nbsp;rendererType,
<a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a>&nbsp;renderer)</code>
<div class="block">
Register the specified <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance, associated with the specified component <code>family</code> and
<code>rendererType</code>, to the set of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>s registered with this <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, replacing any
previously registered <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> for this combination of identifiers.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context">ResponseStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#createResponseStream-java.io.OutputStream-">createResponseStream</a></span>(java.io.OutputStream&nbsp;out)</code>
<div class="block">
Use the provided <code>OutputStream</code> to create a new <a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context"><code>ResponseStream</code></a> instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context">ResponseWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#createResponseWriter-java.io.Writer-java.lang.String-java.lang.String-">createResponseWriter</a></span>(java.io.Writer&nbsp;writer,
java.lang.String&nbsp;contentTypeList,
java.lang.String&nbsp;characterEncoding)</code>
<div class="block">
Use the provided <code>Writer</code> to create a new <a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context"><code>ResponseWriter</code></a> instance for the specified (optional)
content type, and character encoding.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render">ClientBehaviorRenderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getClientBehaviorRenderer-java.lang.String-">getClientBehaviorRenderer</a></span>(java.lang.String&nbsp;type)</code>
<div class="block">
Return the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance most recently registered for the specified <code>type</code>, if
any; otherwise, return <code>null</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getClientBehaviorRendererTypes--">getClientBehaviorRendererTypes</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> types.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getComponentFamilies--">getComponentFamilies</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the component-family entries supported by this <code>RenderKit</code> instance.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getRenderer-java.lang.String-java.lang.String-">getRenderer</a></span>(java.lang.String&nbsp;family,
java.lang.String&nbsp;rendererType)</code>
<div class="block">
Return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance most recently registered for the specified component <code>family</code> and
<code>rendererType</code>, if any; otherwise, return <code>null</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getRendererTypes-java.lang.String-">getRendererTypes</a></span>(java.lang.String&nbsp;componentFamily)</code>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the renderer-type entries for the given component-family.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render">ResponseStateManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/RenderKit.html#getResponseStateManager--">getResponseStateManager</a></span>()</code>
<div class="block">
Return an instance of <a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render"><code>ResponseStateManager</code></a> to handle rendering technology specific state management
decisions.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RenderKit--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RenderKit</h4>
<pre>public&nbsp;RenderKit()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addRenderer-java.lang.String-java.lang.String-jakarta.faces.render.Renderer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRenderer</h4>
<pre>public abstract&nbsp;void&nbsp;addRenderer(java.lang.String&nbsp;family,
java.lang.String&nbsp;rendererType,
<a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a>&nbsp;renderer)</pre>
<div class="block"><p>
Register the specified <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance, associated with the specified component <code>family</code> and
<code>rendererType</code>, to the set of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>s registered with this <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, replacing any
previously registered <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> for this combination of identifiers.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - Component family of the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> to register</dd>
<dd><code>rendererType</code> - Renderer type of the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> to register</dd>
<dd><code>renderer</code> - <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance we are registering</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>family</code> or <code>rendererType</code> or <code>renderer</code> is null</dd>
</dl>
</li>
</ul>
<a name="getRenderer-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenderer</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a>&nbsp;getRenderer(java.lang.String&nbsp;family,
java.lang.String&nbsp;rendererType)</pre>
<div class="block"><p>
Return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance most recently registered for the specified component <code>family</code> and
<code>rendererType</code>, if any; otherwise, return <code>null</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - Component family of the requested <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance</dd>
<dd><code>rendererType</code> - Renderer type of the requested <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>family</code> or <code>rendererType</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getResponseStateManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseStateManager</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render">ResponseStateManager</a>&nbsp;getResponseStateManager()</pre>
<div class="block"><p>
Return an instance of <a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render"><code>ResponseStateManager</code></a> to handle rendering technology specific state management
decisions.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../jakarta/faces/render/ResponseStateManager.html" title="class in jakarta.faces.render"><code>ResponseStateManager</code></a></dd>
</dl>
</li>
</ul>
<a name="createResponseWriter-java.io.Writer-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResponseWriter</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context">ResponseWriter</a>&nbsp;createResponseWriter(java.io.Writer&nbsp;writer,
java.lang.String&nbsp;contentTypeList,
java.lang.String&nbsp;characterEncoding)</pre>
<div class="block"><p>
Use the provided <code>Writer</code> to create a new <a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context"><code>ResponseWriter</code></a> instance for the specified (optional)
content type, and character encoding.
</p>
<p>
Implementors are advised to consult the <code>getCharacterEncoding()</code> method of class
<a href="../../../jakarta/servlet/ServletResponse.html" title="interface in jakarta.servlet"><code>ServletResponse</code></a> to get the required value for the characterEncoding for this method. Since
the <code>Writer</code> for this response will already have been obtained (due to it ultimately being passed to this
method), we know that the character encoding cannot change during the rendering of the response.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writer</code> - the Writer around which this <a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context"><code>ResponseWriter</code></a> must be built.</dd>
<dd><code>contentTypeList</code> - an "Accept header style" list of content types for this response, or <code>null</code> if the
RenderKit should choose the best fit. As of the current version, the values accepted by the Standard render-kit for
this parameter include any valid "Accept header style" String that includes the String <code>text/html</code>,
<code>application/xhtml+xml</code>, <code>application/xml</code> or <code>text/xml</code>. This may change in a
future version. The RenderKit must support a value for this argument that comes straight from the <code>Accept</code>
HTTP header, and therefore requires parsing according to the specification of the <code>Accept</code> header. Please
see <a href="http://www.ietf.org/rfc/rfc2616.txt?number=2616">Section 14.1 of RFC 2616</a> for the specification of
the <code>Accept</code> header.</dd>
<dd><code>characterEncoding</code> - such as "ISO-8859-1" for this ResponseWriter, or <code>null</code> if the
<code>RenderKit</code> should choose the best fit. Please see
<a href="http://www.iana.org/assignments/character-sets">the IANA</a> for a list of character encodings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../jakarta/faces/context/ResponseWriter.html" title="class in jakarta.faces.context"><code>ResponseWriter</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if no matching content type can be found in <code>contentTypeList</code>, no
appropriate content type can be found with the implementation dependent best fit algorithm, or no matching character
encoding can be found for the argument <code>characterEncoding</code>.</dd>
</dl>
</li>
</ul>
<a name="createResponseStream-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResponseStream</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context">ResponseStream</a>&nbsp;createResponseStream(java.io.OutputStream&nbsp;out)</pre>
<div class="block"><p>
Use the provided <code>OutputStream</code> to create a new <a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context"><code>ResponseStream</code></a> instance.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the <code>OutputStream</code> around which to create the <a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context"><code>ResponseStream</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new <a href="../../../jakarta/faces/context/ResponseStream.html" title="class in jakarta.faces.context"><code>ResponseStream</code></a></dd>
</dl>
</li>
</ul>
<a name="getComponentFamilies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentFamilies</h4>
<pre>public&nbsp;java.util.Iterator&lt;java.lang.String&gt;&nbsp;getComponentFamilies()</pre>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the component-family entries supported by this <code>RenderKit</code> instance.
</p>
<p class="changed_added_2_0">
The default implementation of this method returns an empty <code>Iterator</code>
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Return an <code>Iterator</code> over the component-family entries</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getRendererTypes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRendererTypes</h4>
<pre>public&nbsp;java.util.Iterator&lt;java.lang.String&gt;&nbsp;getRendererTypes(java.lang.String&nbsp;componentFamily)</pre>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the renderer-type entries for the given component-family.
</p>
<p class="changed_added_2_0">
If the specified <code>componentFamily</code> is not known to this <code>RenderKit</code> implementation, return an
empty <code>Iterator</code>
</p>
<p class="changed_added_2_0">
The default implementation of this method returns an empty <code>Iterator</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>componentFamily</code> - one of the members of the <code>Iterator</code> returned by <a href="../../../jakarta/faces/render/RenderKit.html#getComponentFamilies--"><code>getComponentFamilies()</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> over the renderer-type</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addClientBehaviorRenderer-java.lang.String-jakarta.faces.render.ClientBehaviorRenderer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addClientBehaviorRenderer</h4>
<pre>public&nbsp;void&nbsp;addClientBehaviorRenderer(java.lang.String&nbsp;type,
<a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render">ClientBehaviorRenderer</a>&nbsp;renderer)</pre>
<div class="block"><p>
Register the specified <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance, associated with the specified component
<code>type</code>, to the set of <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a>s registered with this <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, replacing
any previously registered <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> for this type.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - type of the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> to register</dd>
<dd><code>renderer</code> - <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance we are registering</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>type</code> or <code>renderer</code> is null</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getClientBehaviorRenderer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientBehaviorRenderer</h4>
<pre>public&nbsp;<a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render">ClientBehaviorRenderer</a>&nbsp;getClientBehaviorRenderer(java.lang.String&nbsp;type)</pre>
<div class="block"><p>
Return the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance most recently registered for the specified <code>type</code>, if
any; otherwise, return <code>null</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - type of the requested <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>type</code> is <code>null</code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getClientBehaviorRendererTypes--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getClientBehaviorRendererTypes</h4>
<pre>public&nbsp;java.util.Iterator&lt;java.lang.String&gt;&nbsp;getClientBehaviorRendererTypes()</pre>
<div class="block"><p class="changed_added_2_0">
Return an <code>Iterator</code> over the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> types.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> over the <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</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/RendererWrapper.html" title="class in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/RenderKitFactory.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/RenderKit.html" target="_top">Frames</a></li>
<li><a href="RenderKit.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>Field&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>Field&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>