| com.ivata.mask.MaskFactory
All known Subclasses: com.ivata.mask.DefaultMaskFactory,
| MaskFactory | | public interface MaskFactory (Code) | | An instance of this interface is used to generate all masks and groups in the
project.
since:
ivata masks 0.1 (2004-05-14)
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.6 $
See Also: DefaultMaskFactory |
| Method Summary | |
| String | getDefaultInputMask()
Get the name of the default mask/screen used for user input. | | String | getDefaultListMask()
Get the name of the default mask/screen used to list a base class. | | Group | getGroup(String id)
Get a group definition referenced by its id.
Parameters:
id - unique identifier of the group. | | Mask | getMask(Class valueObjectClass, String type)
Get a mask, identified by its class and type.
Parameters:
valueObjectClass - class of value object for the mask to be returned.
Parameters:
type - optional parameter defining multiple masks for the same valueobject. | | Mask | getMask(Class valueObjectClass)
Get the default mask for a value object class.
Parameters:
valueObjectClass - class of value object for the mask to be returned. | | Mask | getMask(Field parentField, Class valueObjectClass)
Get a mask, identified by its parent field, and class. | | boolean | isConfigured()
Discover whether or not this object has been configured. | | void | readConfiguration(InputStream inputStream)
Get the configuration represented by the document provided. |
| getDefaultInputMask | | String getDefaultInputMask()(Code) | |
Get the name of the default mask/screen used for user input.
name of the default mask/screen used for user input. |
| getDefaultListMask | | String getDefaultListMask()(Code) | |
Get the name of the default mask/screen used to list a base class.
name of the default mask/screen used to list a base class. |
| getGroup | | Group getGroup(String id)(Code) | |
Get a group definition referenced by its id.
Parameters:
id - unique identifier of the group. Group definition with the id provided, or null ifthere is no such group. |
| getMask | | Mask getMask(Class valueObjectClass, String type)(Code) | |
Get a mask, identified by its class and type.
Parameters:
valueObjectClass - class of value object for the mask to be returned.
Parameters:
type - optional parameter defining multiple masks for the same valueobject. May be null. Mask definition with the id provided, or null ifthere is no such mask. |
| getMask | | Mask getMask(Class valueObjectClass)(Code) | |
Get the default mask for a value object class.
Parameters:
valueObjectClass - class of value object for the mask to be returned. Mask definition with the id provided, or null ifthere is no such mask. |
| getMask | | Mask getMask(Field parentField, Class valueObjectClass)(Code) | |
Get a mask, identified by its parent field, and class. This returns the
input mask for the subclassed field.
Parameters:
parentField - If this mask applies to a field within another mask, (known asa submask) this is the field to which it applies, otherwiseuse the other getMask method.
Parameters:
valueObjectClass - class of value object for the mask to be returned. Mask definition with the id provided, or null ifthere is no such mask. |
| isConfigured | | boolean isConfigured()(Code) | |
Discover whether or not this object has been configured.
true if the object has been configured, otherwisefalse. |
| readConfiguration | | void readConfiguration(InputStream inputStream) throws IOException(Code) | |
Get the configuration represented by the document provided.
Parameters:
inputStream - The input stream to read the XML from.
throws:
IOException - If there is any problem reading from the stream provided. |
|
|