blob: 716c6a3fed20e489b7daf1e06139bac39c705911 [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>FacesBehaviorRenderer</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="FacesBehaviorRenderer";
}
}
catch(err) {
}
//-->
</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/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/FacesRenderer.html" title="annotation 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/FacesBehaviorRenderer.html" target="_top">Frames</a></li>
<li><a href="FacesBehaviorRenderer.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>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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="Annotation Type FacesBehaviorRenderer" class="title">Annotation Type FacesBehaviorRenderer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value=TYPE)
@Inherited
public @interface <span class="memberNameLabel">FacesBehaviorRenderer</span></pre>
<div class="block"><p class="changed_added_2_0">
The presence of this annotation on a class automatically registers the class with the runtime as a <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a>.
The value of the <a href="../../../jakarta/faces/render/FacesBehaviorRenderer.html#renderKitId--"><code>renderKitId()</code></a> attribute is taken to be the <em>render-kit-id</em> to which an instance of this
<code>Renderer</code> is to be added.
There must be a public zero-argument constructor on any class where this annotation appears. The implementation must indicate a fatal error
if such a constructor does not exist and the application must not be placed in service.
Within that <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, the value of the <a href="../../../jakarta/faces/render/FacesBehaviorRenderer.html#rendererType--"><code>rendererType()</code></a> attribute is taken to be the <em>renderer-type</em>
The implementation must guarantee that for each class annotated with <code>FacesBehaviorRenderer</code>, found with the
algorithm in
section 11.4 "Annotations that correspond to and may take the place of entries in the Application Configuration Resources" of the Jakarta Faces Specification Document,
the following actions are taken.
</p>
<div class="changed_added_2_0">
<ul>
<li>
<p>
Obtain a reference to the <a href="../../../jakarta/faces/render/RenderKitFactory.html" title="class in jakarta.faces.render"><code>RenderKitFactory</code></a> for this application.
</p>
</li>
<li>
<p>
See if a <code>RenderKit</code> exists for <em>render-kit-id</em>. If so, let that instance be <em>renderKit</em> for
discussion. If not, the implementation must indicate a fatal error if such a <code>RenderKit</code> does not exist
and the application must not be placed in service.
</p>
</li>
<li>
<p>
Create an instance of this class using the public zero-argument constructor.
</p>
</li>
<li>
<p>
Call <a href="../../../jakarta/faces/render/RenderKit.html#addClientBehaviorRenderer-java.lang.String-jakarta.faces.render.ClientBehaviorRenderer-"><code>RenderKit.addClientBehaviorRenderer(java.lang.String, jakarta.faces.render.ClientBehaviorRenderer)</code></a> on <em>renderKit</em>, passing <em>type</em> as the first argument,
and a <a href="../../../jakarta/faces/render/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><code>ClientBehaviorRenderer</code></a> instance as the second argument.
</p>
</li>
</ul>
</div></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.required.element.summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/FacesBehaviorRenderer.html#rendererType--">rendererType</a></span></code>
<div class="block">Within the <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, the value of this annotation attribute is
taken to be the <em>renderer-type</em></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/render/FacesBehaviorRenderer.html#renderKitId--">renderKitId</a></span></code>
<div class="block"><p class="changed_added_2_0">
The value of this annotation attribute is taken to be the <em>render-kit-id</em> in which an instance of this class
of <code>Renderer</code> must be installed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="rendererType--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rendererType</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;rendererType</pre>
<div class="block">Within the <a href="../../../jakarta/faces/render/RenderKit.html" title="class in jakarta.faces.render"><code>RenderKit</code></a>, the value of this annotation attribute is
taken to be the <em>renderer-type</em></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <em>renderer-type</em></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="renderKitId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>renderKitId</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;renderKitId</pre>
<div class="block"><p class="changed_added_2_0">
The value of this annotation attribute is taken to be the <em>render-kit-id</em> in which an instance of this class
of <code>Renderer</code> must be installed.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <em>render-kit-id</em></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"HTML_BASIC"</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/ClientBehaviorRenderer.html" title="class in jakarta.faces.render"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/render/FacesRenderer.html" title="annotation 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/FacesBehaviorRenderer.html" target="_top">Frames</a></li>
<li><a href="FacesBehaviorRenderer.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>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>