com.ivata.mask.web.field.text
Class TextAreaFieldWriter

java.lang.Object
  com.ivata.mask.web.field.text.TextAreaFieldWriter

All Implemented Interfaces:

FieldWriter

public class TextAreaFieldWriter

extends java.lang.Object

implements FieldWriter

This writer is used to display fields as <textarea>...</textarea> fields.

Since:

ivata masks 0.1 (2004-05-14)

Version:

$Revision: 1.6 $

Author:

Colin MacLeod colin.macleod@ivata.com

Constructor Summary

TextAreaFieldWriter(com.ivata.mask.field.Field fieldParam, com.ivata.mask.field.FieldValueConvertor convertorParam, HTMLFormatter formatterParam)
Construct a field writer.

Method Summary

protected AttributesWriter	getAttributesWriter() Access the attributes writer, which is responsible for converting the field attributes into text.
protected com.ivata.mask.field.Field	getField() Access the field to be displayed.
protected HTMLFormatter	getFormatter() Used to format the displayed, usually ensuring line breaks are converted into HTML.
void	removeAttribute(java.lang.String name) Refer to FieldWriter#clearAttribute.
void	setAttribute(java.lang.String name, java.lang.String value) Refer to FieldWriter.setAttribute(java.lang.String, java.lang.String).
java.lang.String	write(javax.servlet.jsp.PageContext pageContext, com.ivata.mask.valueobject.ValueObject valueObject, boolean displayOnly) Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).

Methods inherited from class java.lang.Object

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

Constructor Detail

TextAreaFieldWriter

public TextAreaFieldWriter(com.ivata.mask.field.Field fieldParam,
                           com.ivata.mask.field.FieldValueConvertor convertorParam,
                           HTMLFormatter formatterParam)

Construct a field writer.

Parameters:

fieldParam - defines the field to be displayed.

convertorParam - converts objects into strings for display.

formatterParam - Refer to getFormatter().

Method Detail

getAttributesWriter

protected final AttributesWriter getAttributesWriter()

Access the attributes writer, which is responsible for converting the field attributes into text.

Returns:

attributes writer.

getField

protected final com.ivata.mask.field.Field getField()

Access the field to be displayed.

Returns:

field to be displayed.

getFormatter

protected final HTMLFormatter getFormatter()

Used to format the displayed, usually ensuring line breaks are converted into HTML.

Returns:

Returns the formatter.

removeAttribute

public void removeAttribute(java.lang.String name)

Refer to FieldWriter#clearAttribute.

Specified by:

removeAttribute in interface FieldWriter

Parameters:

name - Refer to FieldWriter#clearAttribute.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

Refer to FieldWriter.setAttribute(java.lang.String, java.lang.String).

Specified by:

setAttribute in interface FieldWriter

Parameters:

name - Refer to FieldWriter.setAttribute(java.lang.String, java.lang.String).

value - Refer to FieldWriter.setAttribute(java.lang.String, java.lang.String).

write

public final java.lang.String write(javax.servlet.jsp.PageContext pageContext,
                                    com.ivata.mask.valueobject.ValueObject valueObject,
                                    boolean displayOnly)

Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).

Specified by:

write in interface FieldWriter

Parameters:

pageContext - Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).

valueObject - Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).

displayOnly - Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).

Returns:

Refer to FieldWriter.write(javax.servlet.jsp.PageContext, com.ivata.mask.valueobject.ValueObject, boolean).