com.ivata.mask.web.format
Class WordWrapFormat

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

All Implemented Interfaces:

HTMLFormat

public class WordWrapFormat

extends java.lang.Object

implements HTMLFormat

This format word-wraps each line of text to a user-specified column.

Note: by default, no wrapping will take place. You must call setWordWrapColumn.

Since:

ivata masks 0.4 (2002-06-19)

Version:

$Revision: 1.3 $

Author:

Colin MacLeod colin.macleod@ivata.com

Constructor Summary

WordWrapFormat()

Method Summary

java.lang.String	format(java.lang.String hTMLTextParam) Format the string given in hTMLText, wrapped to the column provided by calling setWordWrapColumn.
int	getWordWrapColumn() Private member used to store the value set in setWordWrapColumn.
void	setWordWrapColumn(int wordWrapColumnParam) Private member used to store the value set in setWordWrapColumn.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordWrapFormat

public WordWrapFormat()

Method Detail

format

public final java.lang.String format(java.lang.String hTMLTextParam)

Format the string given in hTMLText, wrapped to the column provided by calling setWordWrapColumn.

Note: by default, no wrapping will take place.

Specified by:

format in interface HTMLFormat

Parameters:

hTMLTextParam - the text to truncate.

Returns:

text wrapped at the column specified.

getWordWrapColumn

public final int getWordWrapColumn()

Private member used to store the value set in setWordWrapColumn.

Returns:

the current value of wordWrapColumn.

See Also:

setWordWrapColumn(int wordWrapColumn)

setWordWrapColumn

public final void setWordWrapColumn(int wordWrapColumnParam)

Private member used to store the value set in setWordWrapColumn.

Parameters:

wordWrapColumnParam - the new value of wordWrapColumn.

See Also:

setWordWrapColumn(int wordWrapColumn)