com.dpslink.flash.util

Class FlashTemplateFormatter

java.lang.Object

com.dpslink.base.util.TemplateFormatter

com.dpslink.flash.util.FlashTemplateFormatter

All Implemented Interfaces:

java.io.Serializable

public class FlashTemplateFormatter
extends TemplateFormatter

An extension to the base template formatter that provides additional Flash specific formatting.

The methods in this class are accessible from within a template via the $fmt variable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
FlashTemplateFormatter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	ccExpire(CreditCard cc) Return a formatted credit card expiration string.
static java.lang.String	ccMaskNum(java.lang.String ccNum) Returns a formatted (masked) credit card number string.
static java.lang.String	ccNumber(CreditCard cc) Returns a formatted (masked) credit card number string.
static java.lang.String	ccType(CreditCard cc) Return a formatted credit card type string.
static java.lang.String	custAddress(Customer cust) Returns a formatted customer address string using the html <br> tag as the address line delimiter.
static java.lang.String	custAddress(Customer cust, java.lang.String delimiter) Returns a formatted customer address string using the given address line delimiter.
static java.lang.String	priceInput(java.math.BigDecimal value) Returns a formatted unit price input string.
static java.lang.String	priceInput0(java.math.BigDecimal value) Returns a formatted unit price input string.
static java.lang.String	priceOutput(java.math.BigDecimal value) Returns a formatted unit price output string.
static java.lang.String	priceOutput0(java.math.BigDecimal value) Returns a formatted unit price output string.
static java.lang.String	priceOutputC(java.math.BigDecimal value) Returns a formatted unit price output string.
static java.lang.String	quantityInput(int value) Returns a formatted quantity input string.
static java.lang.String	quantityInput0(int value) Returns a formatted quantity input string.
static java.lang.String	quantityOutput(int value) Returns a formatted quantity output string.
static java.lang.String	quantityOutput0(int value) Returns a formatted quantity output string.
static java.lang.String	siteAddress(FlashSiteInfo info) Returns a formatted site info address string using the html <br> tag as the address line delimiter.
static java.lang.String	siteAddress(FlashSiteInfo info, java.lang.String delimiter) Returns a formatted site info address string using the given address line delimiter.
static java.lang.String	totalInput(java.math.BigDecimal value) Returns a formatted extended or total amount input string.
static java.lang.String	totalInput0(java.math.BigDecimal value) Returns a formatted extended or total amount input string.
static java.lang.String	totalOutput(java.math.BigDecimal value) Returns a formatted extended or total amount output string.
static java.lang.String	totalOutput(double value) Returns a formatted extended or total amount output string.
static java.lang.String	totalOutput0(java.math.BigDecimal value) Returns a formatted extended or total amount output string.
static java.lang.String	totalOutput0(double value) Returns a formatted extended or total amount output string.
static java.lang.String	totalOutputC(java.math.BigDecimal value) Returns a formatted extended or total amount output string.
static java.lang.String	totalOutputC(double value) Returns a formatted extended or total amount output string.
static java.lang.String	userName(User user) Returns a formatted user name string.
static java.lang.String	userType(User user) Returns a formatted user type string.

Methods inherited from class com.dpslink.base.util.TemplateFormatter

currencyInput, currencyInput, currencyInput0, currencyInput0, currencyOutput, currencyOutput, currencyOutput0, currencyOutput0, dateInput, dateInput, dateInput, dateOutput, dateOutput, dateOutput, datetimeOutput, datetimeOutput, datetimeOutput, numberInput, numberInput, numberInput, numberInput0, numberInput0, numberInput0, numberOutput, numberOutput, numberOutput, numberOutput0, numberOutput0, numberOutput0, timeInput, timeInput, timeInput, timeOutput, timeOutput, timeOutput, toYesNo

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

FlashTemplateFormatter

public FlashTemplateFormatter()

Method Detail

ccExpire

public static java.lang.String ccExpire(CreditCard cc)

Return a formatted credit card expiration string.

Parameters:

cc - (CreditCard) The credit card to format.

Returns:

String - The formatted expiration.

ccNumber

public static java.lang.String ccNumber(CreditCard cc)

Returns a formatted (masked) credit card number string.

Parameters:

cc - (CreditCard) The credit card to format.

Returns:

String - The formatted number.

ccMaskNum

public static java.lang.String ccMaskNum(java.lang.String ccNum)

Returns a formatted (masked) credit card number string.

Parameters:

ccNum - (String) The credit card number to format.

Returns:

String - The formatted number.

ccType

public static java.lang.String ccType(CreditCard cc)

Return a formatted credit card type string.

Parameters:

cc - (CreditCard) The credit card to format.

Returns:

String - The formatted type.

custAddress

public static java.lang.String custAddress(Customer cust)

Returns a formatted customer address string using the html <br> tag as the address line delimiter.

Parameters:

cust - (Customer) The customer to format.

Returns:

String - The formatted address.

custAddress

public static java.lang.String custAddress(Customer cust,
                                           java.lang.String delimiter)

