blob: 15fce1e535b3bfa3e6f4afa2e3660628dd67e999 [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>LocaleSupport</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="LocaleSupport";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev&nbsp;Class</li>
<li><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocalizationContext.html" title="class in jakarta.servlet.jsp.jstl.fmt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html" target="_top">Frames</a></li>
<li><a href="LocaleSupport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.servlet.jsp.jstl.fmt</div>
<h2 title="Class LocaleSupport" class="title">Class LocaleSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.servlet.jsp.jstl.fmt.LocaleSupport</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">LocaleSupport</span>
extends java.lang.Object</pre>
<div class="block">Class which exposes the locale-determination logic for resource bundles through convenience methods.
<p>
This class may be useful to any tag handler implementation that needs to produce localized messages. For example,
this might be useful for exception messages that are intended directly for user consumption on an error page.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#LocaleSupport--">LocaleSupport</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-">getLocalizedMessage</a></span>(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key)</code>
<div class="block">Retrieves the localized message corresponding to the given key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.Object:A-">getLocalizedMessage</a></span>(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.Object[]&nbsp;args)</code>
<div class="block">Retrieves the localized message corresponding to the given key, and performs parametric replacement using the
arguments specified via <tt>args</tt>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.Object:A-java.lang.String-">getLocalizedMessage</a></span>(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.Object[]&nbsp;args,
java.lang.String&nbsp;basename)</code>
<div class="block">Retrieves the localized message corresponding to the given key, and performs parametric replacement using the
arguments specified via <tt>args</tt>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.String-">getLocalizedMessage</a></span>(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.String&nbsp;basename)</code>
<div class="block">Retrieves the localized message corresponding to the given key.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LocaleSupport--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LocaleSupport</h4>
<pre>public&nbsp;LocaleSupport()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalizedMessage</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getLocalizedMessage(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key)</pre>
<div class="block">Retrieves the localized message corresponding to the given key.
<p>
The given key is looked up in the resource bundle of the default I18N localization context, which is retrieved from
the <tt>jakarta.servlet.jsp.jstl.fmt.localizationContext</tt> configuration setting.
<p>
If the configuration setting is empty, or the default I18N localization context does not contain any resource bundle,
or the given key is undefined in its resource bundle, the string "???&lt;key&gt;???" is returned, where "&lt;key&gt;"
is replaced with the given key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageContext</code> - the page in which to get the localized message corresponding to the given key</dd>
<dd><code>key</code> - the message key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the localized message corresponding to the given key</dd>
</dl>
</li>
</ul>
<a name="getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalizedMessage</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getLocalizedMessage(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.String&nbsp;basename)</pre>
<div class="block">Retrieves the localized message corresponding to the given key.
<p>
The given key is looked up in the resource bundle with the given base name.
<p>
If no resource bundle with the given base name exists, or the given key is undefined in the resource bundle, the
string "???&lt;key&gt;???" is returned, where "&lt;key&gt;" is replaced with the given key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageContext</code> - the page in which to get the localized message corresponding to the given key</dd>
<dd><code>key</code> - the message key</dd>
<dd><code>basename</code> - the resource bundle base name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the localized message corresponding to the given key</dd>
</dl>
</li>
</ul>
<a name="getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.Object:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalizedMessage</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getLocalizedMessage(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.Object[]&nbsp;args)</pre>
<div class="block">Retrieves the localized message corresponding to the given key, and performs parametric replacement using the
arguments specified via <tt>args</tt>.
<p>
See the specification of the &lt;fmt:message&gt; action for a description of how parametric replacement is
implemented.
<p>
The localized message is retrieved as in
<a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-"><code>getLocalizedMessage(pageContext, key)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageContext</code> - the page in which to get the localized message corresponding to the given key</dd>
<dd><code>key</code> - the message key</dd>
<dd><code>args</code> - the arguments for parametric replacement</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the localized message corresponding to the given key</dd>
</dl>
</li>
</ul>
<a name="getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.Object:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocalizedMessage</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getLocalizedMessage(<a href="../../../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a>&nbsp;pageContext,
java.lang.String&nbsp;key,
java.lang.Object[]&nbsp;args,
java.lang.String&nbsp;basename)</pre>
<div class="block">Retrieves the localized message corresponding to the given key, and performs parametric replacement using the
arguments specified via <tt>args</tt>.
<p>
See the specification of the &lt;fmt:message&gt; action for a description of how parametric replacement is
implemented.
<p>
The localized message is retrieved as in
<a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html#getLocalizedMessage-jakarta.servlet.jsp.PageContext-java.lang.String-java.lang.String-"><code>getLocalizedMessage(pageContext, key, basename)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageContext</code> - the page in which to get the localized message corresponding to the given key</dd>
<dd><code>key</code> - the message key</dd>
<dd><code>args</code> - the arguments for parametric replacement</dd>
<dd><code>basename</code> - the resource bundle base name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the localized message corresponding to the given key</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>Prev&nbsp;Class</li>
<li><a href="../../../../../jakarta/servlet/jsp/jstl/fmt/LocalizationContext.html" title="class in jakarta.servlet.jsp.jstl.fmt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?jakarta/servlet/jsp/jstl/fmt/LocaleSupport.html" target="_top">Frames</a></li>
<li><a href="LocaleSupport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>