| java.lang.Object
 com.ivata.mask.group.GroupImpl
All known Subclasses: com.ivata.mask.MaskImpl,
| GroupImpl | | public class GroupImpl implements Group,Serializable(Code) | | Implementation of
Group defining 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 |
| Constructor Summary | |
| public | GroupImpl(String nameParam)
Create a group with no parent. | | public | GroupImpl(String nameParam, Group parentParam)
Create a mask with the specified parent. |
| Method Summary | |
| final public void | addExcludedFieldName(String nameParam)
Add the name of a field to exclude from this mask group. | | final public void | addField(Field fieldParam)
Add a field definition to this group. | | final public void | addFilter(Filter filterParam)
Add a filter to the list. | | final public void | addFirstFieldName(String nameParam)
Add the identifier for one of the first fields in the mask. | | final public void | addIncludedFieldName(String nameParam)
Add the name of an included field. | | final public void | addLastFieldName(String nameParam)
Add the identifier for one of the last fields in the mask. | | protected static Set | getAllExcludedFieldNames(Group instance)
Implementation of getAllExcludedFieldNames().
Parameters:
instance - instance for which to get the excluded fields. | | final public Set | getAllExcludedFieldNames()
Get the field names of all fields which have been excluded from this and
its parents. | | protected static List | getAllFirstFieldNames(Group instance)
Implementation of getAllFirstFieldNames().
Parameters:
instance - instance for which to get the first fields. | | final public 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. | | protected static List | getAllLastFieldNames(Group instance)
Implementation of getAllLastFieldNames().
Parameters:
instance - instance for which to get the last fields. | | final public 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. | | final public Set | getExcludedFieldNames()
Get the field ids which have been explicitly excluded from this group. | | final public Field | getField(String nameParam)
Default field definitions. | | public List | getFilters()
| | final public List | getFirstFieldNames()
Get the ids of all fields which should appear at the start of masks in
this group. | | final public Set | getIncludedFieldNames()
By explicitly including fields in a mask, you can override fields
excluded by one of its parents. | | final public List | getLastFieldNames()
Get the ids of all fields which should appear at the end of masks in this
group. | | final public String | getName()
| | final public Group | getParent()
Get the parent of this group, if any. | | final public boolean | isDisplayOnly()
If true, only the values in this mask will be displayed.
Otherwise, input fields are displayed.
This setting is inherited. | | final public 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
GroupImpl.getFirstFieldNames getFirstFieldNames on the parent group.
This is the standard, default behavior when this method returns
false. | | final public 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. | | final public void | setDisplayOnly(boolean b)
If true, only the values in this mask will be displayed.
Otherwise, input fields are displayed.
This setting is inherited. | | final public void | setParentFirstFieldNamesReplaced(boolean parentFirstFieldNamesReplacedParam)
Set whether or not the first field name list of parent mask groups should
be replaced. | | final public void | setParentLastFieldNamesReplaced(boolean parentLastFieldNamesReplacedParam)
Set whether or not the last field name list of parent mask groups should
be replaced. |
| GroupImpl | | public GroupImpl(String nameParam)(Code) | | Create a group with no parent.
Parameters:
nameParam - unique identifier for this group. |
| GroupImpl | | public GroupImpl(String nameParam, Group parentParam)(Code) | | Create a mask with the specified parent.
Parameters:
nameParam - unique identifier for this group.
Parameters:
parentParam - group which this group extends. |
| addExcludedFieldName | | final public void addExcludedFieldName(String nameParam)(Code) | | Add the name of a field to exclude from this mask group.
Parameters:
nameParam - unique identifier for the field which should be excluded.
See Also: GroupImpl.getExcludedFieldNames |
| addField | | final public void addField(Field fieldParam)(Code) | | Add a field definition to this group.
Parameters:
fieldParam - field definition to add to this mask group. |
| addFilter | | final public void addFilter(Filter filterParam)(Code) | | Add a filter to the list.
Parameters:
filterParam - filter to be added.
See Also: Group#getFilters. |
| addFirstFieldName | | final public void addFirstFieldName(String nameParam)(Code) | | Add the identifier for one of the first fields in the mask.
Parameters:
nameParam - unique identifier for the field which should appear at thestart of the mask group.
See Also: GroupImpl.getFirstFieldNames |
| addIncludedFieldName | | final public void addIncludedFieldName(String nameParam)(Code) | | Add the name of an included field.
Parameters:
nameParam - unique identifier for the field which should appear in themask group, overriding parent excluded fields.
See Also: GroupImpl.getIncludedFieldNames() |
| addLastFieldName | | final public void addLastFieldName(String nameParam)(Code) | | Add the identifier for one of the last fields in the mask.
Parameters:
nameParam - unique identifier for the field which should appear at the endof the mask group.
See Also: GroupImpl.getLastFieldNames |
| getAllExcludedFieldNames | | protected static Set getAllExcludedFieldNames(Group instance)(Code) | | Implementation of getAllExcludedFieldNames().
Parameters:
instance - instance for which to get the excluded fields. list of all excluded field ids, as a List ofString instances.
See Also: GroupImpl.getAllExcludedFieldNames() |
| getAllExcludedFieldNames | | final public Set getAllExcludedFieldNames()(Code) | | Get the field names of all fields which have been excluded from this and
its parents.
Note: This will include fields which were explicitly included,
even if a parent class excluded them before.
list of all excluded field names, as a Set ofString instances. |
| getAllFirstFieldNames | | protected static List getAllFirstFieldNames(Group instance)(Code) | | Implementation of getAllFirstFieldNames().
Parameters:
instance - instance for which to get the first fields. list of all first field ids, as a List ofString instances.
See Also: GroupImpl.getAllFirstFieldNames() |
| getAllFirstFieldNames | | final public 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: GroupImpl.getFirstFieldNames |
| getAllLastFieldNames | | protected static List getAllLastFieldNames(Group instance)(Code) | | Implementation of getAllLastFieldNames().
Parameters:
instance - instance for which to get the last fields. list of all last field ids, as a List ofString instances.
See Also: GroupImpl.getAllLastFieldNames() |
| getAllLastFieldNames | | final public 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: GroupImpl.getFirstFieldNames |
| getExcludedFieldNames | | final public 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 | | final public Field getField(String nameParam)(Code) | |
Default field definitions. These can be altered/overridden.
Parameters:
nameParam - name of the field to be returned. read-only copy of the fields. |
| getFirstFieldNames | | final public 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 | | final public 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 | | final public 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. |
| getParent | | final public 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 | | final public boolean isDisplayOnly()(Code) | |
If true, only the values in this mask will be displayed.
Otherwise, input fields are displayed.
This setting is inherited. If it is not set in a group directly, the
value for the group's parent is taken.
whether or not the mask should only display field values. |
| isParentFirstFieldNamesReplaced | | final public 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
GroupImpl.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: GroupImpl.getFirstFieldNames |
| isParentLastFieldNamesReplaced | | final public 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
GroupImpl.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: GroupImpl.getLastFieldNames |
| setDisplayOnly | | final public void setDisplayOnly(boolean b)(Code) | |
If true, only the values in this mask will be displayed.
Otherwise, input fields are displayed.
This setting is inherited. If it is not set in a group directly, the
value for the group's parent is taken.
Parameters:
b - if true field values are just displayed andcannot be changed.
See Also: GroupImpl.isDisplayOnly |
| setParentFirstFieldNamesReplaced | | final public void setParentFirstFieldNamesReplaced(boolean parentFirstFieldNamesReplacedParam)(Code) | | Set whether or not the first field name list of parent mask groups should
be replaced.
Parameters:
parentFirstFieldNamesReplacedParam - true if parent first field ids should bereplaced (ignored), otherwise false.
See Also: GroupImpl.isParentFirstFieldNamesReplaced() |
| setParentLastFieldNamesReplaced | | final public void setParentLastFieldNamesReplaced(boolean parentLastFieldNamesReplacedParam)(Code) | | Set whether or not the last field name list of parent mask groups should
be replaced.
Parameters:
parentLastFieldNamesReplacedParam - true if parent last field ids should bereplaced (ignored), otherwise false.
See Also: GroupImpl.isParentLastFieldNamesReplaced() |
|
|