Google Git
Sign in
apache / tomee-site-pub / 5029b2533c3906b5c1f8300fff30ee925acf2c30 / . / jakartaee-10.0 / javadoc / jakarta / faces / component / UIMessages.html
blob: 5829232ed712cd1dad54715cca66e0d2204f6ca8 [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>UIMessages</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="UIMessages";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/component/UIMessage.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/component/UINamingContainer.html" title="class in jakarta.faces.component"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/component/UIMessages.html" target="_top">Frames</a></li>
<li><a href="UIMessages.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.faces.component</div>
<h2 title="Class UIMessages" class="title">Class UIMessages</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">jakarta.faces.component.UIComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">jakarta.faces.component.UIComponentBase</a></li>
<li>
<ul class="inheritance">
<li>jakarta.faces.component.UIMessages</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component">PartialStateHolder</a>, <a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component">StateHolder</a>, <a href="../../../jakarta/faces/component/TransientStateHolder.html" title="interface in jakarta.faces.component">TransientStateHolder</a>, <a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>, <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>, <a href="../../../jakarta/faces/event/SystemEventListenerHolder.html" title="interface in jakarta.faces.event">SystemEventListenerHolder</a>, java.util.EventListener</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../jakarta/faces/component/html/HtmlMessages.html" title="class in jakarta.faces.component.html">HtmlMessages</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UIMessages</span>
extends <a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></pre>
<div class="block"><p>
The renderer for this component is responsible for obtaining the messages from the <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> and
displaying them to the user.
</p>
<p>
This component supports the <code>Messages</code> renderer-type.
</p>
<p>
By default, the <code>rendererType</code> property must be set to "<code>jakarta.faces.Messages</code>". This value
can be changed by calling the <code>setRendererType()</code> method.
</p></div>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#COMPONENT_FAMILY">COMPONENT_FAMILY</a></span></code>
<div class="block">
The standard component family for this component.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#COMPONENT_TYPE">COMPONENT_TYPE</a></span></code>
<div class="block">
The standard component type for this component.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.jakarta.faces.component.UIComponent">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></h3>
<code><a href="../../../jakarta/faces/component/UIComponent.html#ATTRS_WITH_DECLARED_DEFAULT_VALUES">ATTRS_WITH_DECLARED_DEFAULT_VALUES</a>, <a href="../../../jakarta/faces/component/UIComponent.html#BEANINFO_KEY">BEANINFO_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#bindings">bindings</a>, <a href="../../../jakarta/faces/component/UIComponent.html#COMPOSITE_COMPONENT_TYPE_KEY">COMPOSITE_COMPONENT_TYPE_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#COMPOSITE_FACET_NAME">COMPOSITE_FACET_NAME</a>, <a href="../../../jakarta/faces/component/UIComponent.html#FACETS_KEY">FACETS_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#VIEW_LOCATION_KEY">VIEW_LOCATION_KEY</a></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/component/UIMessages.html#UIMessages--">UIMessages</a></span>()</code>
<div class="block">
Create a new <a href="../../../jakarta/faces/component/UIMessages.html" title="class in jakarta.faces.component"><code>UIMessages</code></a> instance with default property values.</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="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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#getFamily--">getFamily</a></span>()</code>
<div class="block"><p class="changed_modified_2_3">
Return the identifier of the component family to which this component belongs.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#getFor--">getFor</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
Return the client identifier of the component for which this component represents associated message(s) (if any).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#isGlobalOnly--">isGlobalOnly</a></span>()</code>
<div class="block">
Return the flag indicating whether only global messages (that is, messages with no associated client identifier)
should be rendered.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#isRedisplay--">isRedisplay</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#isShowDetail--">isShowDetail</a></span>()</code>
<div class="block">
Return the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#isShowSummary--">isShowSummary</a></span>()</code>
<div class="block">
Return the flag indicating whether the <code>summary</code> property of the associated message(s) should be
displayed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#setFor-java.lang.String-">setFor</a></span>(java.lang.String&nbsp;newFor)</code>
<div class="block">
Set the client identifier of the component for which this component represents associated message(s) (if any).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#setGlobalOnly-boolean-">setGlobalOnly</a></span>(boolean&nbsp;globalOnly)</code>
<div class="block">
Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should
be rendered.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#setRedisplay-boolean-">setRedisplay</a></span>(boolean&nbsp;redisplay)</code>
<div class="block">
Set the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#setShowDetail-boolean-">setShowDetail</a></span>(boolean&nbsp;showDetail)</code>
<div class="block">
Set the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIMessages.html#setShowSummary-boolean-">setShowSummary</a></span>(boolean&nbsp;showSummary)</code>
<div class="block">
Set the flag indicating whether the <code>summary</code> property of the associated message(s) should be displayed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.component.UIComponentBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></h3>
<code><a href="../../../jakarta/faces/component/UIComponentBase.html#addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-">addClientBehavior</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#addFacesListener-jakarta.faces.event.FacesListener-">addFacesListener</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#broadcast-jakarta.faces.event.FacesEvent-">broadcast</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#clearInitialState--">clearInitialState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#decode-jakarta.faces.context.FacesContext-">decode</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeBegin-jakarta.faces.context.FacesContext-">encodeBegin</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeChildren-jakarta.faces.context.FacesContext-">encodeChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeEnd-jakarta.faces.context.FacesContext-">encodeEnd</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#findComponent-java.lang.String-">findComponent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getAttributes--">getAttributes</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getChildCount--">getChildCount</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getChildren--">getChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getClientBehaviors--">getClientBehaviors</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getClientId-jakarta.faces.context.FacesContext-">getClientId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getDefaultEventName--">getDefaultEventName</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getEventNames--">getEventNames</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesContext--">getFacesContext</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesListeners-java.lang.Class-">getFacesListeners</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacet-java.lang.String-">getFacet</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetCount--">getFacetCount</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacets--">getFacets</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetsAndChildren--">getFacetsAndChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getId--">getId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getListenersForEventClass-java.lang.Class-">getListenersForEventClass</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getParent--">getParent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getPassThroughAttributes-boolean-">getPassThroughAttributes</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRenderer-jakarta.faces.context.FacesContext-">getRenderer</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRendererType--">getRendererType</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRendersChildren--">getRendersChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">invokeOnComponent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#isRendered--">isRendered</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#isTransient--">isTransient</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#markInitialState--">markInitialState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processDecodes-jakarta.faces.context.FacesContext-">processDecodes</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">processRestoreState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processSaveState-jakarta.faces.context.FacesContext-">processSaveState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processUpdates-jakarta.faces.context.FacesContext-">processUpdates</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processValidators-jakarta.faces.context.FacesContext-">processValidators</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#queueEvent-jakarta.faces.event.FacesEvent-">queueEvent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#removeFacesListener-jakarta.faces.event.FacesListener-">removeFacesListener</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#restoreAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreAttachedState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#restoreState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">saveAttachedState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#saveState-jakarta.faces.context.FacesContext-">saveState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setId-java.lang.String-">setId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setParent-jakarta.faces.component.UIComponent-">setParent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setRendered-boolean-">setRendered</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setRendererType-java.lang.String-">setRendererType</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setTransient-boolean-">setTransient</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#subscribeToEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">subscribeToEvent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#unsubscribeFromEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">unsubscribeFromEvent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.component.UIComponent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></h3>
<code><a href="../../../jakarta/faces/component/UIComponent.html#encodeAll-jakarta.faces.context.FacesContext-">encodeAll</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getClientId--">getClientId</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCompositeComponentParent-jakarta.faces.component.UIComponent-">getCompositeComponentParent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getContainerClientId-jakarta.faces.context.FacesContext-">getContainerClientId</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCurrentComponent-jakarta.faces.context.FacesContext-">getCurrentComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCurrentCompositeComponent-jakarta.faces.context.FacesContext-">getCurrentCompositeComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getNamingContainer--">getNamingContainer</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes--">getPassThroughAttributes</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getResourceBundleMap--">getResourceBundleMap</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getStateHelper--">getStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getStateHelper-boolean-">getStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper--">getTransientStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper-boolean-">getTransientStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getValueExpression-java.lang.String-">getValueExpression</a>, <a href="../../../jakarta/faces/component/UIComponent.html#initialStateMarked--">initialStateMarked</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isCompositeComponent-jakarta.faces.component.UIComponent-">isCompositeComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isInView--">isInView</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isVisitable-jakarta.faces.component.visit.VisitContext-">isVisitable</a>, <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-">popComponentFromEL</a>, <a href="../../../jakarta/faces/component/UIComponent.html#processEvent-jakarta.faces.event.ComponentSystemEvent-">processEvent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#pushComponentToEL-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">pushComponentToEL</a>, <a href="../../../jakarta/faces/component/UIComponent.html#restoreTransientState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreTransientState</a>, <a href="../../../jakarta/faces/component/UIComponent.html#saveTransientState-jakarta.faces.context.FacesContext-">saveTransientState</a>, <a href="../../../jakarta/faces/component/UIComponent.html#setInView-boolean-">setInView</a>, <a href="../../../jakarta/faces/component/UIComponent.html#setValueExpression-java.lang.String-jakarta.el.ValueExpression-">setValueExpression</a>, <a href="../../../jakarta/faces/component/UIComponent.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">visitTree</a></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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="COMPONENT_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPONENT_TYPE</h4>
<pre>public static final&nbsp;java.lang.String COMPONENT_TYPE</pre>
<div class="block"><p>
The standard component type for this component.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#jakarta.faces.component.UIMessages.COMPONENT_TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="COMPONENT_FAMILY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>COMPONENT_FAMILY</h4>
<pre>public static final&nbsp;java.lang.String COMPONENT_FAMILY</pre>
<div class="block"><p>
The standard component family for this component.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#jakarta.faces.component.UIMessages.COMPONENT_FAMILY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UIMessages--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UIMessages</h4>
<pre>public&nbsp;UIMessages()</pre>
<div class="block"><p>
Create a new <a href="../../../jakarta/faces/component/UIMessages.html" title="class in jakarta.faces.component"><code>UIMessages</code></a> instance with default property values.
</p></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamily</h4>
<pre>public&nbsp;java.lang.String&nbsp;getFamily()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFamily--">UIComponent</a></code></span></div>
<div class="block"><p class="changed_modified_2_3">
Return the identifier of the component family to which this component belongs. This identifier, in conjunction with
the value of the <code>rendererType</code> property, may be used to select the appropriate <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> for this
component instance. Note this method should NOT return <code>null</code>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFamily--">getFamily</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the component family (not null).</dd>
</dl>
</li>
</ul>
<a name="getFor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFor</h4>
<pre>public&nbsp;java.lang.String&nbsp;getFor()</pre>
<div class="block"><p class="changed_added_2_0">
Return the client identifier of the component for which this component represents associated message(s) (if any).
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the for client identifier.</dd>
</dl>
</li>
</ul>
<a name="setFor-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFor</h4>
<pre>public&nbsp;void&nbsp;setFor(java.lang.String&nbsp;newFor)</pre>
<div class="block"><p>
Set the client identifier of the component for which this component represents associated message(s) (if any). This
property must be set before the message is displayed.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newFor</code> - The new client id</dd>
</dl>
</li>
</ul>
<a name="isGlobalOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGlobalOnly</h4>
<pre>public&nbsp;boolean&nbsp;isGlobalOnly()</pre>
<div class="block"><p>
Return the flag indicating whether only global messages (that is, messages with no associated client identifier)
should be rendered. Mutually exclusive with the "for" property which takes precedence. Defaults to false.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if only global messages are to be shown, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="setGlobalOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGlobalOnly</h4>
<pre>public&nbsp;void&nbsp;setGlobalOnly(boolean&nbsp;globalOnly)</pre>
<div class="block"><p>
Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should
be rendered.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>globalOnly</code> - The new flag value</dd>
</dl>
</li>
</ul>
<a name="isShowDetail--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShowDetail</h4>
<pre>public&nbsp;boolean&nbsp;isShowDetail()</pre>
<div class="block"><p>
Return the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.
Defaults to false.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if detail is to be shown, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="setShowDetail-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShowDetail</h4>
<pre>public&nbsp;void&nbsp;setShowDetail(boolean&nbsp;showDetail)</pre>
<div class="block"><p>
Set the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>showDetail</code> - The new flag</dd>
</dl>
</li>
</ul>
<a name="isShowSummary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShowSummary</h4>
<pre>public&nbsp;boolean&nbsp;isShowSummary()</pre>
<div class="block"><p>
Return the flag indicating whether the <code>summary</code> property of the associated message(s) should be
displayed. Defaults to true.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the summary is to be shown, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="setShowSummary-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShowSummary</h4>
<pre>public&nbsp;void&nbsp;setShowSummary(boolean&nbsp;showSummary)</pre>
<div class="block"><p>
Set the flag indicating whether the <code>summary</code> property of the associated message(s) should be displayed.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>showSummary</code> - The new flag value</dd>
</dl>
</li>
</ul>
<a name="isRedisplay--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRedisplay</h4>
<pre>public&nbsp;boolean&nbsp;isRedisplay()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this <code>UIMessage</code> instance should redisplay
<a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a>s that have already been handled, otherwise returns <code>false</code>.
By default this method will always return <code>true</code> if <a href="../../../jakarta/faces/component/UIMessages.html#setRedisplay-boolean-"><code>setRedisplay(boolean)</code></a> has not been called.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setRedisplay-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setRedisplay</h4>
<pre>public&nbsp;void&nbsp;setRedisplay(boolean&nbsp;redisplay)</pre>
<div class="block"><p>
Set the flag indicating whether the <code>detail</code> property of the associated message(s) should be displayed.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>redisplay</code> - flag indicating whether previously handled messages are redisplayed or not</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/component/UIMessage.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/component/UINamingContainer.html" title="class in jakarta.faces.component"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/component/UIMessages.html" target="_top">Frames</a></li>
<li><a href="UIMessages.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>