Formatting tool for inserting into the Velocity WebContext. Can
format dates or lists of objects.
Here's an example of some uses:
$formatter.formatShortDate($object.Date)
$formatter.formatLongDate($db.getRecord(232).getDate())
$formatter.formatArray($array)
$formatter.limitLen(30, $object.Description)
formatArray
public String formatArray(Object array)
Formats an array into the form "A, B and C".
array
- An Object.
- A String.
formatArray
public String formatArray(Object array,
String delim)
Formats an array into the form
"A<delim>B<delim>C".
array
- An Object.delim
- A String.
- A String.
formatArray
public String formatArray(Object array,
String delim,
String finaldelim)
Formats an array into the form
"A<delim>B<finaldelim>C".
array
- An Object.delim
- A String.
- A String.
formatLongDate
public String formatLongDate(Date date)
Formats a date in DateFormat.LONG
style.
date
- The date to format.
- The formatted date as text.
formatLongDateTime
public String formatLongDateTime(Date date)
Formats a date/time in 'long' style.
date
- The date to format.
- The formatted date as text.
formatShortDate
public String formatShortDate(Date date)
Formats a date in DateFormat.SHORT
style.
date
- The date to format.
- The formatted date as text.
formatShortDateTime
public String formatShortDateTime(Date date)
Formats a date/time in 'short' style.
date
- The date to format.
- The formatted date as text.
formatVector
public String formatVector(List list)
Formats a vector into the form "A, B and C".
list
- The list of elements to format.
- A String.
formatVector
public String formatVector(List list,
String delim)
Formats a vector into the form "A<delim>B<delim>C".
list
- The list of elements to format.delim
- A String.
- A String.
formatVector
public String formatVector(List list,
String delim,
String finaldelim)
Formats a list into the form
"Adelim>B<finaldelim>C".
list
- The list of elements to format.delim
- A String.
- A String.
isNull
public Object isNull(Object o,
Object dflt)
Returns a default value if the object passed is null.
limitLen
public String limitLen(int maxlen,
String string)
Limits 'string' to 'maxlen' characters. If the string gets
curtailed, "..." is appended to it.
maxlen
- An int with the maximum length.string
- A String.
- A String.
limitLen
public String limitLen(int maxlen,
String string,
String suffix)
Limits 'string' to 'maxlen' character. If the string gets
curtailed, 'suffix' is appended to it.
maxlen
- An int with the maximum length.string
- A String.suffix
- A String.
- A String.
makeAlternator
public String makeAlternator(String name,
String alt1,
String alt2)
Makes an alternator object that alternates between two values.
Example usage in a Velocity template:
<table>
$formatter.makeAlternator("rowcolor", "#c0c0c0", "#e0e0e0")
#foreach $item in $items
#begin
<tr><td bgcolor="$rowcolor">$item.Name</td></tr>
$rowcolor.alternate()
#end
</table>
name
- The name for the alternator int the context.alt1
- The first alternate.alt2
- The second alternate.
- The newly created instance.
makeAlternator
public String makeAlternator(String name,
String alt1,
String alt2,
String alt3)
Makes an alternator object that alternates between three
values.
makeAlternator(String name, String alt1, String alt2)
makeAlternator
public String makeAlternator(String name,
String alt1,
String alt2,
String alt3,
String alt4)
Makes an alternator object that alternates between four values.
makeAlternator(String name, String alt1, String alt2)
makeAutoAlternator
public String makeAutoAlternator(String name,
String alt1,
String alt2)
Makes an alternator object that alternates between two values
automatically.
makeAlternator(String name, String alt1, String alt2)