NetUI Tag Library Documentation (Version 1.0.1)

netui
netui:formatString Tag

A formatter used to format strings.

Syntax

<netui:formatString
    [country="string_country"]
    [language="string_language"]
    pattern="string_pattern"
    [truncate="boolean_truncate"] />

Description

A formatter used to format strings.

The <netui:formatString> tag formats the output of its parent tag. For example:

    <netui:span value="${pageFlow.phone}">
        <netui:formatString pattern="phone number: (###) ###-####"/>
    </netui:span> 

<netui:formatString> uses the following pattern syntax:

The # character is a placeholder for individual characters in the String to be formatted, while other characters are treated as literals. For example:

String "5555555555" with pattern "(###)###-####" would result in: (555)555-5555.

The * character displays all remaining characters in the String. For example:

String "123456" with pattern "#-*!" would result in: 1-23456!

If a result with a '#' or '*' character showing is desired, the '#' or '*' needs to be escaped with the '$' character. For example:

String "ABCD" with pattern "$#-####" would result in: #-ABCD.

To show a '$' in the result, the '$' character needs to be escaped. For example:

String "1234" with pattern "$$#,###" would result in: $1,234

If the truncate attribute is set to "true", characters in the String that exceed the pattern will be dropped. Otherwise, they will be appended to the end of the formatted String.

Attributes
country
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the country code for the locale.
language
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the language code for the locale.
pattern
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the pattern to be used by this format tag. (See the tag description)
truncate
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

A boolean specifying whether characters that exceed the pattern's length should be dropped.

Example

In this sample, the String "2125555555" will be formatted to this form: (212)555-5555.

    <netui:span value="2125555555">
        <netui:formatString pattern="phone (###) ###-####"/>
    </netui:span> 


Tag Information
Tag Classorg.apache.beehive.netui.tags.html.FormatString
TagExtraInfo ClassNone
Body Contentempty
Display NameNone