com.ivata.mask.web.field
Interface FieldWriterFactory

All Known Implementing Classes:

DefaultFieldWriterFactory

public interface FieldWriterFactory

Use implementations of this interface to generate an appropriate field writer for a given mask and field.

Since:

ivata masks 0.1 (2004-05-14)

Version:

$Revision: 1.6 $

Author:

Colin MacLeod colin.macleod@ivata.com

Field Summary

static java.lang.String

APPLICATION_ATTRIBUTE Name of the attribute to set in the application scope.

Method Summary

FieldWriter

getFieldWriter(com.ivata.mask.valueobject.ValueObject valueObject, com.ivata.mask.field.Field field, com.ivata.mask.field.Field subField, boolean hidden) Get a field writer appropriate to the given field.

Field Detail

APPLICATION_ATTRIBUTE

public static final java.lang.String APPLICATION_ATTRIBUTE

Name of the attribute to set in the application scope. You must store an appropriate instance of this class in this attribute, so that the field tag can locate the field writer factory.

See Also:

Constant Field Values

Method Detail

getFieldWriter

public FieldWriter getFieldWriter(com.ivata.mask.valueobject.ValueObject valueObject,
                                  com.ivata.mask.field.Field field,
                                  com.ivata.mask.field.Field subField,
                                  boolean hidden)
                           throws com.ivata.mask.util.SystemException

Get a field writer appropriate to the given field.

Parameters:

valueObject - Value object on which to operate.

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

subField - If this field writer is for a sublist, defines the field within a field which is actually being displayed.

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 - if the writer cannot be retrieved for any reason.