Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/StateAwareResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/StateAwareResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/StateAwareResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/StateAwareResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,205 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface javax.portlet.StateAwareResponse (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Interface javax.portlet.StateAwareResponse (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/StateAwareResponse.html" target="_top">Frames</a></li> +<li><a href="StateAwareResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface javax.portlet.StateAwareResponse" class="title">Uses of Interface<br>javax.portlet.StateAwareResponse</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#javax.portlet">javax.portlet</a></td> +<td class="colLast"> +<div class="block">The javax.portlet package defines the API for Java Portlet Specification V2.0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#javax.portlet.filter">javax.portlet.filter</a></td> +<td class="colLast"> +<div class="block">The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="javax.portlet"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a> in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a> in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a></strong></code> +<div class="block">The <CODE>ActionResponse</CODE> interface represents the portlet + response to an action request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</a></strong></code> +<div class="block">The <CODE>EventResponse</CODE> interface represents the portlet + response to an event request.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="javax.portlet.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a> in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a> that implement <a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">StateAwareResponse</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</a></strong></code> +<div class="block">The <code>ActionResponseWrapper</code> provides a convenient + implementation of the <code>ActionResponse</code> interface + that can be subclassed by developers wishing to adapt the response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</a></strong></code> +<div class="block">The <code>EventResponseWrapper</code> provides a convenient + implementation of the <code>EventResponse</code> interface + that can be subclassed by developers wishing to adapt the response.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/StateAwareResponse.html" target="_top">Frames</a></li> +<li><a href="StateAwareResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/UnavailableException.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/UnavailableException.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/UnavailableException.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/UnavailableException.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class javax.portlet.UnavailableException (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class javax.portlet.UnavailableException (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../javax/portlet/UnavailableException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/UnavailableException.html" target="_top">Frames</a></li> +<li><a href="UnavailableException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class javax.portlet.UnavailableException" class="title">Uses of Class<br>javax.portlet.UnavailableException</h2> +</div> +<div class="classUseContainer">No usage of javax.portlet.UnavailableException</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../javax/portlet/UnavailableException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/UnavailableException.html" target="_top">Frames</a></li> +<li><a href="UnavailableException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/ValidatorException.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/ValidatorException.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/ValidatorException.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/ValidatorException.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,169 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class javax.portlet.ValidatorException (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class javax.portlet.ValidatorException (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../javax/portlet/ValidatorException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/ValidatorException.html" target="_top">Frames</a></li> +<li><a href="ValidatorException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class javax.portlet.ValidatorException" class="title">Uses of Class<br>javax.portlet.ValidatorException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../javax/portlet/ValidatorException.html" title="class in javax.portlet">ValidatorException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#javax.portlet">javax.portlet</a></td> +<td class="colLast"> +<div class="block">The javax.portlet package defines the API for Java Portlet Specification V2.0.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="javax.portlet"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/ValidatorException.html" title="class in javax.portlet">ValidatorException</a> in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> that throw <a href="../../../javax/portlet/ValidatorException.html" title="class in javax.portlet">ValidatorException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">PortletPreferences.</span><code><strong><a href="../../../javax/portlet/PortletPreferences.html#store()">store</a></strong>()</code> +<div class="block">Commits all changes made to the preferences via the + <code>set</code> methods in the persistent store.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">PreferencesValidator.</span><code><strong><a href="../../../javax/portlet/PreferencesValidator.html#validate(javax.portlet.PortletPreferences)">validate</a></strong>(<a href="../../../javax/portlet/PortletPreferences.html" title="interface in javax.portlet">PortletPreferences</a> preferences)</code> +<div class="block">If the preferences values are successfully validated the call to this method + must finish gracefully.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../javax/portlet/ValidatorException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/ValidatorException.html" target="_top">Frames</a></li> +<li><a href="ValidatorException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowState.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowState.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowState.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowState.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,363 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class javax.portlet.WindowState (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class javax.portlet.WindowState (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/WindowState.html" target="_top">Frames</a></li> +<li><a href="WindowState.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class javax.portlet.WindowState" class="title">Uses of Class<br>javax.portlet.WindowState</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#javax.portlet">javax.portlet</a></td> +<td class="colLast"> +<div class="block">The javax.portlet package defines the API for Java Portlet Specification V2.0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#javax.portlet.filter">javax.portlet.filter</a></td> +<td class="colLast"> +<div class="block">The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="javax.portlet"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation"> +<caption><span>Fields in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> declared as <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">WindowState.</span><code><strong><a href="../../../javax/portlet/WindowState.html#MAXIMIZED">MAXIMIZED</a></strong></code> +<div class="block">The <code>MAXIMIZED</code> window state is an indication + that a portlet may be the only portlet being rendered in the + portal page, or that the portlet has more space compared to other portlets + in the portal page.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">WindowState.</span><code><strong><a href="../../../javax/portlet/WindowState.html#MINIMIZED">MINIMIZED</a></strong></code> +<div class="block">When a portlet is in <code>MINIMIZED</code> window state, + the portlet should only render minimal output or no output at all.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">WindowState.</span><code><strong><a href="../../../javax/portlet/WindowState.html#NORMAL">NORMAL</a></strong></code> +<div class="block">The <code>NORMAL</code> window state indicates that a portlet + may be sharing the page with other portlets.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> that return <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">WindowStateException.</span><code><strong><a href="../../../javax/portlet/WindowStateException.html#getState()">getState</a></strong>()</code> +<div class="block">Returns the portlet state causing this exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">StateAwareResponse.</span><code><strong><a href="../../../javax/portlet/StateAwareResponse.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the currently set window state on this response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">PortletURL.</span><code><strong><a href="../../../javax/portlet/PortletURL.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the currently set window state on this PortletURL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">PortletRequest.</span><code><strong><a href="../../../javax/portlet/PortletRequest.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the current window state of the portlet.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> that return types with arguments of type <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</a><<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a>></code></td> +<td class="colLast"><span class="strong">PortalContext.</span><code><strong><a href="../../../javax/portlet/PortalContext.html#getSupportedWindowStates()">getSupportedWindowStates</a></strong>()</code> +<div class="block">Returns all supported window states by the portal + as an enumeration of <code>WindowState</code> objects.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> with parameters of type <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">PortletRequest.</span><code><strong><a href="../../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">Returns true, if the given window state is valid + to be set for this portlet in the context + of the current request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StateAwareResponse.</span><code><strong><a href="../../../javax/portlet/StateAwareResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Sets the window state of a portlet to the given window state.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">PortletURL.</span><code><strong><a href="../../../javax/portlet/PortletURL.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Indicates the window state the portlet should be in, if this + portlet URL triggers a request.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> with parameters of type <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../javax/portlet/WindowStateException.html#WindowStateException(java.lang.String,%20java.lang.Throwable,%20javax.portlet.WindowState)">WindowStateException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">Constructs a new portlet state exception when the portlet needs to do + the following: + + <il>throw an exception + include a message about the "root cause" that interfered + with its normal operation + include a description message + </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../javax/portlet/WindowStateException.html#WindowStateException(java.lang.String,%20javax.portlet.WindowState)">WindowStateException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text, + <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">Constructs a new portlet state exception with the given text.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../javax/portlet/WindowStateException.html#WindowStateException(java.lang.Throwable,%20javax.portlet.WindowState)">WindowStateException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">Constructs a new portlet state exception when the portlet needs to throw an + exception.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="javax.portlet.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a> that return <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">PortletRequestWrapper.</span><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWindowState()</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">EventResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/EventResponseWrapper.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWindowState()</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><span class="strong">ActionResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/ActionResponseWrapper.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">The default behavior of this method is to call + <code>getWindowState()</code> on the wrapped response object.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a> with parameters of type <a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">PortletRequestWrapper.</span><code><strong><a href="../../../javax/portlet/filter/PortletRequestWrapper.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> state)</code> +<div class="block">The default behavior of this method is to call + <code>isWindowStateAllowed(state)</code> on the wrapped request object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EventResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/EventResponseWrapper.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">The default behavior of this method is to call + <code>setWindowState(windowState)</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ActionResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/ActionResponseWrapper.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">The default behavior of this method is to call + <code>setWindowState(windowState)</code> on the wrapped response object.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/WindowState.html" target="_top">Frames</a></li> +<li><a href="WindowState.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowStateException.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowStateException.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowStateException.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/class-use/WindowStateException.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,202 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class javax.portlet.WindowStateException (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class javax.portlet.WindowStateException (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/WindowStateException.html" target="_top">Frames</a></li> +<li><a href="WindowStateException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class javax.portlet.WindowStateException" class="title">Uses of Class<br>javax.portlet.WindowStateException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#javax.portlet">javax.portlet</a></td> +<td class="colLast"> +<div class="block">The javax.portlet package defines the API for Java Portlet Specification V2.0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#javax.portlet.filter">javax.portlet.filter</a></td> +<td class="colLast"> +<div class="block">The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="javax.portlet"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a> in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/package-summary.html">javax.portlet</a> that throw <a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StateAwareResponse.</span><code><strong><a href="../../../javax/portlet/StateAwareResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Sets the window state of a portlet to the given window state.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">PortletURL.</span><code><strong><a href="../../../javax/portlet/PortletURL.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Indicates the window state the portlet should be in, if this + portlet URL triggers a request.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="javax.portlet.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a> in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../javax/portlet/filter/package-summary.html">javax.portlet.filter</a> that throw <a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">WindowStateException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EventResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/EventResponseWrapper.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">The default behavior of this method is to call + <code>setWindowState(windowState)</code> on the wrapped response object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ActionResponseWrapper.</span><code><strong><a href="../../../javax/portlet/filter/ActionResponseWrapper.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">The default behavior of this method is to call + <code>setWindowState(windowState)</code> on the wrapped response object.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../javax/portlet/WindowStateException.html" title="class in javax.portlet">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/class-use/WindowStateException.html" target="_top">Frames</a></li> +<li><a href="WindowStateException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ActionFilter.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ActionFilter.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ActionFilter.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/filter/ActionFilter.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,297 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ActionFilter (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ActionFilter (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ActionFilter.html">Use</a></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>Prev Class</li> +<li><a href="../../../javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/ActionFilter.html" target="_top">Frames</a></li> +<li><a href="ActionFilter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.portlet.filter</div> +<h2 title="Interface ActionFilter" class="title">Interface ActionFilter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ActionFilter</span> +extends <a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></pre> +<div class="block">The <code>ActionFilter</code> is an object that performs filtering + tasks on either the action request to a portlet, or on the action response from + a portlet, or both. + <p> + Filters perform filtering in the <code>doFilter</code> method. Every Filter has + access to a <code>FilterConfig</code> object from which it can obtain + its initialization parameters, a reference to the PortletContext + which it can use, for example, to load resources needed for filtering tasks. + <p> + Filters are configured in the portlet deployment descriptor of a + portlet application.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/portlet/filter/ActionFilter.html#doFilter(javax.portlet.ActionRequest,%20javax.portlet.ActionResponse,%20javax.portlet.filter.FilterChain)">doFilter</a></strong>(<a href="../../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response, + <a href="../../../javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a> chain)</code> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a action request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.filter.PortletFilter"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.filter.<a href="../../../javax/portlet/filter/PortletFilter.html" title="interface in javax.portlet.filter">PortletFilter</a></h3> +<code><a href="../../../javax/portlet/filter/PortletFilter.html#destroy()">destroy</a>, <a href="../../../javax/portlet/filter/PortletFilter.html#init(javax.portlet.filter.FilterConfig)">init</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="doFilter(javax.portlet.ActionRequest, javax.portlet.ActionResponse, javax.portlet.filter.FilterChain)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doFilter</h4> +<pre>void doFilter(<a href="../../../javax/portlet/ActionRequest.html" title="interface in javax.portlet">ActionRequest</a> request, + <a href="../../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</a> response, + <a href="../../../javax/portlet/filter/FilterChain.html" title="interface in javax.portlet.filter">FilterChain</a> chain) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">The <code>doFilter</code> method of the Filter is called by the + portlet container each time a action request/response pair is passed + through the chain due to a client request for a portlet method + at the end of the chain. + <p> + The <code>FilterChain</code> passed in to this method allows + the Filter to pass on the action request and response to the next + component in the chain. + <p> + The <code>doFilter</code> method of a filter will typically be implemented + following this or some subset of the following pattern: + <ul> + <li>The method examines the request information.</li> + <li>The method may wrap the request object passed in to + its doFilter method with a customized implementation + the request wrapper <code>ActionRequestWrapper</code> + in order to modify request data.</li> + <li>The method may wrap the response object passed in to its + <code>doFilter</code> method with a customized implementation + of the response wrapper <code>ActionResponseWrapper</code> + to modify response data.</li> + <li>The filter may invoke the next component in the filter chain. + The next component may be another filter, or if the filter + making the invocation is the last filter configured in the + deployment descriptor for this chain, the next component + is the target method of the portlet. The invocation of the + next component is effected by calling the <code>doFilter</code> + method on the <code>FilterChain</code> object, and passing in + the request and response with which it was called or passing + in wrapped versions it may have created. + The filter chain's implementation of the <code>doFilter</code> + method, provided by the portlet container, must locate the + next component in the filter chain and invoke its <code>doFilter</code> + method, passing in the appropriate request and response objects. + Alternatively, the filter chain can block the request by not + making the call to invoke the next component, leaving the filter + responsible for filling out the response object.</li> + <li>After invocation of the next filter in the chain, the filter + may examine the response data.</li> + <li>Alternatively, the filter may have thrown an exception to + indicate an error in processing. If the filter throws an + <code>UnavailableException</code> during its <code>doFilter</code> + processing, the portlet container must not attempt continued + processing down the filter chain. It may choose to retry the + whole chain at a later time if the exception is not marked permanent.</li> + <li>When the last filter in the chain has been invoked, the next + component accessed is the target method on the portlet at + the end of the chain.</li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the current action request</dd><dd><code>response</code> - the current action response</dd><dd><code>chain</code> - the remaining filter chain</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an IO error occurred in the filter processing</dd> +<dd><code><a href="../../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></code> - if a portlet exception occurred in the filter processing</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ActionFilter.html">Use</a></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>Prev Class</li> +<li><a href="../../../javax/portlet/filter/ActionRequestWrapper.html" title="class in javax.portlet.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/portlet/filter/ActionFilter.html" target="_top">Frames</a></li> +<li><a href="ActionFilter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
