public class GCGroup extends GCParent
A GCV group is a collection of related GCVs. The first definition in the group is the "group leader". The UI displays the other members of the group as subordinate to the group leader. The other members of the group may be definitions or they may be "subordinate sections". Subordinate sections may be conditionally displayed by the UI based on the value of the group leader.
Group leaders may be of type boolean or of type enum.
Although a GCV group is not an actual GCV, the objects are represented programmatically as GCValues for ease of manipulation via the GCDefinitions class.
GCSubordinates
GCValue.IllegalCloneStateException, GCValue.XmlComment, GCValue.XmlItem, GCValue.XmlProcessingInstruction
modified, parent, TYPE_BOOLEAN, TYPE_DN, TYPE_DN_REF, TYPE_ENUM, TYPE_GCV_REF, TYPE_GROUP, TYPE_HEADER, TYPE_INTEGER, TYPE_LIST, TYPE_PASSWORD_REF, TYPE_REAL, TYPE_STRING, TYPE_STRUCTURED, TYPE_SUBORDINATES, xmlItems
Modifier | Constructor and Description |
---|---|
protected |
GCGroup(org.w3c.dom.Element definition,
GCOwner owner)
Constructor for use by
GCValue.construct() method. |
protected |
GCGroup(GCOwner owner)
Constructor for use by
GCValue construct() method. |
Modifier and Type | Method and Description |
---|---|
GCValue |
cloneValue(java.lang.String name)
Clone this
GCValue instance and return the cloned instance. |
GCValue |
getLeader()
Return the "group leader" value.
|
addName, appendValue, checkAllowedType, cloneCommon, getOwner, getValue, insertValue, insertValue, isNameAllowed, iterator, parseValue, removeName, removeValue, removeValue, replaceValue, setValue, shallowIterator
addXmlComment, addXmlItems, addXmlProcessingInstruction, construct, construct, constructGCVRef, constructGCVRef, constructGroup, constructHeader, constructStructuredValue, constructSubordinates, getDescription, getDescriptionRef, getDisplayName, getDisplayNameRef, getHidden, getMandatory, getName, getParent, getType, getTypeString, getXmlItemsIterator, getXMLValue, hasBeenModified, localize, resetModified, setDescription, setDescriptionRef, setDisplayName, setDisplayNameRef, setHidden, setMandatory, toXML, typeFromString
protected GCGroup(GCOwner owner) throws GCVArgumentException
GCValue
construct()
method.owner
- GCDefinitions
instance that owns this group.GCVArgumentException
- thrown if name is invalidprotected GCGroup(org.w3c.dom.Element definition, GCOwner owner) throws GCVException
GCValue.construct()
method.definition
- <group> element defining data.owner
- GCDefinitions
instance that owns the groupGCVException
- thrown if XML is not complete or
correct.public GCValue cloneValue(java.lang.String name)
GCValue
instance and return the cloned instance.cloneValue
in class GCValue
the
- name for the cloned value (ignored).public GCValue getLeader()
null
.