com.ivata.mask.web.field
Class DefaultFieldWriterFactory

java.lang.Object
  com.ivata.mask.web.field.DefaultFieldWriterFactory

All Implemented Interfaces:

FieldWriterFactory

public class DefaultFieldWriterFactory

extends java.lang.Object

implements FieldWriterFactory

Use this utility class to generate an appropriate field writer for a given mask and field.

Since:

ivata masks 0.1 (2004-05-14)

Version:

$Revision: 1.9 $

Author:

Colin MacLeod colin.macleod@ivata.com

Field Summary

Fields inherited from interface com.ivata.mask.web.field.FieldWriterFactory

APPLICATION_ATTRIBUTE

Constructor Summary

DefaultFieldWriterFactory(com.ivata.mask.persistence.PersistenceManager persistenceManagerParam, java.lang.String actionPageParam)
Construct a writer factory.

Method Summary

protected java.lang.String	getActionPage() Page of the Struts action to which we'll link value objects to.
FieldWriter	getFieldWriter(com.ivata.mask.valueobject.ValueObject valueObjectParam, com.ivata.mask.field.Field fieldParam, com.ivata.mask.field.Field subFieldParam, boolean hidden) Get a field writer appropriate to the given field.
protected FieldWriter	newHiddenFieldWriter(com.ivata.mask.field.Field fieldParam, com.ivata.mask.field.FieldValueConvertor convertorParam, HTMLFormatter formatterParam) Override this method if you need a different field writer for hidden fields.
protected FieldWriter	newTextAreaFieldWriter(com.ivata.mask.field.Field field, com.ivata.mask.field.FieldValueConvertor convertor, HTMLFormatter formatterParam) Override this method if you need a different field writer for text areas.
protected FieldWriter	newTextFieldWriter(com.ivata.mask.field.Field fieldParam, com.ivata.mask.field.FieldValueConvertor convertorParam, HTMLFormatter formatterParam) Override this method if you need a different field writer for text fields.
protected FieldWriter	newValueObjectFieldWriter(com.ivata.mask.field.Field fieldParam, java.lang.String actionPageParam, java.util.Collection allValueObjectsParam, HTMLFormatter formatterParam, int listHeightParam, boolean multipleParam) Override this method if you need a different field writer for value objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFieldWriterFactory

public DefaultFieldWriterFactory(com.ivata.mask.persistence.PersistenceManager persistenceManagerParam,
                                 java.lang.String actionPageParam)

Construct a writer factory.

Parameters:

persistenceManagerParam - used to retrieve value objects for a value

actionPageParam - page of the action to which we'll link value objects to.

Method Detail

getActionPage

protected final java.lang.String getActionPage()

Page of the Struts action to which we'll link value objects to. This must be a full, webapp-relative link, starting with '/'.

Returns:

Returns the actionPage.

getFieldWriter

public final FieldWriter getFieldWriter(com.ivata.mask.valueobject.ValueObject valueObjectParam,
                                        com.ivata.mask.field.Field fieldParam,
                                        com.ivata.mask.field.Field subFieldParam,
                                        boolean hidden)
                                 throws com.ivata.mask.util.SystemException

Get a field writer appropriate to the given field.

Specified by:

getFieldWriter in interface FieldWriterFactory

Parameters:

valueObjectParam - Field for which to return an appropriate field writer.

fieldParam - Field for which to return an appropriate field writer.

subFieldParam - Sub-field within the main field, if the field is a value object. but the value stored in a hidden field.

hidden - If true, overrides the field definition, and gets a writer for a hidden field.

Returns:

valid field writer for the field provided.

Throws:

com.ivata.mask.util.SystemException - thrown if the writer cannot be retrieved for any reason.

newTextAreaFieldWriter

protected FieldWriter newTextAreaFieldWriter(com.ivata.mask.field.Field field,
                                             com.ivata.mask.field.FieldValueConvertor convertor,
                                             HTMLFormatter formatterParam)

Override this method if you need a different field writer for text areas.

Parameters:

field - Refer to TextAreaFieldWriter.TextAreaFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

convertor - Refer to TextAreaFieldWriter.TextAreaFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

formatterParam - Refer to TextAreaFieldWriter.TextAreaFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

Returns:

valid text area field writer.

newHiddenFieldWriter

protected FieldWriter newHiddenFieldWriter(com.ivata.mask.field.Field fieldParam,
                                           com.ivata.mask.field.FieldValueConvertor convertorParam,
                                           HTMLFormatter formatterParam)

Override this method if you need a different field writer for hidden fields.

Parameters:

fieldParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

convertorParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

formatterParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

Returns:

valid text field writer.

newTextFieldWriter

protected FieldWriter newTextFieldWriter(com.ivata.mask.field.Field fieldParam,
                                         com.ivata.mask.field.FieldValueConvertor convertorParam,
                                         HTMLFormatter formatterParam)

Override this method if you need a different field writer for text fields.

Parameters:

fieldParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

convertorParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

formatterParam - Refer to TextFieldWriter.TextFieldWriter(com.ivata.mask.field.Field, com.ivata.mask.field.FieldValueConvertor, com.ivata.mask.web.format.HTMLFormatter).

Returns:

valid text field writer.

newValueObjectFieldWriter

protected FieldWriter newValueObjectFieldWriter(com.ivata.mask.field.Field fieldParam,
                                                java.lang.String actionPageParam,
                                                java.util.Collection allValueObjectsParam,
                                                HTMLFormatter formatterParam,
                                                int listHeightParam,
                                                boolean multipleParam)

Override this method if you need a different field writer for value objects.

Parameters:

fieldParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

actionPageParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

allValueObjectsParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

formatterParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

listHeightParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

multipleParam - Refer to ValueObjectFieldWriter.ValueObjectFieldWriter(com.ivata.mask.field.Field, java.lang.String, java.util.Collection, com.ivata.mask.web.format.HTMLFormatter, int, boolean).

Returns:

valid field writer.