|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.velocity.app.tools.VelocityFormatter
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)
Inner Class Summary | |
class |
VelocityFormatter.VelocityAlternator
Class that returns alternating values in a template. |
Field Summary | |
(package private) Context |
context
|
(package private) java.text.NumberFormat |
nf
|
Constructor Summary | |
VelocityFormatter(Context context)
Constructor needs a backpointer to the context. |
Method Summary | |
java.lang.String |
formatArray(java.lang.Object array)
Formats an array into the form "A, B and C". |
java.lang.String |
formatArray(java.lang.Object array,
java.lang.String delim)
Formats an array into the form "A<delim>B<delim>C". |
java.lang.String |
formatArray(java.lang.Object array,
java.lang.String delim,
java.lang.String finaldelim)
Formats an array into the form "A<delim>B<finaldelim>C". |
java.lang.String |
formatLongDate(java.util.Date date)
Formats a date in 'long' style. |
java.lang.String |
formatLongDateTime(java.util.Date date)
Formats a date/time in 'long' style. |
java.lang.String |
formatShortDate(java.util.Date date)
Formats a date in 'short' style. |
java.lang.String |
formatShortDateTime(java.util.Date date)
Formats a date/time in 'short' style. |
java.lang.String |
formatVector(java.util.Vector vector)
Formats a vector into the form "A, B and C". |
java.lang.String |
formatVector(java.util.Vector vector,
java.lang.String delim)
Formats a vector into the form "A<delim>B<delim>C". |
java.lang.String |
formatVector(java.util.Vector vector,
java.lang.String delim,
java.lang.String finaldelim)
Formats a vector into the form "Adelim>B<finaldelim>C". |
java.lang.Object |
isNull(java.lang.Object o,
java.lang.Object dflt)
Returns a default value if the object passed is null. |
java.lang.String |
limitLen(int maxlen,
java.lang.String string)
Limits 'string' to 'maxlen' characters. |
java.lang.String |
limitLen(int maxlen,
java.lang.String string,
java.lang.String suffix)
Limits 'string' to 'maxlen' character. |
java.lang.String |
makeAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2)
Makes an alternator object that alternates between two values. |
java.lang.String |
makeAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2,
java.lang.String alt3)
Makes an alternator object that alternates between three values. |
(package private) java.lang.String |
makeAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2,
java.lang.String alt3,
java.lang.String alt4)
Makes an alternator object that alternates between four values. |
Methods inherited from class java.lang.Object |
|
Field Detail |
Context context
java.text.NumberFormat nf
Constructor Detail |
public VelocityFormatter(Context context)
context
- A Context.Method Detail |
public java.lang.String formatShortDate(java.util.Date date)
date
- A Date.public java.lang.String formatLongDate(java.util.Date date)
date
- A Date.public java.lang.String formatShortDateTime(java.util.Date date)
date
- A Date.public java.lang.String formatLongDateTime(java.util.Date date)
date
- A Date.public java.lang.String formatArray(java.lang.Object array)
array
- An Object.public java.lang.String formatArray(java.lang.Object array, java.lang.String delim)
array
- An Object.delim
- A String.public java.lang.String formatArray(java.lang.Object array, java.lang.String delim, java.lang.String finaldelim)
array
- An Object.delim
- A String.finalDelim
- A String.public java.lang.String formatVector(java.util.Vector vector)
vector
- A Vector.public java.lang.String formatVector(java.util.Vector vector, java.lang.String delim)
vector
- A Vector.delim
- A String.public java.lang.String formatVector(java.util.Vector vector, java.lang.String delim, java.lang.String finaldelim)
vector
- A Vector.delim
- A String.finalDelim
- A String.public java.lang.String limitLen(int maxlen, java.lang.String string)
maxlen
- An int with the maximum length.string
- A String.public java.lang.String limitLen(int maxlen, java.lang.String string, java.lang.String suffix)
maxlen
- An int with the maximum length.string
- A String.suffix
- A String.public java.lang.String makeAlternator(java.lang.String name, java.lang.String alt1, java.lang.String alt2)
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
- A String.alt1
- A String.alt2
- A String.public java.lang.String makeAlternator(java.lang.String name, java.lang.String alt1, java.lang.String alt2, java.lang.String alt3)
name
- A String.alt1
- A String.alt2
- A String.alt3
- A String.java.lang.String makeAlternator(java.lang.String name, java.lang.String alt1, java.lang.String alt2, java.lang.String alt3, java.lang.String alt4)
name
- A String.alt1
- A String.alt2
- A String.alt3
- A String.alt4
- A String.public java.lang.Object isNull(java.lang.Object o, java.lang.Object dflt)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |