com.ivata.mask
Class MaskImpl

java.lang.Object
  com.ivata.mask.group.GroupImpl
      com.ivata.mask.MaskImpl

All Implemented Interfaces:

Group, Mask, java.io.Serializable

public class MaskImpl

extends GroupImpl

implements Mask

In the Masks display configuration, a mask extends a group to define which fields come first and last, or the fields which should appear explicitly.

Don't try to instantiate this class - use the mask factory instead.

Since:

ivata masks 0.1 (2004-05-15) colin.macleod@ivata.com

Author:

Colin MacLeod

See Also:

Serialized Form

Constructor Summary

MaskImpl(java.lang.Class dOClassParam, Group parent, java.lang.String nameParam)
Create a mask with the specified parent.

Method Summary

void	addIncludePath(java.lang.String includePathParam) Refer to Mask.getIncludePaths().
java.lang.Class	getDOClass() Get the dependent object class associated with this mask.
java.util.List	getFields() Get all the fields which should be displayed/hidden (not excluded) in this mask, in order.
java.util.List	getIncludePaths() Refer to Mask.getIncludePaths().

Methods inherited from class com.ivata.mask.group.GroupImpl

addExcludedFieldName, addField, addFilter, addFirstFieldName, addIncludedFieldName, addLastFieldName, getAllExcludedFieldNames, getAllExcludedFieldNames, getAllFirstFieldNames, getAllFirstFieldNames, getAllLastFieldNames, getAllLastFieldNames, getExcludedFieldNames, getField, getFilters, getFirstFieldNames, getIncludedFieldNames, getLastFieldNames, getName, getParent, isDisplayOnly, isParentFirstFieldNamesReplaced, isParentLastFieldNamesReplaced, setDisplayOnly, setParentFirstFieldNamesReplaced, setParentLastFieldNamesReplaced

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ivata.mask.group.Group

getAllExcludedFieldNames, getAllFirstFieldNames, getAllLastFieldNames, getExcludedFieldNames, getField, getFilters, getFirstFieldNames, getIncludedFieldNames, getLastFieldNames, getName, getParent, isDisplayOnly, isParentFirstFieldNamesReplaced, isParentLastFieldNamesReplaced

Constructor Detail

MaskImpl

public MaskImpl(java.lang.Class dOClassParam,
                Group parent,
                java.lang.String nameParam)

Create a mask with the specified parent.

Parameters:

dOClassParam - The class of the data object displayed in this mask.

parent - Group which contains this mask, or parent mask this mask extends.

nameParam - Name of the mask. This is used in combination with the class name to build the identifier for each mask uniquely.

Method Detail

addIncludePath

public final void addIncludePath(java.lang.String includePathParam)

Refer to Mask.getIncludePaths().

Parameters:

includePathParam - The include path to add to the list.

getDOClass

public final java.lang.Class getDOClass()

Get the dependent object class associated with this mask.

Specified by:

getDOClass in interface Mask

Returns:

The class of the data object displayed in this mask.

getFields

public final java.util.List getFields()

Get all the fields which should be displayed/hidden (not excluded) in this mask, in order.

Specified by:

getFields in interface Mask

Returns:

All field names apart from those explicitly excluded.

getIncludePaths

public java.util.List getIncludePaths()

Refer to Mask.getIncludePaths().

Specified by:

getIncludePaths in interface Mask

Returns:

Returns all include paths.