| java.lang.Object
 com.ivata.mask.web.format.HTMLFormatter
| HTMLFormatter | | public class HTMLFormatter extends Object (Code) | |
This class defines a standard way of formatting HTML. It can be used as as a
parameter to methods from other classes indicating that output should be
truncated, spaces should be converted to non-breaking, or the string should
be parsed for URLs.
The actual conversions are achieved by add-in classes, with
as their superclass. This means the formatter can provided a rich
selection of different formats without having knowledge of the processing of
each one.
To use this class, created an instance of the formats you wish to use, and an
instance of this class too. Call any methods on the formats to set up the
exact function of each one. Then call
HTMLFormatter.add add for each format on the
HTMLFormatter instance. Passing a text to
HTMLFormatter.format format will ensure that each format is applied in the order
in which they were added to the formatter.
since:
ivata masks 0.2 (2001-10-03)
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.5 $ |
| Constructor Summary | |
| public | HTMLFormatter()
Creates a new instance of HTMLFormatter with default settings. |
| Method Summary | |
| final public void | add(HTMLFormat format)
Adds the format to the internal list of HTMLFormat
instances this formatter holds.
Parameters:
format - the format instance to add. | | final public HTMLFormat | findFormat(Class findClass)
Locates a format in the object, identified by class.
Parameters:
findClass - the Class of the format to locate in theformatter's internal list. | | public String | format(String formatString)
This is the most important method of all.
First call the methods setConvert.... | | final public static String | getAttributeNotNull(String attribute, Object objectParam)
If the object is not null, fill the attribute with this value otherwise
return nothing. | | final public static String | getBooleanAttribute(String attribute, boolean check)
If the boolean is true, fill the attribute with no value, otherwise
return nothing.
This is useful for HTML tags where you want to create an attribute only
if the condition is true.
Parameters:
attribute - the attribute name of the attribute to be set if check istrue.
Parameters:
check - a boolean to evaluate. | | final public List | getFormats()
Get the internal list of all of the formats used by this formatter. | | final protected void | setFormats(List formatsParam)
Set the internal list of all of the formats used by this formatter. |
| HTMLFormatter | | public HTMLFormatter()(Code) | | Creates a new instance of HTMLFormatter with default settings.
|
| add | | final public void add(HTMLFormat format)(Code) | |
Adds the format to the internal list of HTMLFormat
instances this formatter holds.
Parameters:
format - the format instance to add. This will be processed after allexisting formats. |
| findFormat | | final public HTMLFormat findFormat(Class findClass)(Code) | |
Locates a format in the object, identified by class.
Parameters:
findClass - the Class of the format to locate in theformatter's internal list. first format found with the class specified, or nullif no format with this class has been set in the formatter |
| format | | public String format(String formatString)(Code) | |
This is the most important method of all.
First call the methods setConvert.... to specify how to convert the
string, then use this method to format the given string according to the
set rules
.
Parameters:
formatString - String to format String containing formatted text, according to the current stateof this HTMLFormatter instance.
See Also: HTMLFormat.format |
| getAttributeNotNull | | final public static String getAttributeNotNull(String attribute, Object objectParam)(Code) | |
If the object is not null, fill the attribute with this value otherwise
return nothing.
This is useful for HTML tags where you want to created an attribute value
only if the object objectParam is non-null.
Parameters:
attribute - the attribute name of the attribute to be set ifobjectParam is non-null
Parameters:
objectParam - an Object to assign attribute to if it is non-null if objectParam is not null, a string assigning theattribute sAttrubte to the value ofobjectParam.toString(), otherwise an emptystring.
See Also: HTMLFormatter.getBooleanAttribute(String attribute,boolean check)
See Also: HTMLFormatter.getNotNull(Object o,String nullString) |
| getBooleanAttribute | | final public static String getBooleanAttribute(String attribute, boolean check)(Code) | |
If the boolean is true, fill the attribute with no value, otherwise
return nothing.
This is useful for HTML tags where you want to create an attribute only
if the condition is true.
Parameters:
attribute - the attribute name of the attribute to be set if check istrue.
Parameters:
check - a boolean to evaluate. if check is true, the attribute string, otherwisean empty string.
See Also: HTMLFormatter.getAttributeNotNull(String attribute,Object o)
See Also: HTMLFormatter.getNotNull(Object o) |
| getFormats | | final public List getFormats()(Code) | |
Get the internal list of all of the formats used by this formatter.
a Vector containing all of the formats from thisformatter. |
| setFormats | | final protected void setFormats(List formatsParam)(Code) | |
Set the internal list of all of the formats used by this formatter.
Parameters:
formatsParam - a Vector containing all of the formats fromthis formatter. |
|
|