com.portal.bas

Class PInfranetMessageFormat

java.lang.Object

java.text.Format

java.text.MessageFormat

com.portal.bas.PInfranetMessageFormat

All Implemented Interfaces:

Serializable, Cloneable

public class PInfranetMessageFormat
extends MessageFormat

PInfranetMessageFormat is a MessageFormat derivative that makes use of Portal view permissions and permission masks. It also has implicit knowedge of the kinds of data usually displayed, for example, currency.

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.MessageFormat

MessageFormat.Field

Constructor Summary

Constructors

Constructor and Description
PInfranetMessageFormat(String format) Creates an instance of a PInfranetMessageFormat object for the default locale in the specified format.
PInfranetMessageFormat(String format, Locale loc) Creates an instance of a PInfranetMessageFormat object in the specified format and locale.

Method Summary

Modifier and Type	Method and Description
static String	createFormatFor(Object[] args) A static utility method called to create a default format for a number of arguments.
static String	format(String format, Object[] args) A static utility method called to format an array of Object arguments that follow a supplied format string.
static String	format(String format, Object[] args, Locale loc) A static utility method called to format an array of Object arguments that follow a suppled format string for a specified locale.
static String	format(String format, Vector args) A static utility method called to format an array of Vector arguments that follow a supplied format string.
static String	format(String format, Vector args, Locale loc) A static utility method called to format an array of Vector arguments that follow a supplied format string for a specified locale.
String	format(Vector v) Formats the data in a vector.
void	overrideCurrencySymbol(String newSymbol) Overrides the currency symbol used by the default locale, given a new currency symbol to use in its place.
void	setCurrencyFormat(NumberFormat newCurFormatter) Change the currency format to the new currency format.

Methods inherited from class java.text.MessageFormat

applyPattern, clone, equals, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, hashCode, parse, parse, parseObject, setFormat, setFormatByArgumentIndex, setFormats, setFormatsByArgumentIndex, setLocale, toPattern

Methods inherited from class java.text.Format

format, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PInfranetMessageFormat

public PInfranetMessageFormat(String format)

Creates an instance of a PInfranetMessageFormat object for the default locale in the specified format.

Parameters:

format - a String with the format to use

PInfranetMessageFormat

public PInfranetMessageFormat(String format,
                              Locale loc)

Creates an instance of a PInfranetMessageFormat object in the specified format and locale.

Parameters:

format - a String with the format to use

loc - the locale to format for

Method Detail

setCurrencyFormat

public void setCurrencyFormat(NumberFormat newCurFormatter)

Change the currency format to the new currency format.

Parameters:

newCurFormatter - The new currency format.

overrideCurrencySymbol

public void overrideCurrencySymbol(String newSymbol)

Overrides the currency symbol used by the default locale, given a new currency symbol to use in its place.

Parameters:

newSymbol - the new currency symbol

format

public String format(Vector v)

Formats the data in a vector.

Parameters:

v - a Vector of objects to supply to the formatter

Returns:

A formatted string.

format

public static String format(String format,
                            Object[] args)

A static utility method called to format an array of Object arguments that follow a supplied format string.

Parameters:

format - a String with the format to use

args - an array of objects to format

Returns:

A formatted string.

format

public static String format(String format,
                            Object[] args,
                            Locale loc)

A static utility method called to format an array of Object arguments that follow a suppled format string for a specified locale.

Parameters:

format - a String with the format to use

args - an array of objects to format

loc - the locale to format to

Returns:

A formatted string.

format

public static String format(String format,
                            Vector args,
                            Locale loc)

A static utility method called to format an array of Vector arguments that follow a supplied format string for a specified locale.

Parameters:

format - a String with the format to use

args - a Vector of objects to format

loc - the locale to format to

Returns:

A formatted string.

format

public static String format(String format,
                            Vector args)

A static utility method called to format an array of Vector arguments that follow a supplied format string.

Parameters:

format - a String with the format to use

args - a Vector of objects to format

Returns:

A formatted string.

createFormatFor

public static String createFormatFor(Object[] args)

A static utility method called to create a default format for a number of arguments.

Parameters:

args - an array of arguments to format

Returns:

A format string.