com.ivata.mask.web.format
Class HTMLFormatter

java.lang.Object
  com.ivata.mask.web.format.HTMLFormatter

public class HTMLFormatter

extends java.lang.Object

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 addfor each format on the HTMLFormatter instance. Passing a text to formatwill 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)

Version:

$Revision: 1.3 $

Author:

Colin MacLeod colin.macleod@ivata.com

Constructor Summary

HTMLFormatter()
Creates a new instance of HTMLFormatter with default settings.

Method Summary

void	add(HTMLFormat format) Adds the format to the internal list of HTMLFormat instances this formatter holds.
HTMLFormat	findFormat(java.lang.Class findClass) Locates a format in the object, identified by class.
java.lang.String	format(java.lang.String formatString) This is the most important method of all.
static java.lang.String	getAttributeNotNull(java.lang.String attribute, java.lang.Object objectParam) If the object is not null, fill the attribute with this value otherwise return nothing.
static java.lang.String	getBooleanAttribute(java.lang.String attribute, boolean check) If the boolean is true, fill the attribute with no value, otherwise return nothing.
java.util.List	getFormats() Get the internal list of all of the formats used by this formatter.
protected void	setFormats(java.util.List formatsParam) Set the internal list of all of the formats used by this formatter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLFormatter

public HTMLFormatter()

Creates a new instance of HTMLFormatter with default settings.

Method Detail

getAttributeNotNull

public static final java.lang.String getAttributeNotNull(java.lang.String attribute,
                                                         java.lang.Object objectParam)

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 if objectParam is non-null

objectParam - an Object to assign attribute to if it is non-null

Returns:

if objectParam is not null, a string assigning the attribute sAttrubte to the value of objectParam.toString(), otherwise an empty string.

See Also:

getBooleanAttribute(String attribute, boolean check), #getNotNull(Object o, String nullString)

getBooleanAttribute

public static final java.lang.String getBooleanAttribute(java.lang.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 is true.

check - a boolean to evaluate.

Returns:

if check is true, the attribute string, otherwise an empty string.

See Also:

getAttributeNotNull(String attribute, Object o), #getNotNull(Object o)

format

public java.lang.String format(java.lang.String formatString)

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

Returns:

String containing formatted text, according to the current state of this HTMLFormatter instance.

See Also:

HTMLFormat.format(java.lang.String)

add

public final void add(HTMLFormat format)

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 all existing formats.

findFormat

public final HTMLFormat findFormat(java.lang.Class findClass)

Locates a format in the object, identified by class.

Parameters:

findClass - the Class of the format to locate in the formatter's internal list.

Returns:

first format found with the class specified, or null if no format with this class has been set in the formatter

getFormats

public final java.util.List getFormats()

Get the internal list of all of the formats used by this formatter.

Returns:

a Vector containing all of the formats from this formatter.

setFormats

protected final void setFormats(java.util.List formatsParam)

Set the internal list of all of the formats used by this formatter.

Parameters:

formatsParam - a Vector containing all of the formats from this formatter.