Returns a formatted customer address string using the given address line delimiter.

Parameters:

cust - (Customer) The customer to format.

delimiter - (String) The character(s) to use as a separator between each line of address.

Returns:

String - The formatted address.

quantityInput

public static java.lang.String quantityInput(int value)

Returns a formatted quantity input string.

• Excludes grouping separators.
• Excludes zero values.

Parameters:

value - (int) The value to format.

Returns:

String - The formatted value.

quantityInput0

public static java.lang.String quantityInput0(int value)

Returns a formatted quantity input string.

• Excludes grouping separators.
• Includes zero values.

Parameters:

value - (int) The value to format.

Returns:

String - The formatted value.

quantityOutput

public static java.lang.String quantityOutput(int value)

Returns a formatted quantity output string.

• Includes grouping separators.
• Excludes zero values.

Parameters:

value - (int) The value to format.

Returns:

String - The formatted value.

quantityOutput0

public static java.lang.String quantityOutput0(int value)

Returns a formatted quantity output string.

• Includes grouping separators.
• Includes zero values.

Parameters:

value - (int) The value to format.

Returns:

String - The formatted value.

priceInput

public static java.lang.String priceInput(java.math.BigDecimal value)

Returns a formatted unit price input string.

• Excludes currency symbol.
• Excludes grouping separators.
• Excludes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

priceInput0

public static java.lang.String priceInput0(java.math.BigDecimal value)

Returns a formatted unit price input string.

• Excludes currency symbol.
• Excludes grouping separators.
• Includes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

priceOutput

public static java.lang.String priceOutput(java.math.BigDecimal value)

Returns a formatted unit price output string.

• Excludes currency symbol.
• Includes grouping separators.
• Excludes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

priceOutput0

public static java.lang.String priceOutput0(java.math.BigDecimal value)

Returns a formatted unit price output string.

• Excludes currency symbol.
• Includes grouping separators.
• Includes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

priceOutputC

public static java.lang.String priceOutputC(java.math.BigDecimal value)

Returns a formatted unit price output string.

• Includes currency symbol.
• Includes grouping separators.
• Includes zero values.

Includes currency symbol. Includes grouping separators.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

siteAddress

public static java.lang.String siteAddress(FlashSiteInfo info)

Returns a formatted site info address string using the html <br> tag as the address line delimiter.

Parameters:

info - (FlashSiteInfo) The site info to format.

Returns:

String - The formatted address.

siteAddress

public static java.lang.String siteAddress(FlashSiteInfo info,
                                           java.lang.String delimiter)

Returns a formatted site info address string using the given address line delimiter.

Parameters:

info - (FlashSiteInfo) The site info to format.

delimiter - (String) The character(s) to use as a separator between each line of address.

Returns:

String - The formatted address.

totalInput

public static java.lang.String totalInput(java.math.BigDecimal value)

Returns a formatted extended or total amount input string.

• Excludes currency symbol.
• Excludes grouping separators.
• Excludes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

totalInput0

public static java.lang.String totalInput0(java.math.BigDecimal value)

Returns a formatted extended or total amount input string.

• Excludes currency symbol.
• Excludes grouping separators.
• Includes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

totalOutput

public static java.lang.String totalOutput(double value)

Returns a formatted extended or total amount output string.

• Excludes currency symbol.
• Includes grouping separators.
• Excludes zero values.

Parameters:

value - (double) The value to format.

Returns:

String - The formatted value.

totalOutput

public static java.lang.String totalOutput(java.math.BigDecimal value)

Returns a formatted extended or total amount output string.

• Excludes currency symbol.
• Includes grouping separators.
• Excludes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

totalOutput0

public static java.lang.String totalOutput0(double value)

Returns a formatted extended or total amount output string.

• Excludes currency symbol.
• Includes grouping separators.
• Includes zero values.

Parameters:

value - (double) The value to format.

Returns:

String - The formatted value.

totalOutput0

public static java.lang.String totalOutput0(java.math.BigDecimal value)

Returns a formatted extended or total amount output string.

• Excludes currency symbol.
• Includes grouping separators.
• Includes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

totalOutputC

public static java.lang.String totalOutputC(double value)

Returns a formatted extended or total amount output string.

• Includes currency symbol.
• Includes grouping separators.
• Includes zero values.

Parameters:

value - (double) The value to format.

Returns:

String - The formatted value.

totalOutputC

public static java.lang.String totalOutputC(java.math.BigDecimal value)

Returns a formatted extended or total amount output string.

• Includes currency symbol.
• Includes grouping separators.
• Includes zero values.

Parameters:

value - (BigDecimal) The value to format.

Returns:

String - The formatted value.

userName

public static java.lang.String userName(User user)

Returns a formatted user name string.

Parameters:

user - (User) The user to format.

Returns:

String - The formatted name.

userType

public static java.lang.String userType(User user)

Returns a formatted user type string.

Parameters:

user - (User) The user to format.

Returns:

String - The formatted type.