blob: dec84a30410c981a95ef4f3a6e9ffd0a71203c6e [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>PreRenderComponentEvent</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="PreRenderComponentEvent";
}
}
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/event/PreRemoveFromViewEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/PreRenderViewEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/event/PreRenderComponentEvent.html" target="_top">Frames</a></li>
<li><a href="PreRenderComponentEvent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.java.util.EventObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.jakarta.faces.event.ComponentSystemEvent">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>Method</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.event</div>
<h2 title="Class PreRenderComponentEvent" class="title">Class PreRenderComponentEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.EventObject</li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">jakarta.faces.event.SystemEvent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/faces/event/ComponentSystemEvent.html" title="class in jakarta.faces.event">jakarta.faces.event.ComponentSystemEvent</a></li>
<li>
<ul class="inheritance">
<li>jakarta.faces.event.PreRenderComponentEvent</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PreRenderComponentEvent</span>
extends <a href="../../../jakarta/faces/event/ComponentSystemEvent.html" title="class in jakarta.faces.event">ComponentSystemEvent</a></pre>
<div class="block"><p class="changed_added_2_0">
When an instance of this event is passed to <a href="../../../jakarta/faces/event/SystemEventListener.html#processEvent-jakarta.faces.event.SystemEvent-"><code>SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)</code></a> or
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html#processEvent-jakarta.faces.event.ComponentSystemEvent-"><code>ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)</code></a>, the listener implementation may assume that the
<code>source</code> of this event instance is the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> instance that is about to be rendered and that
it is safe to call <a href="../../../jakarta/faces/component/UIComponent.html#getParent--"><code>UIComponent.getParent()</code></a>, <a href="../../../jakarta/faces/component/UIComponent.html#getClientId--"><code>UIComponent.getClientId()</code></a>, and other methods that depend upon
the component instance being in the view.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#jakarta.faces.event.PreRenderComponentEvent">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;java.util.EventObject</h3>
<code>source</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/PreRenderComponentEvent.html#PreRenderComponentEvent-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">PreRenderComponentEvent</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;facesContext,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</code>
<div class="block"><p class="changed_added_2_3">
Instantiate a new <code>PreRenderComponentEvent</code> that indicates the argument <code>component</code> is about to
be rendered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/PreRenderComponentEvent.html#PreRenderComponentEvent-jakarta.faces.component.UIComponent-">PreRenderComponentEvent</a></span>(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</code>
<div class="block"><p class="changed_added_2_0">
Instantiate a new <code>PreRenderComponentEvent</code> that indicates the argument <code>component</code> is about to
be rendered.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.event.ComponentSystemEvent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.faces.event.<a href="../../../jakarta/faces/event/ComponentSystemEvent.html" title="class in jakarta.faces.event">ComponentSystemEvent</a></h3>
<code><a href="../../../jakarta/faces/event/ComponentSystemEvent.html#getComponent--">getComponent</a>, <a href="../../../jakarta/faces/event/ComponentSystemEvent.html#isAppropriateListener-jakarta.faces.event.FacesListener-">isAppropriateListener</a>, <a href="../../../jakarta/faces/event/ComponentSystemEvent.html#processListener-jakarta.faces.event.FacesListener-">processListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.event.SystemEvent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.faces.event.<a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a></h3>
<code><a href="../../../jakarta/faces/event/SystemEvent.html#getFacesContext--">getFacesContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.util.EventObject</h3>
<code>getSource, toString</code></li>
</ul>
<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, 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="PreRenderComponentEvent-jakarta.faces.component.UIComponent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PreRenderComponentEvent</h4>
<pre>public&nbsp;PreRenderComponentEvent(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</pre>
<div class="block"><p class="changed_added_2_0">
Instantiate a new <code>PreRenderComponentEvent</code> that indicates the argument <code>component</code> is about to
be rendered.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>component</code> - the <code>UIComponent</code> that is about to be rendered.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the argument is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="PreRenderComponentEvent-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PreRenderComponentEvent</h4>
<pre>public&nbsp;PreRenderComponentEvent(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;facesContext,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</pre>
<div class="block"><p class="changed_added_2_3">
Instantiate a new <code>PreRenderComponentEvent</code> that indicates the argument <code>component</code> is about to
be rendered.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>facesContext</code> - the Faces context.</dd>
<dd><code>component</code> - the <code>UIComponent</code> that is about to be rendered.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the argument is <code>null</code>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/event/PreRemoveFromViewEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/PreRenderViewEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/event/PreRenderComponentEvent.html" target="_top">Frames</a></li>
<li><a href="PreRenderComponentEvent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.java.util.EventObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.jakarta.faces.event.ComponentSystemEvent">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>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>