| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>FacesMessage</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="FacesMessage"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/application/ConfigurableNavigationHandlerWrapper.html" title="class in jakarta.faces.application"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/application/FacesMessage.html" target="_top">Frames</a></li> |
| <li><a href="FacesMessage.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.application</div> |
| <h2 title="Class FacesMessage" class="title">Class FacesMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.faces.application.FacesMessage</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">FacesMessage</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block"><p> |
| <strong>FacesMessage</strong> represents a single validation (or other) message, which is typically associated with a |
| particular component in the view. A <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> instance may be created based on a |
| specific <code>messageId</code>. The specification defines the set of <code>messageId</code>s for which there must be |
| <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> instances. |
| </p> |
| |
| <p> |
| The implementation must take the following steps when creating <code>FacesMessage</code> instances given a |
| <code>messageId</code>: |
| </p> |
| |
| <blockquote> |
| |
| <p> |
| Call <a href="../../../jakarta/faces/application/Application.html#getMessageBundle--"><code>Application.getMessageBundle()</code></a>. If non-<code>null</code>, locate the named <code>ResourceBundle</code>, |
| using the <code>Locale</code> from the current <a href="../../../jakarta/faces/component/UIViewRoot.html" title="class in jakarta.faces.component"><code>UIViewRoot</code></a> and see if it has a value |
| for the argument <code>messageId</code>. If it does, treat the value as the <code>summary</code> of the |
| <code>FacesMessage</code>. If it does not, or if <a href="../../../jakarta/faces/application/Application.html#getMessageBundle--"><code>Application.getMessageBundle()</code></a> returned <code>null</code>, |
| look in the <code>ResourceBundle</code> named by the value of the constant <a href="../../../jakarta/faces/application/FacesMessage.html#FACES_MESSAGES"><code>FACES_MESSAGES</code></a> and see if it has |
| a value for the argument <code>messageId</code>. If it does, treat the value as the <code>summary</code> of the |
| <code>FacesMessage</code>. If it does not, there is no initialization information for the <code>FacesMessage</code> |
| instance. |
| </p> |
| |
| <p> |
| In all cases, if a <code>ResourceBundle</code> hit is found for the <code>{messageId}</code>, look for further hits |
| under the key <code>{messageId}_detail</code>. Use this value, if present, as the <code>detail</code> for the |
| returned <code>FacesMessage</code>. |
| </p> |
| |
| <p> |
| Make sure to perform any parameter substitution required for the <code>summary</code> and <code>detail</code> of the |
| <code>FacesMessage</code>. |
| </p> |
| |
| </blockquote></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#jakarta.faces.application.FacesMessage">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></span></code> |
| <div class="block"> |
| Class used to represent message severity levels in a typesafe enumeration.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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"> </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/application/FacesMessage.html#FACES_MESSAGES">FACES_MESSAGES</a></span></code> |
| <div class="block"> |
| <code>ResourceBundle</code> identifier for messages whose message identifiers are defined in the Jakarta Server Faces |
| specification.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#SEVERITY_ERROR">SEVERITY_ERROR</a></span></code> |
| <div class="block"> |
| Message severity level indicating that an error has occurred.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#SEVERITY_FATAL">SEVERITY_FATAL</a></span></code> |
| <div class="block"> |
| Message severity level indicating that a serious error has occurred.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#SEVERITY_INFO">SEVERITY_INFO</a></span></code> |
| <div class="block"> |
| Message severity level indicating an informational message rather than an error.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#SEVERITY_WARN">SEVERITY_WARN</a></span></code> |
| <div class="block"> |
| Message severity level indicating that an error might have occurred.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.util.List</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#VALUES">VALUES</a></span></code> |
| <div class="block"> |
| Immutable <code>List</code> of valid <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><code>FacesMessage.Severity</code></a> instances, in ascending |
| order of their ordinal value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.util.Map</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#VALUES_MAP">VALUES_MAP</a></span></code> |
| <div class="block"> |
| Immutable <code>Map</code> of valid <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><code>FacesMessage.Severity</code></a> instances, keyed by name.</div> |
| </td> |
| </tr> |
| </table> |
| </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"> </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/application/FacesMessage.html#FacesMessage--">FacesMessage</a></span>()</code> |
| <div class="block"> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with no initial values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#FacesMessage-jakarta.faces.application.FacesMessage.Severity-java.lang.String-java.lang.String-">FacesMessage</a></span>(<a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> severity, |
| java.lang.String summary, |
| java.lang.String detail)</code> |
| <div class="block"> |
| Construct a new <code>FacesMessage</code> with the specified initial values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#FacesMessage-java.lang.String-">FacesMessage</a></span>(java.lang.String summary)</code> |
| <div class="block"> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with just a summary.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#FacesMessage-java.lang.String-java.lang.String-">FacesMessage</a></span>(java.lang.String summary, |
| java.lang.String detail)</code> |
| <div class="block"> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with the specified initial 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/application/FacesMessage.html#getDetail--">getDetail</a></span>()</code> |
| <div class="block"> |
| Return the localized detail text.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#getSeverity--">getSeverity</a></span>()</code> |
| <div class="block"> |
| Return the severity level.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#getSummary--">getSummary</a></span>()</code> |
| <div class="block"> |
| Return the localized summary text.</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/application/FacesMessage.html#isRendered--">isRendered</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#rendered--">rendered</a></span>()</code> |
| <div class="block"> |
| Marks this message as having been rendered to the client.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/application/FacesMessage.html#setDetail-java.lang.String-">setDetail</a></span>(java.lang.String detail)</code> |
| <div class="block"> |
| Set the localized detail text.</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/application/FacesMessage.html#setSeverity-jakarta.faces.application.FacesMessage.Severity-">setSeverity</a></span>(<a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> severity)</code> |
| <div class="block"> |
| Set the severity level.</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/application/FacesMessage.html#setSummary-java.lang.String-">setSummary</a></span>(java.lang.String summary)</code> |
| <div class="block"> |
| Set the localized summary text.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="FACES_MESSAGES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FACES_MESSAGES</h4> |
| <pre>public static final java.lang.String FACES_MESSAGES</pre> |
| <div class="block"><p> |
| <code>ResourceBundle</code> identifier for messages whose message identifiers are defined in the Jakarta Server Faces |
| specification. |
| </p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.faces.application.FacesMessage.FACES_MESSAGES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SEVERITY_INFO"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEVERITY_INFO</h4> |
| <pre>public static final <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> SEVERITY_INFO</pre> |
| <div class="block"><p> |
| Message severity level indicating an informational message rather than an error. |
| </p></div> |
| </li> |
| </ul> |
| <a name="SEVERITY_WARN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEVERITY_WARN</h4> |
| <pre>public static final <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> SEVERITY_WARN</pre> |
| <div class="block"><p> |
| Message severity level indicating that an error might have occurred. |
| </p></div> |
| </li> |
| </ul> |
| <a name="SEVERITY_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEVERITY_ERROR</h4> |
| <pre>public static final <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> SEVERITY_ERROR</pre> |
| <div class="block"><p> |
| Message severity level indicating that an error has occurred. |
| </p></div> |
| </li> |
| </ul> |
| <a name="SEVERITY_FATAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEVERITY_FATAL</h4> |
| <pre>public static final <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> SEVERITY_FATAL</pre> |
| <div class="block"><p> |
| Message severity level indicating that a serious error has occurred. |
| </p></div> |
| </li> |
| </ul> |
| <a name="VALUES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VALUES</h4> |
| <pre>public static final java.util.List VALUES</pre> |
| <div class="block"><p> |
| Immutable <code>List</code> of valid <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><code>FacesMessage.Severity</code></a> instances, in ascending |
| order of their ordinal value. |
| </p></div> |
| </li> |
| </ul> |
| <a name="VALUES_MAP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VALUES_MAP</h4> |
| <pre>public static final java.util.Map VALUES_MAP</pre> |
| <div class="block"><p> |
| Immutable <code>Map</code> of valid <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><code>FacesMessage.Severity</code></a> instances, keyed by name. |
| </p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FacesMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FacesMessage</h4> |
| <pre>public FacesMessage()</pre> |
| <div class="block"><p> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with no initial values. The severity is set to |
| Severity.INFO. |
| </p></div> |
| </li> |
| </ul> |
| <a name="FacesMessage-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FacesMessage</h4> |
| <pre>public FacesMessage(java.lang.String summary)</pre> |
| <div class="block"><p> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with just a summary. The detail is <code>null</code>, |
| the severity is set to <code>Severity.INFO</code>. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>summary</code> - the summary.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FacesMessage-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FacesMessage</h4> |
| <pre>public FacesMessage(java.lang.String summary, |
| java.lang.String detail)</pre> |
| <div class="block"><p> |
| Construct a new <a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application"><code>FacesMessage</code></a> with the specified initial values. The severity is set |
| to Severity.INFO. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>summary</code> - Localized summary message text</dd> |
| <dd><code>detail</code> - Localized detail message text</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the specified severity level is not one of the supported values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FacesMessage-jakarta.faces.application.FacesMessage.Severity-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FacesMessage</h4> |
| <pre>public FacesMessage(<a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> severity, |
| java.lang.String summary, |
| java.lang.String detail)</pre> |
| <div class="block"><p> |
| Construct a new <code>FacesMessage</code> with the specified initial values. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>severity</code> - the severity</dd> |
| <dd><code>summary</code> - Localized summary message text</dd> |
| <dd><code>detail</code> - Localized detail message text</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the specified severity level is not one of the supported values</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDetail--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetail</h4> |
| <pre>public java.lang.String getDetail()</pre> |
| <div class="block"><p> |
| Return the localized detail text. If no localized detail text has been defined for this message, return the localized |
| summary text instead. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the localized detail text.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDetail-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetail</h4> |
| <pre>public void setDetail(java.lang.String detail)</pre> |
| <div class="block"><p> |
| Set the localized detail text. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>detail</code> - The new localized detail text</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSeverity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSeverity</h4> |
| <pre>public <a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> getSeverity()</pre> |
| <div class="block"><p> |
| Return the severity level. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the severity level.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSeverity-jakarta.faces.application.FacesMessage.Severity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSeverity</h4> |
| <pre>public void setSeverity(<a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a> severity)</pre> |
| <div class="block"><p> |
| Set the severity level. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>severity</code> - The new severity level</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the specified severity level is not one of the supported values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSummary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSummary</h4> |
| <pre>public java.lang.String getSummary()</pre> |
| <div class="block"><p> |
| Return the localized summary text. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the localized summary text.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSummary-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSummary</h4> |
| <pre>public void setSummary(java.lang.String summary)</pre> |
| <div class="block"><p> |
| Set the localized summary text. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>summary</code> - The new localized summary text</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRendered--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRendered</h4> |
| <pre>public boolean isRendered()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if <a href="../../../jakarta/faces/application/FacesMessage.html#rendered--"><code>rendered()</code></a> has been called, otherwise <code>false</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rendered--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rendered</h4> |
| <pre>public void rendered()</pre> |
| <div class="block"><p> |
| Marks this message as having been rendered to the client. |
| </p></div> |
| <dl> |
| <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/application/ConfigurableNavigationHandlerWrapper.html" title="class in jakarta.faces.application"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/application/FacesMessage.html" target="_top">Frames</a></li> |
| <li><a href="FacesMessage.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |