er.extensions.formatters
Class ERXSimpleHTMLFormatter

java.lang.Object
  java.text.Format
      er.extensions.formatters.ERXSimpleHTMLFormatter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ERXSimpleHTMLFormatter
extends java.text.Format

This is a simple class for converting ASCII strings to HTML and vice versa. In the current implementation, all this class does is convert newlines to HTML breaks and tab characters to HTML <spacer> tags.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

java.text.Format.Field

Field Summary

static org.apache.log4j.Logger

log logging support

Constructor Summary

ERXSimpleHTMLFormatter()

Method Summary

java.lang.String	applyFormat(java.lang.Object anObject) Applies the HTML formatting to a given string object replacing ASCII formatting with HTML formatting.
java.lang.StringBuffer	format(java.lang.Object object, java.lang.StringBuffer buffer, java.text.FieldPosition fp) The FieldPosition is not important, so this method just calls applyFormat and appends that string to the buffer.
static ERXSimpleHTMLFormatter	formatter() Method used to retrieve the shared instance of the html formatter.
java.lang.String	htmlStringFromString(java.lang.String aString) Converts an ASCII string into an HTML string.
protected static java.lang.String	HTMLTab() Simple method used to get the url to the spacer gif s.gif from the WOResourceManager.
java.lang.Object	parseObject(java.lang.String inString) Converts an HTML string into an ASCII string.
java.lang.Object	parseObject(java.lang.String string, java.text.ParsePosition p) Converts an HTML string into an ASCII string starting from a given parse position.
java.lang.String	stringForObjectValue(java.lang.Object anObject) Accessor method used to convert an ASCII string into an HTML string.

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

Constructor Detail

ERXSimpleHTMLFormatter

public ERXSimpleHTMLFormatter()

Method Detail

HTMLTab

protected static java.lang.String HTMLTab()

Simple method used to get the url to the spacer gif s.gif from the WOResourceManager.

Returns:

url to the space gif image set in an image ref

formatter

public static ERXSimpleHTMLFormatter formatter()

Method used to retrieve the shared instance of the html formatter.

Returns:

shared instance of the html formatter

htmlStringFromString

public java.lang.String htmlStringFromString(java.lang.String aString)

Converts an ASCII string into an HTML string.

Parameters:

aString - to be converted

Returns:

html-ified string

format

public java.lang.StringBuffer format(java.lang.Object object,
                                     java.lang.StringBuffer buffer,
                                     java.text.FieldPosition fp)

The FieldPosition is not important, so this method just calls applyFormat and appends that string to the buffer.

Specified by:

format in class java.text.Format

Parameters:

object - to be formatted

buffer - to have the formatted object appended to

fp - ignored parameter

Returns:

buffer after having the format appended to it.

applyFormat

public java.lang.String applyFormat(java.lang.Object anObject)
                             throws java.lang.IllegalArgumentException

Applies the HTML formatting to a given string object replacing ASCII formatting with HTML formatting.

Parameters:

anObject - to have the formatting applied to

Returns:

formatted object

Throws:

java.lang.IllegalArgumentException

parseObject

public java.lang.Object parseObject(java.lang.String inString)
                             throws java.text.ParseException

Converts an HTML string into an ASCII string.

Overrides:

parseObject in class java.text.Format

Parameters:

inString - HTML string

Returns:

ASCII-fied string

Throws:

java.text.ParseException

parseObject

public java.lang.Object parseObject(java.lang.String string,
                                    java.text.ParsePosition p)

Converts an HTML string into an ASCII string starting from a given parse position.

Specified by:

parseObject in class java.text.Format

Parameters:

string - HTML string

p - current parsing position

Returns:

ASCII representation of the string

stringForObjectValue

public java.lang.String stringForObjectValue(java.lang.Object anObject)
                                      throws java.lang.IllegalArgumentException

Accessor method used to convert an ASCII string into an HTML string.

Parameters:

anObject - string to convert

Throws:

java.lang.IllegalArgumentException