blob: 3e13a9280d31bef64a14396503eae4730c3e3fdb [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>PartialViewContextFactory</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="PartialViewContextFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10};
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="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/faces/context/PartialViewContextWrapper.html" title="class in javax.faces.context"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/faces/context/PartialViewContextFactory.html" target="_top">Frames</a></li>
<li><a href="PartialViewContextFactory.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">javax.faces.context</div>
<h2 title="Class PartialViewContextFactory" class="title">Class PartialViewContextFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.faces.context.PartialViewContextFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../javax/faces/FacesWrapper.html" title="interface in javax.faces">FacesWrapper</a>&lt;<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">PartialViewContextFactory</span>
extends java.lang.Object
implements <a href="../../../javax/faces/FacesWrapper.html" title="interface in javax.faces">FacesWrapper</a>&lt;<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&gt;</pre>
<div class="block"><p class="changed_modified_2_0"><span class="changed_modified_2_3">PartialViewContextFactory</span> is a
factory object that creates (if needed) and returns new <a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><code>PartialViewContext</code></a> instances.</p>
<div class="changed_added_2_0">
<p>There must be one <code>PartialViewContextFactory</code> instance per web
application that is utilizing Jakarta Server Faces. This instance can be
acquired, in a portable manner, by calling:</p>
<pre>
PartialViewContextFactory factory = (PartialViewContextFactory)
FactoryFinder.getFactory(FactoryFinder.PARTIAL_VIEW_CONTEXT_FACTORY);
</pre>
</div>
<p class="changed_added_2_3">Usage: extend this class and push the implementation being wrapped to the
constructor and use <a href="../../../javax/faces/context/PartialViewContextFactory.html#getWrapped--"><code>getWrapped()</code></a> to access the instance being wrapped.</p></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">
<!-- ======== 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="../../../javax/faces/context/PartialViewContextFactory.html#PartialViewContextFactory--">PartialViewContextFactory</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use the other constructor taking the implementation being wrapped.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/faces/context/PartialViewContextFactory.html#PartialViewContextFactory-javax.faces.context.PartialViewContextFactory-">PartialViewContextFactory</a></span>(<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&nbsp;wrapped)</code>
<div class="block"><p class="changed_added_2_3">If this factory has been decorated,
the implementation doing the decorating should push the implementation being wrapped to this constructor.</div>
</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>abstract <a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context">PartialViewContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/faces/context/PartialViewContextFactory.html#getPartialViewContext-javax.faces.context.FacesContext-">getPartialViewContext</a></span>(<a href="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block"><span class="changed_modified_2_0">Create</span> (if needed)
and return a <a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><code>PartialViewContext</code></a> instance that is initialized
using the current <a href="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context"><code>FacesContext</code></a> instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/faces/context/PartialViewContextFactory.html#getWrapped--">getWrapped</a></span>()</code>
<div class="block"><p class="changed_modified_2_3">If this factory has been decorated, the
implementation doing the decorating may override this method to provide
access to the implementation being wrapped.</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="PartialViewContextFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PartialViewContextFactory</h4>
<pre>@Deprecated
public&nbsp;PartialViewContextFactory()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use the other constructor taking the implementation being wrapped.</span></div>
</li>
</ul>
<a name="PartialViewContextFactory-javax.faces.context.PartialViewContextFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PartialViewContextFactory</h4>
<pre>public&nbsp;PartialViewContextFactory(<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&nbsp;wrapped)</pre>
<div class="block"><p class="changed_added_2_3">If this factory has been decorated,
the implementation doing the decorating should push the implementation being wrapped to this constructor.
The <a href="../../../javax/faces/context/PartialViewContextFactory.html#getWrapped--"><code>getWrapped()</code></a> will then return the implementation being wrapped.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wrapped</code> - The implementation being wrapped.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getWrapped--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrapped</h4>
<pre>public&nbsp;<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&nbsp;getWrapped()</pre>
<div class="block"><p class="changed_modified_2_3">If this factory has been decorated, the
implementation doing the decorating may override this method to provide
access to the implementation being wrapped.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../javax/faces/FacesWrapper.html#getWrapped--">getWrapped</a></code>&nbsp;in interface&nbsp;<code><a href="../../../javax/faces/FacesWrapper.html" title="interface in javax.faces">FacesWrapper</a>&lt;<a href="../../../javax/faces/context/PartialViewContextFactory.html" title="class in javax.faces.context">PartialViewContextFactory</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the wrapped instance.</dd>
</dl>
</li>
</ul>
<a name="getPartialViewContext-javax.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPartialViewContext</h4>
<pre>public abstract&nbsp;<a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context">PartialViewContext</a>&nbsp;getPartialViewContext(<a href="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><p><span class="changed_modified_2_0">Create</span> (if needed)
and return a <a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><code>PartialViewContext</code></a> instance that is initialized
using the current <a href="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context"><code>FacesContext</code></a> instance.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the <a href="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context"><code>FacesContext</code></a> for the current request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><code>PartialViewContext</code></a> as specified above</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="../../../javax/faces/context/PartialViewContext.html" title="class in javax.faces.context"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/faces/context/PartialViewContextWrapper.html" title="class in javax.faces.context"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/faces/context/PartialViewContextFactory.html" target="_top">Frames</a></li>
<li><a href="PartialViewContextFactory.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>