|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.tools.generic.AbstractLockConfig
org.apache.velocity.tools.generic.DisplayTool
@DefaultKey(value="display") public class DisplayTool
Provides general utility methods for controlling the display of references.
Currently, this class contains methods for "pretty printing" an array or
Collection
, methods for truncating the string value of a reference
at a configured or specified length, and methods for displaying an alternate
value when a specified value is null.
Example Use:
tools.xml... <tools> <toolbox scope="application"> <tool class="org.apache.velocity.tools.generic.DisplayTool"/> </toolbox> </tools> template... #set( $list = [1..5] ) $display.list($list) $display.truncate(10, "This is a long string.") Not Null: $display.alt("not null", "--") Null: $display.alt($null, "--") output... 1, 2, 3, 4 and 5 This is... Not Null: not null Null: --
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ALTERNATE_KEY
|
private java.lang.String |
defaultAlternate
|
private java.lang.String |
defaultDelim
|
private java.lang.String |
defaultFinalDelim
|
private int |
defaultMaxLength
|
private java.lang.String |
defaultSuffix
|
static java.lang.String |
LIST_DELIM_KEY
|
static java.lang.String |
LIST_FINAL_DELIM_KEY
|
static java.lang.String |
TRUNCATE_MAX_LENGTH_KEY
|
static java.lang.String |
TRUNCATE_SUFFIX_KEY
|
Fields inherited from class org.apache.velocity.tools.generic.AbstractLockConfig |
---|
LOCK_CONFIG_KEY |
Constructor Summary | |
---|---|
DisplayTool()
|
Method Summary | |
---|---|
java.lang.Object |
alt(java.lang.Object checkMe)
Returns a configured default value if specified value is null. |
java.lang.Object |
alt(java.lang.Object checkMe,
java.lang.Object alternate)
Returns the second argument if first argument specified is null. |
protected void |
configure(ValueParser values)
Does the actual configuration. |
protected java.lang.String |
format(java.util.Collection list,
java.lang.String delim,
java.lang.String finaldelim)
Does the actual formatting of the collection. |
java.lang.String |
list(java.lang.Object list)
Formats a collection or array into the form "A, B and C". |
java.lang.String |
list(java.lang.Object list,
java.lang.String delim)
Formats a collection or array into the form "A<delim>B<delim>C". |
java.lang.String |
list(java.lang.Object list,
java.lang.String delim,
java.lang.String finaldelim)
Formats a collection or array into the form "A<delim>B<finaldelim>C". |
protected void |
setDefaultAlternate(java.lang.String dflt)
|
protected void |
setListDelimiter(java.lang.String delim)
|
protected void |
setListFinalDelimiter(java.lang.String finalDelim)
|
protected void |
setTruncateMaxLength(int maxlen)
|
protected void |
setTruncateSuffix(java.lang.String suffix)
|
java.lang.String |
truncate(java.lang.Object truncateMe)
Limits the string value of 'truncateMe' to the configured max length in characters (default is 30 characters). |
java.lang.String |
truncate(java.lang.Object truncateMe,
int maxLength)
Limits the string value of 'truncateMe' to 'maxLength' characters. |
java.lang.String |
truncate(java.lang.Object truncateMe,
int maxLength,
java.lang.String suffix)
Limits the string value of 'truncateMe' to the specified max length in characters. |
java.lang.String |
truncate(java.lang.Object truncateMe,
java.lang.String suffix)
Limits the string value of 'truncateMe' to the configured max length in characters (default is 30 characters). |
Methods inherited from class org.apache.velocity.tools.generic.AbstractLockConfig |
---|
configure, isConfigLocked |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LIST_DELIM_KEY
public static final java.lang.String LIST_FINAL_DELIM_KEY
public static final java.lang.String TRUNCATE_MAX_LENGTH_KEY
public static final java.lang.String TRUNCATE_SUFFIX_KEY
public static final java.lang.String DEFAULT_ALTERNATE_KEY
private java.lang.String defaultDelim
private java.lang.String defaultFinalDelim
private int defaultMaxLength
private java.lang.String defaultSuffix
private java.lang.String defaultAlternate
Constructor Detail |
---|
public DisplayTool()
Method Detail |
---|
protected void configure(ValueParser values)
configure
in class AbstractLockConfig
protected void setListDelimiter(java.lang.String delim)
protected void setListFinalDelimiter(java.lang.String finalDelim)
protected void setTruncateMaxLength(int maxlen)
protected void setTruncateSuffix(java.lang.String suffix)
protected void setDefaultAlternate(java.lang.String dflt)
public java.lang.String list(java.lang.Object list)
list
- A collection or array.
public java.lang.String list(java.lang.Object list, java.lang.String delim)
list
- A collection or array.delim
- A String.
public java.lang.String list(java.lang.Object list, java.lang.String delim, java.lang.String finaldelim)
list
- A collection or array.delim
- A String.finaldelim
- A String.
protected java.lang.String format(java.util.Collection list, java.lang.String delim, java.lang.String finaldelim)
public java.lang.String truncate(java.lang.Object truncateMe)
obj
- The value to be truncated.
public java.lang.String truncate(java.lang.Object truncateMe, int maxLength)
maxLength
- An int with the maximum length.obj
- The value to be truncated.
public java.lang.String truncate(java.lang.Object truncateMe, java.lang.String suffix)
obj
- The value to be truncated.suffix
- A String.
public java.lang.String truncate(java.lang.Object truncateMe, int maxLength, java.lang.String suffix)
maxLength
- An int with the maximum length.obj
- The value to be truncated.suffix
- A String.
public java.lang.Object alt(java.lang.Object checkMe)
checkMe
-
public java.lang.Object alt(java.lang.Object checkMe, java.lang.Object alternate)
checkMe
- alternate
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |