<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 26 10:16:13 PDT 2010 --> | |
<TITLE> | |
DisplayTool (VelocityTools 2.0 Documentation) | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.DisplayTool class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="DisplayTool (VelocityTools 2.0 Documentation)"; | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/velocity/tools/generic/DisplayTool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DisplayTool.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.velocity.tools.generic</FONT> | |
<BR> | |
Class DisplayTool</H2> | |
<PRE> | |
java.lang.Object | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.LocaleConfig</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.generic.DisplayTool</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE><FONT SIZE="-1"><A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html" title="annotation in org.apache.velocity.tools.config">@DefaultKey</A>(<A HREF="../../../../../org/apache/velocity/tools/config/DefaultKey.html#value()">value</A>="display") | |
</FONT>public class <B>DisplayTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></DL> | |
</PRE> | |
<P> | |
Provides general utility methods for controlling the display of references. | |
Currently, this class contains methods for "pretty printing" an array or | |
<CODE>Collection</CODE>, methods for truncating the string value of a reference | |
at a configured or specified length, methods for displaying an alternate | |
value when a specified value is null, a method for generating whitespace, | |
a "printf" type of method for formatting messages, and | |
methods for forcing values into "cells" of equal size (via truncation or | |
padding with whitespace). | |
<p><b>Example Use:</b> | |
<pre> | |
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("This is a long string.", 10) | |
Not Null: $display.alt("not null", "--") | |
Null: $display.alt($null, "--") | |
output... | |
1, 2, 3, 4 and 5 | |
This is... | |
Not Null: not null | |
Null: -- | |
</pre></p> | |
<P> | |
<P> | |
<DL> | |
<DT><B>Since:</B></DT> | |
<DD>VelocityTools 2.0</DD> | |
<DT><B>Version:</B></DT> | |
<DD>$Id: DisplayTool.java 463298 2006-10-12 16:10:32Z henning $</DD> | |
<DT><B>Author:</B></DT> | |
<DD><a href="sean@somacity.com">Sean Legassick</a>, <a href="dlr@collab.net">Daniel Rall</a>, Nathan Bubna</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- ======== NESTED CLASS SUMMARY ======== --> | |
<A NAME="nested_class_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Nested Class Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static class</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic">DisplayTool.Measurements</A></B></CODE> | |
<BR> | |
Measures the dimensions of the string given to its constructor.</TD> | |
</TR> | |
</TABLE> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#ALLOWED_TAGS_KEY">ALLOWED_TAGS_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#CELL_LENGTH_KEY">CELL_LENGTH_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#CELL_SUFFIX_KEY">CELL_SUFFIX_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#DEFAULT_ALTERNATE_KEY">DEFAULT_ALTERNATE_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String[]</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultAllowedTags">defaultAllowedTags</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultAlternate">defaultAlternate</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultCellLength">defaultCellLength</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultCellSuffix">defaultCellSuffix</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultDelim">defaultDelim</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultFinalDelim">defaultFinalDelim</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultTruncateAtWord">defaultTruncateAtWord</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultTruncateLength">defaultTruncateLength</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>private java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#defaultTruncateSuffix">defaultTruncateSuffix</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#LIST_DELIM_KEY">LIST_DELIM_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#LIST_FINAL_DELIM_KEY">LIST_FINAL_DELIM_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#TRUNCATE_AT_WORD_KEY">TRUNCATE_AT_WORD_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#TRUNCATE_LENGTH_KEY">TRUNCATE_LENGTH_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#TRUNCATE_SUFFIX_KEY">TRUNCATE_SUFFIX_KEY</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.LocaleConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#DEFAULT_LOCALE">DEFAULT_LOCALE</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#OLD_LOCK_CONFIG_KEY">OLD_LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
<A NAME="constructor_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Constructor Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#DisplayTool()">DisplayTool</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.Object</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#alt(java.lang.Object)">alt</A></B>(java.lang.Object checkMe)</CODE> | |
<BR> | |
Returns a configured default value if specified value is null.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.Object</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#alt(java.lang.Object, java.lang.Object)">alt</A></B>(java.lang.Object checkMe, | |
java.lang.Object alternate)</CODE> | |
<BR> | |
Returns the second argument if first argument specified is null.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#br(java.lang.Object)">br</A></B>(java.lang.Object obj)</CODE> | |
<BR> | |
Inserts HTML line break tag (<br />) in front of all newline | |
characters of the string value of the specified object and returns the | |
resulting string.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#capitalize(java.lang.Object)">capitalize</A></B>(java.lang.Object capitalizeMe)</CODE> | |
<BR> | |
Changes the first character of the string value of the specified object | |
to upper case and returns the resulting string.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#cell(java.lang.Object)">cell</A></B>(java.lang.Object obj)</CODE> | |
<BR> | |
Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the default cell size.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#cell(java.lang.Object, int)">cell</A></B>(java.lang.Object obj, | |
int cellsize)</CODE> | |
<BR> | |
Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the specified cell size.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#cell(java.lang.Object, int, java.lang.String)">cell</A></B>(java.lang.Object obj, | |
int cellsize, | |
java.lang.String suffix)</CODE> | |
<BR> | |
Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the specified cell size.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#cell(java.lang.Object, java.lang.String)">cell</A></B>(java.lang.Object obj, | |
java.lang.String suffix)</CODE> | |
<BR> | |
Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the default cell size.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</CODE> | |
<BR> | |
Does the actual configuration.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#format(java.util.Collection, java.lang.String, java.lang.String, java.lang.String)">format</A></B>(java.util.Collection list, | |
java.lang.String delim, | |
java.lang.String finaldelim, | |
java.lang.String property)</CODE> | |
<BR> | |
Does the actual formatting of the collection.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String[]</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getAllowedTags()">getAllowedTags</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getCellLength()">getCellLength</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getCellSuffix()">getCellSuffix</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getDefaultAlternate()">getDefaultAlternate</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getListDelimiter()">getListDelimiter</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getListFinalDelimiter()">getListFinalDelimiter</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected java.lang.Object</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getProperty(java.lang.Object, java.lang.String)">getProperty</A></B>(java.lang.Object object, | |
java.lang.String property)</CODE> | |
<BR> | |
Safely retrieves the specified property from the specified object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getTruncateAtWord()">getTruncateAtWord</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getTruncateLength()">getTruncateLength</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#getTruncateSuffix()">getTruncateSuffix</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#list(java.lang.Object)">list</A></B>(java.lang.Object list)</CODE> | |
<BR> | |
Formats a collection or array into the form "A, B and C".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#list(java.lang.Object, java.lang.String)">list</A></B>(java.lang.Object list, | |
java.lang.String delim)</CODE> | |
<BR> | |
Formats a collection or array into the form | |
"A<delim>B<delim>C".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#list(java.lang.Object, java.lang.String, java.lang.String)">list</A></B>(java.lang.Object list, | |
java.lang.String delim, | |
java.lang.String finaldelim)</CODE> | |
<BR> | |
Formats a collection or array into the form | |
"A<delim>B<finaldelim>C".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#list(java.lang.Object, java.lang.String, java.lang.String, java.lang.String)">list</A></B>(java.lang.Object list, | |
java.lang.String delim, | |
java.lang.String finaldelim, | |
java.lang.String property)</CODE> | |
<BR> | |
Formats a specified property of collection or array of objects into the | |
form "A<delim>B<finaldelim>C".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic">DisplayTool.Measurements</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#measure(java.lang.Object)">measure</A></B>(java.lang.Object measureMe)</CODE> | |
<BR> | |
Returns the <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><CODE>DisplayTool.Measurements</CODE></A> of the string value of the specified object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#message(java.lang.String, java.util.Collection)">message</A></B>(java.lang.String format, | |
java.util.Collection args)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#message(java.lang.String, java.lang.Object...)">message</A></B>(java.lang.String format, | |
java.lang.Object... args)</CODE> | |
<BR> | |
Uses <CODE>MessageFormat</CODE> to format the specified String with | |
the specified arguments.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#message(java.lang.String, java.lang.Object)">message</A></B>(java.lang.String format, | |
java.lang.Object arg)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#message(java.lang.String, java.lang.Object, java.lang.Object)">message</A></B>(java.lang.String format, | |
java.lang.Object arg1, | |
java.lang.Object arg2)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#plural(int, java.lang.String)">plural</A></B>(int value, | |
java.lang.String singular)</CODE> | |
<BR> | |
Builds plural form of a passed word if 'value' is plural, otherwise | |
returns 'singular'.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#plural(int, java.lang.String, java.lang.String)">plural</A></B>(int value, | |
java.lang.String singular, | |
java.lang.String plural)</CODE> | |
<BR> | |
Returns 'plural' parameter if passed 'value' is plural, otherwise | |
'singular' is returned.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#printf(java.lang.String, java.lang.Object...)">printf</A></B>(java.lang.String format, | |
java.lang.Object... args)</CODE> | |
<BR> | |
Uses <CODE>String#format(Locale,String,Object...</CODE> to format the specified String | |
with the specified arguments.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setAllowedTags(java.lang.String[])">setAllowedTags</A></B>(java.lang.String[] tags)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setCellLength(int)">setCellLength</A></B>(int maxlen)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setCellSuffix(java.lang.String)">setCellSuffix</A></B>(java.lang.String suffix)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setDefaultAlternate(java.lang.String)">setDefaultAlternate</A></B>(java.lang.String dflt)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setListDelimiter(java.lang.String)">setListDelimiter</A></B>(java.lang.String delim)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setListFinalDelimiter(java.lang.String)">setListFinalDelimiter</A></B>(java.lang.String finalDelim)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setTruncateAtWord(boolean)">setTruncateAtWord</A></B>(boolean atWord)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setTruncateLength(int)">setTruncateLength</A></B>(int maxlen)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#setTruncateSuffix(java.lang.String)">setTruncateSuffix</A></B>(java.lang.String suffix)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#space(int)">space</A></B>(int length)</CODE> | |
<BR> | |
Returns a string of spaces of the specified length.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#stripTags(java.lang.Object)">stripTags</A></B>(java.lang.Object obj)</CODE> | |
<BR> | |
Removes HTML tags from the string value of the specified object and | |
returns the resulting string.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#stripTags(java.lang.Object, java.lang.String...)">stripTags</A></B>(java.lang.Object obj, | |
java.lang.String... allowedTags)</CODE> | |
<BR> | |
Removes all not allowed HTML tags from the string value of the specified | |
object and returns the resulting string.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#truncate(java.lang.Object)">truncate</A></B>(java.lang.Object truncateMe)</CODE> | |
<BR> | |
Limits the string value of 'truncateMe' to the configured max length | |
in characters (default is 30 characters).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#truncate(java.lang.Object, int)">truncate</A></B>(java.lang.Object truncateMe, | |
int maxLength)</CODE> | |
<BR> | |
Limits the string value of 'truncateMe' to 'maxLength' characters.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#truncate(java.lang.Object, int, java.lang.String)">truncate</A></B>(java.lang.Object truncateMe, | |
int maxLength, | |
java.lang.String suffix)</CODE> | |
<BR> | |
Limits the string value of 'truncateMe' to the specified max length in | |
characters.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#truncate(java.lang.Object, int, java.lang.String, boolean)">truncate</A></B>(java.lang.Object truncateMe, | |
int maxLength, | |
java.lang.String suffix, | |
boolean defaultTruncateAtWord)</CODE> | |
<BR> | |
Limits the string value of 'truncateMe' to the latest complete word | |
within the specified maxLength.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#truncate(java.lang.Object, java.lang.String)">truncate</A></B>(java.lang.Object truncateMe, | |
java.lang.String suffix)</CODE> | |
<BR> | |
Limits the string value of 'truncateMe' to the configured max length | |
in characters (default is 30 characters).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.lang.String</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#uncapitalize(java.lang.Object)">uncapitalize</A></B>(java.lang.Object uncapitalizeMe)</CODE> | |
<BR> | |
Changes the first character of the string value of the specified object | |
to lower case and returns the resulting string.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.LocaleConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#getLocale()">getLocale</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#setLocale(java.util.Locale)">setLocale</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(java.util.Map)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked()">isConfigLocked</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()">isSafeMode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig(boolean)">setLockConfig</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode(boolean)">setSafeMode</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="LIST_DELIM_KEY"><!-- --></A><H3> | |
LIST_DELIM_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>LIST_DELIM_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.LIST_DELIM_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="LIST_FINAL_DELIM_KEY"><!-- --></A><H3> | |
LIST_FINAL_DELIM_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>LIST_FINAL_DELIM_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.LIST_FINAL_DELIM_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="TRUNCATE_LENGTH_KEY"><!-- --></A><H3> | |
TRUNCATE_LENGTH_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>TRUNCATE_LENGTH_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.TRUNCATE_LENGTH_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="TRUNCATE_SUFFIX_KEY"><!-- --></A><H3> | |
TRUNCATE_SUFFIX_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>TRUNCATE_SUFFIX_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.TRUNCATE_SUFFIX_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="TRUNCATE_AT_WORD_KEY"><!-- --></A><H3> | |
TRUNCATE_AT_WORD_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>TRUNCATE_AT_WORD_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.TRUNCATE_AT_WORD_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="CELL_LENGTH_KEY"><!-- --></A><H3> | |
CELL_LENGTH_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>CELL_LENGTH_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.CELL_LENGTH_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="CELL_SUFFIX_KEY"><!-- --></A><H3> | |
CELL_SUFFIX_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>CELL_SUFFIX_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.CELL_SUFFIX_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="DEFAULT_ALTERNATE_KEY"><!-- --></A><H3> | |
DEFAULT_ALTERNATE_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>DEFAULT_ALTERNATE_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.DEFAULT_ALTERNATE_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="ALLOWED_TAGS_KEY"><!-- --></A><H3> | |
ALLOWED_TAGS_KEY</H3> | |
<PRE> | |
public static final java.lang.String <B>ALLOWED_TAGS_KEY</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.generic.DisplayTool.ALLOWED_TAGS_KEY">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="defaultDelim"><!-- --></A><H3> | |
defaultDelim</H3> | |
<PRE> | |
private java.lang.String <B>defaultDelim</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultFinalDelim"><!-- --></A><H3> | |
defaultFinalDelim</H3> | |
<PRE> | |
private java.lang.String <B>defaultFinalDelim</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultTruncateLength"><!-- --></A><H3> | |
defaultTruncateLength</H3> | |
<PRE> | |
private int <B>defaultTruncateLength</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultTruncateSuffix"><!-- --></A><H3> | |
defaultTruncateSuffix</H3> | |
<PRE> | |
private java.lang.String <B>defaultTruncateSuffix</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultTruncateAtWord"><!-- --></A><H3> | |
defaultTruncateAtWord</H3> | |
<PRE> | |
private boolean <B>defaultTruncateAtWord</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultCellLength"><!-- --></A><H3> | |
defaultCellLength</H3> | |
<PRE> | |
private int <B>defaultCellLength</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultCellSuffix"><!-- --></A><H3> | |
defaultCellSuffix</H3> | |
<PRE> | |
private java.lang.String <B>defaultCellSuffix</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultAlternate"><!-- --></A><H3> | |
defaultAlternate</H3> | |
<PRE> | |
private java.lang.String <B>defaultAlternate</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="defaultAllowedTags"><!-- --></A><H3> | |
defaultAllowedTags</H3> | |
<PRE> | |
private java.lang.String[] <B>defaultAllowedTags</B></PRE> | |
<DL> | |
<DL> | |
</DL> | |
</DL> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<A NAME="constructor_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Constructor Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="DisplayTool()"><!-- --></A><H3> | |
DisplayTool</H3> | |
<PRE> | |
public <B>DisplayTool</B>()</PRE> | |
<DL> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="configure(org.apache.velocity.tools.generic.ValueParser)"><!-- --></A><H3> | |
configure</H3> | |
<PRE> | |
protected void <B>configure</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> values)</PRE> | |
<DL> | |
<DD>Does the actual configuration. This is protected, so | |
subclasses may share the same ValueParser and call configure | |
at any time, while preventing templates from doing so when | |
configure(Map) is locked. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LocaleConfig.html" title="class in org.apache.velocity.tools.generic">LocaleConfig</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getListDelimiter()"><!-- --></A><H3> | |
getListDelimiter</H3> | |
<PRE> | |
public java.lang.String <B>getListDelimiter</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setListDelimiter(java.lang.String)"><!-- --></A><H3> | |
setListDelimiter</H3> | |
<PRE> | |
protected void <B>setListDelimiter</B>(java.lang.String delim)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getListFinalDelimiter()"><!-- --></A><H3> | |
getListFinalDelimiter</H3> | |
<PRE> | |
public java.lang.String <B>getListFinalDelimiter</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setListFinalDelimiter(java.lang.String)"><!-- --></A><H3> | |
setListFinalDelimiter</H3> | |
<PRE> | |
protected void <B>setListFinalDelimiter</B>(java.lang.String finalDelim)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getTruncateLength()"><!-- --></A><H3> | |
getTruncateLength</H3> | |
<PRE> | |
public int <B>getTruncateLength</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setTruncateLength(int)"><!-- --></A><H3> | |
setTruncateLength</H3> | |
<PRE> | |
protected void <B>setTruncateLength</B>(int maxlen)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getTruncateSuffix()"><!-- --></A><H3> | |
getTruncateSuffix</H3> | |
<PRE> | |
public java.lang.String <B>getTruncateSuffix</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setTruncateSuffix(java.lang.String)"><!-- --></A><H3> | |
setTruncateSuffix</H3> | |
<PRE> | |
protected void <B>setTruncateSuffix</B>(java.lang.String suffix)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getTruncateAtWord()"><!-- --></A><H3> | |
getTruncateAtWord</H3> | |
<PRE> | |
public boolean <B>getTruncateAtWord</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setTruncateAtWord(boolean)"><!-- --></A><H3> | |
setTruncateAtWord</H3> | |
<PRE> | |
protected void <B>setTruncateAtWord</B>(boolean atWord)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCellSuffix()"><!-- --></A><H3> | |
getCellSuffix</H3> | |
<PRE> | |
public java.lang.String <B>getCellSuffix</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setCellSuffix(java.lang.String)"><!-- --></A><H3> | |
setCellSuffix</H3> | |
<PRE> | |
protected void <B>setCellSuffix</B>(java.lang.String suffix)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCellLength()"><!-- --></A><H3> | |
getCellLength</H3> | |
<PRE> | |
public int <B>getCellLength</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setCellLength(int)"><!-- --></A><H3> | |
setCellLength</H3> | |
<PRE> | |
protected void <B>setCellLength</B>(int maxlen)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDefaultAlternate()"><!-- --></A><H3> | |
getDefaultAlternate</H3> | |
<PRE> | |
public java.lang.String <B>getDefaultAlternate</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDefaultAlternate(java.lang.String)"><!-- --></A><H3> | |
setDefaultAlternate</H3> | |
<PRE> | |
protected void <B>setDefaultAlternate</B>(java.lang.String dflt)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAllowedTags()"><!-- --></A><H3> | |
getAllowedTags</H3> | |
<PRE> | |
public java.lang.String[] <B>getAllowedTags</B>()</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setAllowedTags(java.lang.String[])"><!-- --></A><H3> | |
setAllowedTags</H3> | |
<PRE> | |
protected void <B>setAllowedTags</B>(java.lang.String[] tags)</PRE> | |
<DL> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="list(java.lang.Object)"><!-- --></A><H3> | |
list</H3> | |
<PRE> | |
public java.lang.String <B>list</B>(java.lang.Object list)</PRE> | |
<DL> | |
<DD>Formats a collection or array into the form "A, B and C". | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>list</CODE> - A collection or array. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="list(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
list</H3> | |
<PRE> | |
public java.lang.String <B>list</B>(java.lang.Object list, | |
java.lang.String delim)</PRE> | |
<DL> | |
<DD>Formats a collection or array into the form | |
"A<delim>B<delim>C". | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>list</CODE> - A collection or array.<DD><CODE>delim</CODE> - A String. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="list(java.lang.Object, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
list</H3> | |
<PRE> | |
public java.lang.String <B>list</B>(java.lang.Object list, | |
java.lang.String delim, | |
java.lang.String finaldelim)</PRE> | |
<DL> | |
<DD>Formats a collection or array into the form | |
"A<delim>B<finaldelim>C". | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>list</CODE> - A collection or array.<DD><CODE>delim</CODE> - A String.<DD><CODE>finaldelim</CODE> - A String. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="list(java.lang.Object, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
list</H3> | |
<PRE> | |
public java.lang.String <B>list</B>(java.lang.Object list, | |
java.lang.String delim, | |
java.lang.String finaldelim, | |
java.lang.String property)</PRE> | |
<DL> | |
<DD>Formats a specified property of collection or array of objects into the | |
form "A<delim>B<finaldelim>C". | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>list</CODE> - A collection or array.<DD><CODE>delim</CODE> - A String.<DD><CODE>finaldelim</CODE> - A String.<DD><CODE>property</CODE> - An object property to format. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="format(java.util.Collection, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
format</H3> | |
<PRE> | |
protected java.lang.String <B>format</B>(java.util.Collection list, | |
java.lang.String delim, | |
java.lang.String finaldelim, | |
java.lang.String property)</PRE> | |
<DL> | |
<DD>Does the actual formatting of the collection. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="message(java.lang.String, java.util.Collection)"><!-- --></A><H3> | |
message</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public java.lang.String <B>message</B>(java.lang.String format, | |
java.util.Collection args)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="message(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
message</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public java.lang.String <B>message</B>(java.lang.String format, | |
java.lang.Object arg)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="message(java.lang.String, java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
message</H3> | |
<PRE> | |
<FONT SIZE="-1">@Deprecated | |
</FONT>public java.lang.String <B>message</B>(java.lang.String format, | |
java.lang.Object arg1, | |
java.lang.Object arg2)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>Will be unnecessary with Velocity 1.6</I> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="message(java.lang.String, java.lang.Object...)"><!-- --></A><H3> | |
message</H3> | |
<PRE> | |
public java.lang.String <B>message</B>(java.lang.String format, | |
java.lang.Object... args)</PRE> | |
<DL> | |
<DD>Uses <CODE>MessageFormat</CODE> to format the specified String with | |
the specified arguments. If there are no arguments, then the String | |
is returned directly. Please note that the format | |
required here is quite different from that of | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#printf(java.lang.String, java.lang.Object...)"><CODE>printf(String,Object...)</CODE></A>. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>VelocityTools 2.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="printf(java.lang.String, java.lang.Object...)"><!-- --></A><H3> | |
printf</H3> | |
<PRE> | |
public java.lang.String <B>printf</B>(java.lang.String format, | |
java.lang.Object... args)</PRE> | |
<DL> | |
<DD>Uses <CODE>String#format(Locale,String,Object...</CODE> to format the specified String | |
with the specified arguments. Please note that the format | |
required here is quite different from that of | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.html#message(java.lang.String, java.lang.Object...)"><CODE>message(String,Object...)</CODE></A>. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>VelocityTools 2.0</DD> | |
<DT><B>See Also:</B><DD><CODE>Formatter</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="truncate(java.lang.Object)"><!-- --></A><H3> | |
truncate</H3> | |
<PRE> | |
public java.lang.String <B>truncate</B>(java.lang.Object truncateMe)</PRE> | |
<DL> | |
<DD>Limits the string value of 'truncateMe' to the configured max length | |
in characters (default is 30 characters). | |
If the string gets curtailed, the configured suffix | |
(default is "...") is used as the ending of the truncated string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>truncateMe</CODE> - The value to be truncated. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="truncate(java.lang.Object, int)"><!-- --></A><H3> | |
truncate</H3> | |
<PRE> | |
public java.lang.String <B>truncate</B>(java.lang.Object truncateMe, | |
int maxLength)</PRE> | |
<DL> | |
<DD>Limits the string value of 'truncateMe' to 'maxLength' characters. | |
If the string gets curtailed, the configured suffix | |
(default is "...") is used as the ending of the truncated string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>maxLength</CODE> - An int with the maximum length.<DD><CODE>truncateMe</CODE> - The value to be truncated. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="truncate(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
truncate</H3> | |
<PRE> | |
public java.lang.String <B>truncate</B>(java.lang.Object truncateMe, | |
java.lang.String suffix)</PRE> | |
<DL> | |
<DD>Limits the string value of 'truncateMe' to the configured max length | |
in characters (default is 30 characters). | |
If the string gets curtailed, the specified suffix | |
is used as the ending of the truncated string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>truncateMe</CODE> - The value to be truncated.<DD><CODE>suffix</CODE> - A String. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="truncate(java.lang.Object, int, java.lang.String)"><!-- --></A><H3> | |
truncate</H3> | |
<PRE> | |
public java.lang.String <B>truncate</B>(java.lang.Object truncateMe, | |
int maxLength, | |
java.lang.String suffix)</PRE> | |
<DL> | |
<DD>Limits the string value of 'truncateMe' to the specified max length in | |
characters. If the string gets curtailed, the specified suffix is used as | |
the ending of the truncated string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>truncateMe</CODE> - The value to be truncated.<DD><CODE>maxLength</CODE> - An int with the maximum length.<DD><CODE>suffix</CODE> - A String. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="truncate(java.lang.Object, int, java.lang.String, boolean)"><!-- --></A><H3> | |
truncate</H3> | |
<PRE> | |
public java.lang.String <B>truncate</B>(java.lang.Object truncateMe, | |
int maxLength, | |
java.lang.String suffix, | |
boolean defaultTruncateAtWord)</PRE> | |
<DL> | |
<DD>Limits the string value of 'truncateMe' to the latest complete word | |
within the specified maxLength. If the string gets curtailed, the | |
specified suffix is used as the ending of the truncated string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>truncateMe</CODE> - The value to be truncated.<DD><CODE>maxLength</CODE> - An int with the maximum length.<DD><CODE>suffix</CODE> - A String.<DD><CODE>defaultTruncateAtWord</CODE> - Truncate at a word boundary if true. | |
<DT><B>Returns:</B><DD>A String.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="space(int)"><!-- --></A><H3> | |
space</H3> | |
<PRE> | |
public java.lang.String <B>space</B>(int length)</PRE> | |
<DL> | |
<DD>Returns a string of spaces of the specified length. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>length</CODE> - the number of spaces to return</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="cell(java.lang.Object)"><!-- --></A><H3> | |
cell</H3> | |
<PRE> | |
public java.lang.String <B>cell</B>(java.lang.Object obj)</PRE> | |
<DL> | |
<DD>Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the default cell size. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the value to be put in the 'cell'</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="cell(java.lang.Object, int)"><!-- --></A><H3> | |
cell</H3> | |
<PRE> | |
public java.lang.String <B>cell</B>(java.lang.Object obj, | |
int cellsize)</PRE> | |
<DL> | |
<DD>Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the specified cell size. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the value to be put in the 'cell'<DD><CODE>cellsize</CODE> - the size of the cell into which the object must be placed</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="cell(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
cell</H3> | |
<PRE> | |
public java.lang.String <B>cell</B>(java.lang.Object obj, | |
java.lang.String suffix)</PRE> | |
<DL> | |
<DD>Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the default cell size. | |
If truncation is necessary, the specified suffix will replace the end of | |
the string value to indicate that. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the value to be put in the 'cell'<DD><CODE>suffix</CODE> - the suffix to put at the end of any values that need truncating | |
to indicate that they've been truncated</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="cell(java.lang.Object, int, java.lang.String)"><!-- --></A><H3> | |
cell</H3> | |
<PRE> | |
public java.lang.String <B>cell</B>(java.lang.Object obj, | |
int cellsize, | |
java.lang.String suffix)</PRE> | |
<DL> | |
<DD>Truncates or pads the string value of the specified object as necessary | |
to ensure that the returned string's length equals the specified cell size. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the value to be put in the 'cell'<DD><CODE>cellsize</CODE> - the size of the cell into which the object must be placed<DD><CODE>suffix</CODE> - the suffix to put at the end of any values that need truncating | |
to indicate that they've been truncated</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="capitalize(java.lang.Object)"><!-- --></A><H3> | |
capitalize</H3> | |
<PRE> | |
public java.lang.String <B>capitalize</B>(java.lang.Object capitalizeMe)</PRE> | |
<DL> | |
<DD>Changes the first character of the string value of the specified object | |
to upper case and returns the resulting string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>capitalizeMe</CODE> - The value to be capitalized.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="uncapitalize(java.lang.Object)"><!-- --></A><H3> | |
uncapitalize</H3> | |
<PRE> | |
public java.lang.String <B>uncapitalize</B>(java.lang.Object uncapitalizeMe)</PRE> | |
<DL> | |
<DD>Changes the first character of the string value of the specified object | |
to lower case and returns the resulting string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>uncapitalizeMe</CODE> - The value to be uncapitalized.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="alt(java.lang.Object)"><!-- --></A><H3> | |
alt</H3> | |
<PRE> | |
public java.lang.Object <B>alt</B>(java.lang.Object checkMe)</PRE> | |
<DL> | |
<DD>Returns a configured default value if specified value is null. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>checkMe</CODE> - | |
<DT><B>Returns:</B><DD>a configured default value if the specified value is null.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="alt(java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
alt</H3> | |
<PRE> | |
public java.lang.Object <B>alt</B>(java.lang.Object checkMe, | |
java.lang.Object alternate)</PRE> | |
<DL> | |
<DD>Returns the second argument if first argument specified is null. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>checkMe</CODE> - <DD><CODE>alternate</CODE> - | |
<DT><B>Returns:</B><DD>the second argument if the first is null.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="br(java.lang.Object)"><!-- --></A><H3> | |
br</H3> | |
<PRE> | |
public java.lang.String <B>br</B>(java.lang.Object obj)</PRE> | |
<DL> | |
<DD>Inserts HTML line break tag (<br />) in front of all newline | |
characters of the string value of the specified object and returns the | |
resulting string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="stripTags(java.lang.Object)"><!-- --></A><H3> | |
stripTags</H3> | |
<PRE> | |
public java.lang.String <B>stripTags</B>(java.lang.Object obj)</PRE> | |
<DL> | |
<DD>Removes HTML tags from the string value of the specified object and | |
returns the resulting string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="stripTags(java.lang.Object, java.lang.String...)"><!-- --></A><H3> | |
stripTags</H3> | |
<PRE> | |
public java.lang.String <B>stripTags</B>(java.lang.Object obj, | |
java.lang.String... allowedTags)</PRE> | |
<DL> | |
<DD>Removes all not allowed HTML tags from the string value of the specified | |
object and returns the resulting string. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - <DD><CODE>allowedTags</CODE> - An array of allowed tag names (i.e. "h1","br","img")</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="plural(int, java.lang.String)"><!-- --></A><H3> | |
plural</H3> | |
<PRE> | |
public java.lang.String <B>plural</B>(int value, | |
java.lang.String singular)</PRE> | |
<DL> | |
<DD>Builds plural form of a passed word if 'value' is plural, otherwise | |
returns 'singular'. Plural form is built using some basic English | |
language rules for nouns which does not guarantee correct syntax of a | |
result in all cases. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - <DD><CODE>singular</CODE> - Singular form of a word.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="plural(int, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
plural</H3> | |
<PRE> | |
public java.lang.String <B>plural</B>(int value, | |
java.lang.String singular, | |
java.lang.String plural)</PRE> | |
<DL> | |
<DD>Returns 'plural' parameter if passed 'value' is plural, otherwise | |
'singular' is returned. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - <DD><CODE>singular</CODE> - Singular form of a word.<DD><CODE>plural</CODE> - Plural form of a word.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getProperty(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
getProperty</H3> | |
<PRE> | |
protected java.lang.Object <B>getProperty</B>(java.lang.Object object, | |
java.lang.String property)</PRE> | |
<DL> | |
<DD>Safely retrieves the specified property from the specified object. | |
Subclasses that wish to perform more advanced, efficient, or just | |
different property retrieval methods should override this method to do | |
so. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="measure(java.lang.Object)"><!-- --></A><H3> | |
measure</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic">DisplayTool.Measurements</A> <B>measure</B>(java.lang.Object measureMe)</PRE> | |
<DL> | |
<DD>Returns the <A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><CODE>DisplayTool.Measurements</CODE></A> of the string value of the specified object. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DateTool.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/velocity/tools/generic/DisplayTool.Measurements.html" title="class in org.apache.velocity.tools.generic"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/velocity/tools/generic/DisplayTool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DisplayTool.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright (c) 2003-2007 Apache Software Foundation | |
</BODY> | |
</HTML> |