|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.app.tools.VelocityFormatter
public class 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)
Nested Class Summary | |
---|---|
class |
VelocityFormatter.VelocityAlternator
Deprecated. Class that returns alternating values in a template. |
class |
VelocityFormatter.VelocityAutoAlternator
Deprecated. As VelocityAlternator, but calls alternate()
automatically on rendering in a template. |
Constructor Summary | |
---|---|
VelocityFormatter(Context context)
Deprecated. Constructor needs a backpointer to the context. |
Method Summary | |
---|---|
java.lang.String |
formatArray(java.lang.Object array)
Deprecated. Formats an array into the form "A, B and C". |
java.lang.String |
formatArray(java.lang.Object array,
java.lang.String delim)
Deprecated. 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)
Deprecated. Formats an array into the form "A<delim>B<finaldelim>C". |
java.lang.String |
formatLongDate(java.util.Date date)
Deprecated. Formats a date in DateFormat.LONG style. |
java.lang.String |
formatLongDateTime(java.util.Date date)
Deprecated. Formats a date/time in 'long' style. |
java.lang.String |
formatShortDate(java.util.Date date)
Deprecated. Formats a date in DateFormat.SHORT style. |
java.lang.String |
formatShortDateTime(java.util.Date date)
Deprecated. Formats a date/time in 'short' style. |
java.lang.String |
formatVector(java.util.List list)
Deprecated. Formats a vector into the form "A, B and C". |
java.lang.String |
formatVector(java.util.List list,
java.lang.String delim)
Deprecated. Formats a vector into the form "A<delim>B<delim>C". |
java.lang.String |
formatVector(java.util.List list,
java.lang.String delim,
java.lang.String finaldelim)
Deprecated. Formats a list into the form "Adelim>B<finaldelim>C". |
java.lang.Object |
isNull(java.lang.Object o,
java.lang.Object dflt)
Deprecated. Returns a default value if the object passed is null. |
java.lang.String |
limitLen(int maxlen,
java.lang.String string)
Deprecated. Limits 'string' to 'maxlen' characters. |
java.lang.String |
limitLen(int maxlen,
java.lang.String string,
java.lang.String suffix)
Deprecated. Limits 'string' to 'maxlen' character. |
java.lang.String |
makeAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2)
Deprecated. 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)
Deprecated. Makes an alternator object that alternates between three values. |
java.lang.String |
makeAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2,
java.lang.String alt3,
java.lang.String alt4)
Deprecated. Makes an alternator object that alternates between four values. |
java.lang.String |
makeAutoAlternator(java.lang.String name,
java.lang.String alt1,
java.lang.String alt2)
Deprecated. Makes an alternator object that alternates between two values automatically. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VelocityFormatter(Context context)
context
- A Context.Method Detail |
---|
public java.lang.String formatShortDate(java.util.Date date)
DateFormat.SHORT
style.
date
- The date to format.
public java.lang.String formatLongDate(java.util.Date date)
DateFormat.LONG
style.
date
- The date to format.
public java.lang.String formatShortDateTime(java.util.Date date)
date
- The date to format.
public java.lang.String formatLongDateTime(java.util.Date date)
date
- The date to format.
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.List list)
list
- The list of elements to format.
public java.lang.String formatVector(java.util.List list, java.lang.String delim)
list
- The list of elements to format.delim
- A String.
public java.lang.String formatVector(java.util.List list, java.lang.String delim, java.lang.String finaldelim)
list
- The list of elements to format.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
- The name for the alternator int the context.alt1
- The first alternate.alt2
- The second alternate.
public java.lang.String makeAlternator(java.lang.String name, java.lang.String alt1, java.lang.String alt2, java.lang.String alt3)
name
- alt1
- alt2
- alt3
-
makeAlternator(String name, String alt1, String alt2)
public 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
- alt1
- alt2
- alt3
- alt4
-
makeAlternator(String name, String alt1, String alt2)
public java.lang.String makeAutoAlternator(java.lang.String name, java.lang.String alt1, java.lang.String alt2)
name
- alt1
- alt2
-
makeAlternator(String name, String alt1, String alt2)
public java.lang.Object isNull(java.lang.Object o, java.lang.Object dflt)
o
- dflt
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |