chg: replaced ant with gradle
This commit is contained in:
parent
cee0be52e0
commit
5cbeb9f01d
609 changed files with 87626 additions and 638 deletions
951
modules/jala/docs/jala.I18n.html
Normal file
951
modules/jala/docs/jala.I18n.html
Normal file
|
|
@ -0,0 +1,951 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.I18n
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.I18n";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-I18n.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
<B>Jala 1.3</B>
|
||||
</EM>
|
||||
</TD
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="jala.HtmlDocument.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ImageFilter.html"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="jala.I18n.html" TARGET="_top"><B>NO FRAMES</B></A>
|
||||
|
||||
<SCRIPT>
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
<HR>
|
||||
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>Class jala.I18n</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.I18n</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.I18n</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides various functions and macros for
|
||||
internationalization of Helma applications.
|
||||
<BR/><I>Defined in <a href='overview-summary-I18n.js.html'>I18n.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== END FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="jala.I18n.html#jala.I18n()">jala.I18n</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new instance of jala.I18n
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#formatMessage">formatMessage</A></B>(<String> message, <Array> values)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Converts the message passed as argument into an instance
|
||||
of java.text.MessageFormat, and formats it using the
|
||||
replacement values passed.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getCatalog">getCatalog</A></B>(locale)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Helper method to get the message catalog
|
||||
corresponding to the actual locale.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> java.util.Locale</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLocale">getLocale</A></B>(localeId)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the locale for the given id, which is expected to follow
|
||||
the form <code>language[_COUNTRY][_variant]</code>, where <code>language</code>
|
||||
is a valid ISO Language Code (eg.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Function</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLocaleGetter">getLocaleGetter</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the method for retrieving the locale.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getMessages">getMessages</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the message object.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#gettext">gettext</A></B>(<String> key )
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a localized message for the message key passed as
|
||||
argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#markgettext">markgettext</A></B>(<String> key)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
A simple proxy method which is used to mark a message string
|
||||
for the i18n parser as to be translated.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#message_macro">message_macro</A></B>(param)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a translated message.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#ngettext">ngettext</A></B>(<String> singularKey, <String> pluralKey, <Number> amount )
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a localized message for the message key passed as
|
||||
argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#setHandler">setHandler</A></B>(<Object> handler)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set (overwrite) the default handler containing
|
||||
the messages (ie.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#setLocaleGetter">setLocaleGetter</A></B>(<Function> func)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set the method for retrieving the locale.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#setMessages">setMessages</A></B>(<Object> msgObject)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Overwrite the default object containing
|
||||
the messages (ie.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#translate">translate</A></B>(singularKey, pluralKey, <Number> amount)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Tries to "translate" the given message key into a localized
|
||||
message.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL END =========== -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1>
|
||||
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="jala.I18n()"><!-- --></A><H3>
|
||||
jala.I18n</H3>
|
||||
<PRE><B>jala.I18n</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new instance of jala.I18n
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<HR/>
|
||||
<!-- END ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL START ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- One single method detail entry -->
|
||||
|
||||
<A NAME="formatMessage"><!-- --></A>
|
||||
<H3>formatMessage</H3>
|
||||
<PRE>String <B>formatMessage</B>(<String> message, <Array> values)</PRE>
|
||||
|
||||
<UL>Converts the message passed as argument into an instance
|
||||
of java.text.MessageFormat, and formats it using the
|
||||
replacement values passed.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>message</CODE> - The message to format
|
||||
</UL>
|
||||
|
||||
<UL><CODE>values</CODE> - An optional array containing replacement values
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The formatted message or, if the formatting fails, the message passed as argument.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html</UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getCatalog"><!-- --></A>
|
||||
<H3>getCatalog</H3>
|
||||
<PRE>Object <B>getCatalog</B>(locale)</PRE>
|
||||
|
||||
<UL>Helper method to get the message catalog
|
||||
corresponding to the actual locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The message catalog.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLocale"><!-- --></A>
|
||||
<H3>getLocale</H3>
|
||||
<PRE>java.util.Locale <B>getLocale</B>(localeId)</PRE>
|
||||
|
||||
<UL>Returns the locale for the given id, which is expected to follow
|
||||
the form <code>language[_COUNTRY][_variant]</code>, where <code>language</code>
|
||||
is a valid ISO Language Code (eg. "de"), <code>COUNTRY</code> a valid ISO
|
||||
Country Code (eg. "AT"), and variant an identifier for the variant to use.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The locale for the given id
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLocaleGetter"><!-- --></A>
|
||||
<H3>getLocaleGetter</H3>
|
||||
<PRE>Function <B>getLocaleGetter</B>()</PRE>
|
||||
|
||||
<UL>Get the method for retrieving the locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The getter method
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessages"><!-- --></A>
|
||||
<H3>getMessages</H3>
|
||||
<PRE>Object <B>getMessages</B>()</PRE>
|
||||
|
||||
<UL>Get the message object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The object containing the messages
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="gettext"><!-- --></A>
|
||||
<H3>gettext</H3>
|
||||
<PRE>String <B>gettext</B>(<String> key )</PRE>
|
||||
|
||||
<UL>Returns a localized message for the message key passed as
|
||||
argument. If no localization is found, the message key
|
||||
is returned. Any additional arguments passed to this function
|
||||
will be used as replacement values during message rendering.
|
||||
To reference these values the message can contain placeholders
|
||||
following "{number}" notation, where <code>number</code> must
|
||||
match the number of the additional argument (starting with zero).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>key</CODE> - The message to localize
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#translate">translate()</a><BR/>- <a href="#formatMessage">formatMessage()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="markgettext"><!-- --></A>
|
||||
<H3>markgettext</H3>
|
||||
<PRE>String <B>markgettext</B>(<String> key)</PRE>
|
||||
|
||||
<UL>A simple proxy method which is used to mark a message string
|
||||
for the i18n parser as to be translated.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>key</CODE> - The message that should be seen by the i18n parser as to be translated.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The message in unmodified form
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="message_macro"><!-- --></A>
|
||||
<H3>message_macro</H3>
|
||||
<PRE>String <B>message_macro</B>(param)</PRE>
|
||||
|
||||
<UL>Returns a translated message. The following macro attributes
|
||||
are accepted:
|
||||
<ul>
|
||||
<li>text: The message to translate (required)</li>
|
||||
<li>plural: The plural form of the message</li>
|
||||
<li>values: A list of replacement values. Use a comma to separate more
|
||||
than one value. Each value is either interpreted as a global property
|
||||
(if it doesn't containg a dot) or as a property name of the given macro
|
||||
handler object (eg. "user.name"). If the value of the property is a
|
||||
HopObject or an Array this macro uses the size() resp. length of the
|
||||
object, otherwise the string representation of the object will be used.</li>
|
||||
</ul></UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#gettext">gettext()</a><BR/>- <a href="#ngettext">ngettext()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="ngettext"><!-- --></A>
|
||||
<H3>ngettext</H3>
|
||||
<PRE>String <B>ngettext</B>(<String> singularKey, <String> pluralKey, <Number> amount )</PRE>
|
||||
|
||||
<UL>Returns a localized message for the message key passed as
|
||||
argument. In contrast to gettext() this method
|
||||
can handle plural forms based on the amount passed as argument.
|
||||
If no localization is found, the appropriate message key is
|
||||
returned. Any additional arguments passed to this function
|
||||
will be used as replacement values during message rendering.
|
||||
To reference these values the message can contain placeholders
|
||||
following "{number}" notation, where <code>number</code> must
|
||||
match the number of the additional argument (starting with zero).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>singularKey</CODE> - The singular message to localize
|
||||
</UL>
|
||||
|
||||
<UL><CODE>pluralKey</CODE> - The plural form of the message to localize
|
||||
</UL>
|
||||
|
||||
<UL><CODE>amount</CODE> - The amount which is used to determine whether the singular or plural form of the message should be returned.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#translate">translate()</a><BR/>- <a href="#formatMessage">formatMessage()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setHandler"><!-- --></A>
|
||||
<H3>setHandler</H3>
|
||||
<PRE>void <B>setHandler</B>(<Object> handler)</PRE>
|
||||
|
||||
<UL>Set (overwrite) the default handler containing
|
||||
the messages (ie. a vanilla EcmaScript object).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>handler</CODE> - The handler containing the message object
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>Deprecated</B> <I>Use <a href="#setMessages">setMessages()</a> instead </I><BR/><BR/>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setLocaleGetter"><!-- --></A>
|
||||
<H3>setLocaleGetter</H3>
|
||||
<PRE>void <B>setLocaleGetter</B>(<Function> func)</PRE>
|
||||
|
||||
<UL>Set the method for retrieving the locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>func</CODE> - The getter method
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setMessages"><!-- --></A>
|
||||
<H3>setMessages</H3>
|
||||
<PRE>void <B>setMessages</B>(<Object> msgObject)</PRE>
|
||||
|
||||
<UL>Overwrite the default object containing
|
||||
the messages (ie. a vanilla EcmaScript object).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>msgObject</CODE> - The object containing the messages
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="translate"><!-- --></A>
|
||||
<H3>translate</H3>
|
||||
<PRE>String <B>translate</B>(singularKey, pluralKey, <Number> amount)</PRE>
|
||||
|
||||
<UL>Tries to "translate" the given message key into a localized
|
||||
message.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>amount</CODE> - A number to determine whether to use the singular or plural form of the message
|
||||
</UL>
|
||||
|
||||
<UL><CODE>key</CODE> - The message to translate (required)
|
||||
</UL>
|
||||
|
||||
<UL><CODE>plural</CODE> - The plural form of the message to translate
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The localized message or the appropriate key if no localized message was found
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL END ========== -->
|
||||
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-I18n.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
||||
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
<B>Jala 1.3</B>
|
||||
</EM>
|
||||
</TD
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="jala.HtmlDocument.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ImageFilter.html"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="jala.I18n.html" TARGET="_top"><B>NO FRAMES</B></A>
|
||||
|
||||
<SCRIPT>
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<HR>
|
||||
<FONT SIZE="-1">
|
||||
|
||||
</FONT>
|
||||
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:45:31 2008</div>
|
||||
</BODY>
|
||||
</HTML>
|
||||
Loading…
Add table
Add a link
Reference in a new issue