| com.ivata.mask.group.Group
All known Subclasses: com.ivata.mask.group.GroupImpl,
| Group | | public interface Group (Code) | | Instances of this interface define a group of masks which share common field
definitions and other characteristics.
since:
ivata masks 0.1 (2004-02-26)
author:
Colin MacLeod
author:
colin.macleod@ivata.com |
| Method Summary | |
| Set | getAllExcludedFieldNames()
Get the field identifiers of all fields which have been excluded from
this and its parents. | | List | getAllFirstFieldNames()
Get the field identifiers of all fields which should appear at the start
of the group/mask, including those defined by its parent. | | List | getAllLastFieldNames()
Get the field identifiers of all fields which should appear at the end of
the group/mask, including those defined by its parent. | | Set | getExcludedFieldNames()
Get the field ids which have been explicitly excluded from this group. | | Field | getField(String name)
Default field definitions. | | List | getFilters()
Get all of the filters applied to this group, as a List of
com.ivata.mask.filter.Filter Filter instances. | | List | getFirstFieldNames()
Get the ids of all fields which should appear at the start of masks in
this group. | | Set | getIncludedFieldNames()
By explicitly including fields in a mask, you can override fields
excluded by one of its parents. | | List | getLastFieldNames()
Get the ids of all fields which should appear at the end of masks in this
group. | | String | getName()
Get the identifier of this group. | | Group | getParent()
Get the parent of this group, if any. | | boolean | isDisplayOnly()
If true, only the values in this mask will be displayed. | | boolean | isParentFirstFieldNamesReplaced()
When first field identifiers are defined for a group, normally these are
appended to the list of all parent group first field identifiers, i.e.
the list returned by calling
Group.getFirstFieldNames getFirstFieldNames on the parent group.
This is the standard, default behavior when this method returns
false. | | boolean | isParentLastFieldNamesReplaced()
When last field identifiers are defined for a group, normally these are
appended to the list of all parent group last field identifiers, i.e. |
| getAllExcludedFieldNames | | Set getAllExcludedFieldNames()(Code) | |
Get the field identifiers of all fields which have been excluded from
this and its parents.
Note: This will list fields which were explicitly excluded, even
if a parent class included them before.
list of all excluded field ids, as a List ofString instances.
See Also: Group.getExcludedFieldNames |
| getAllFirstFieldNames | | List getAllFirstFieldNames()(Code) | |
Get the field identifiers of all fields which should appear at the start
of the group/mask, including those defined by its parent.
list of all first field ids, as a List ofString instances.
See Also: Group.getFirstFieldNames |
| getAllLastFieldNames | | List getAllLastFieldNames()(Code) | |
Get the field identifiers of all fields which should appear at the end of
the group/mask, including those defined by its parent.
list of all last field ids, as a List ofString instances.
See Also: Group.getFirstFieldNames |
| getExcludedFieldNames | | Set getExcludedFieldNames()(Code) | |
Get the field ids which have been explicitly excluded from this group.
the field ids which have been explicitly excluded from this group(not including those excluded by parent groups). |
| getField | | Field getField(String name)(Code) | |
Default field definitions. These can be altered/overridden.
Parameters:
name - name of the field to be returned. read-only copy of the fields. |
| getFirstFieldNames | | List getFirstFieldNames()(Code) | |
Get the ids of all fields which should appear at the start of masks in
this group. For an input mask this usually means the fields will appear
at the top of the page; for a list the fields will appear at the left of
the list.
Note that all these fields do not need to be present in all masks
of this group (some value objects may not have all the fields listed).
Those fields which are listed and present in the value object will appear
at the start, in the order given.
list containing string identifiers of fields which should appearfirst in the mask. |
| getIncludedFieldNames | | Set getIncludedFieldNames()(Code) | | By explicitly including fields in a mask, you can override fields
excluded by one of its parents.
fields explicitly included (overridden) in this mask. |
| getLastFieldNames | | List getLastFieldNames()(Code) | |
Get the ids of all fields which should appear at the end of masks in this
group. For an input mask this usually means the fields will appear at the
bottom of the page; for a list the fields will appear at the right of the
list.
Note that all these fields do not need to be present in all masks
of this group (some value objects may not have all the fields listed).
Those fields which are listed and present in the value object will appear
at the end, in the order given.
list containing string identifiers of fields which should appearlast in the mask. |
| getName | | String getName()(Code) | | Get the identifier of this group. This identifier is unique within
the system, for groups (but not necessarily for their subclasses).
unique identifier of this group. |
| getParent | | Group getParent()(Code) | |
Get the parent of this group, if any.
Each group or mask can define a parent, from which it can inherit field
definitions and group/mask properties.
parent of this group, or null if this is atop-level group. |
| isDisplayOnly | | boolean isDisplayOnly()(Code) | |
If true, only the values in this mask will be displayed.
Otherwise, input fields are displayed.
whether or not the mask should only display field values. |
| isParentFirstFieldNamesReplaced | | boolean isParentFirstFieldNamesReplaced()(Code) | |
When first field identifiers are defined for a group, normally these are
appended to the list of all parent group first field identifiers, i.e.
the list returned by calling
Group.getFirstFieldNames getFirstFieldNames on the parent group.
This is the standard, default behavior when this method returns
false. However, if this method returns true,
then the first field identifiers in this group override (replace) the
list returned by the group's parents.
true if this group replaces the list of firstfield ids defined by parent groups, otherwise falseif this group's list will be appended to that of its parents.
See Also: Group.getFirstFieldNames |
| isParentLastFieldNamesReplaced | | boolean isParentLastFieldNamesReplaced()(Code) | |
When last field identifiers are defined for a group, normally these are
appended to the list of all parent group last field identifiers, i.e. the
list returned by calling
Group.getLastFieldNames getLastFieldNames on
the parent group.
This is the standard, default behavior when this method returns
false. However, if this method returns true,
then the last field identifiers in this group override (replace) the list
returned by the group's parents.
true if this group replaces the list of last fieldids defined by parent groups, otherwise false ifthis group's list will be appended to that of its parents.
See Also: Group.getLastFieldNames |
|
|