Zimlet JavaScript API Reference - AjxMessageFormat

Class AjxMessageFormat




Defined in: AjxText.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AjxMessageFormat(pattern)
Message formatter based on the Java MessageFormat class.
Method Summary
Method Attributes Method Name and Description
 
format(params)
Format with replacement parameters.
<static>  
AjxMessageFormat.format(pattern, params)
Format a message pattern with replacement parameters.
Class Detail
AjxMessageFormat(pattern)
Message formatter based on the Java MessageFormat class.

Note: This implementation augments Java's MessageFormat patterns to support list formatting. The following forms differ from the originals defined in the JavaDoc for MessageFormat:

FormatElement:
      { ArgumentIndex }
      { ArgumentIndex , FormatType }
      { ArgumentIndex , ListFormatType , FormatType }
      { ArgumentIndex , FormatType , FormatStyle }
      { ArgumentIndex , ListFormatType , FormatType , FormatStyle }
ListFormatType:
      list
Parameters:
{string} pattern
The message format pattern.
Method Detail
{string} format(params)
Format with replacement parameters.
Parameters:
{Array} params
Replacement parameters.
Returns:
{string} Formatted message.

<static> {string} AjxMessageFormat.format(pattern, params)
Format a message pattern with replacement parameters. Equivalent to new AjxMessageFormat(pattern).format(params).
Parameters:
{string} pattern
Message pattern.
{Array} params
Replacement parameters.
Returns:
{string} Formatted message.

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:30 GMT-0400 (EDT)