com.sencha.gxt.core.client.util

Class Format

java.lang.Object

com.sencha.gxt.core.client.util.Format

public class Format
extends Object

Formatting functions.

Constructor Summary

Constructors

Constructor and Description
Format()

Method Summary

Modifier and Type	Method and Description
static String	camelize(String s) Camel cases the given string.
static String	capitalize(String value) Capitalizes the first character and lower cases the remaining characters.
static String	currency(double value) Provides the standard currency format for the default locale.
static String	decimal(double value) Provides the standard decimal format for the default locale.
static String	ellipse(String value, int len) Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.
static String	fileSize(int size) Returns the file size.
static String	htmlDecode(String value) Convert certain characters (&, <, >, and ') from their HTML character equivalents.
static String	htmlEncode(String value) Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.
static String	hyphenize(String value) Replaces camel cases with hyphens.
static String	number(double value, String format) Formats the number.
static String	scientific(double value) Provides the standard scientific format for the default locale.
static String	stripScripts(String v)
static String	stripTags(String v)
static String	substitute(String text, int param) Substitutes the indexed parameters.
static String	substitute(String text, Map<String,Object> params) Substitutes the named parameters.
static String	substitute(String text, Object... params) Substitutes the indexed parameters.
static String	substitute(String text, Object param) Substitutes the indexed parameter.
static String	substitute(String text, Params params) Substitutes the parameters.
static String	substitute(String text, String[] keys, Map<String,Object> params) Substitutes the named parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Format

public Format()

Method Detail

camelize

public static String camelize(String s)

Camel cases the given string.

Parameters:

s - the string

Returns:

the camel value

capitalize

public static String capitalize(String value)

Capitalizes the first character and lower cases the remaining characters.

Parameters:

value - the value to capitalize

Returns:

the capitalized value

currency

public static String currency(double value)

Provides the standard currency format for the default locale.

Parameters:

value - the value

Returns:

the currency value

decimal

public static String decimal(double value)

Provides the standard decimal format for the default locale.

Parameters:

value - the value

Returns:

the value

ellipse

public static String ellipse(String value,
                             int len)

Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.

Parameters:

value - the string to truncate

len - the maximum length to allow before truncating

Returns:

the converted text

fileSize

public static String fileSize(int size)

Returns the file size.

Parameters:

size - the size

Returns:

the file size

htmlDecode

public static String htmlDecode(String value)

Convert certain characters (&, <, >, and ') from their HTML character equivalents.

Parameters:

value - the value

Returns:

the decoded value

htmlEncode

public static String htmlEncode(String value)

Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. Delegates to URL#encode(String).

Parameters:

value - the value

Returns:

the encoded value

hyphenize

public static String hyphenize(String value)

Replaces camel cases with hyphens.

Parameters:

value - the value

Returns:

the hyphenized string

number

public static String number(double value,
                            String format)

Formats the number.

Parameters:

value - the number

format - the format using the DateTimeFormat syntax.

Returns:

the formatted string

scientific

public static String scientific(double value)

Provides the standard scientific format for the default locale.

Parameters:

value - the value

Returns:

the value

stripScripts

public static String stripScripts(String v)

stripTags

public static String stripTags(String v)

substitute

public static String substitute(String text,
                                int param)

Substitutes the indexed parameters.

Parameters:

text - the text

param - the parameter

Returns:

the new text

substitute

public static String substitute(String text,
                                Map<String,Object> params)

Substitutes the named parameters. The passed keys and values must be Strings.

Parameters:

text - the text

params - the parameters

Returns:

the new text

substitute

public static String substitute(String text,
                                Object... params)

Substitutes the indexed parameters.

Parameters:

text - the text

params - the parameters

Returns:

the new text

substitute

public static String substitute(String text,
                                Object param)

Substitutes the indexed parameter.

Parameters:

text - the text to format

param - the parameter to use, which will replace {0}

Returns:

the new text

substitute

public static String substitute(String text,
                                Params params)

Substitutes the parameters.

Parameters:

text - the text

params - the parameters

Returns:

the new text

substitute

public static String substitute(String text,
                                String[] keys,
                                Map<String,Object> params)

Substitutes the named parameters. The passed keys and values must be Strings.

Parameters:

text - the text

keys - the parameter names

params - the parameter values

Returns:

the new text