public class GCSubordinates extends GCParent
A GCV subordinate section is a group of related GCV definitions under a GCV group. The UI may conditionally display subordinate sections based on the value of the group leader. Whether a subordinate section is displayed or not is controlled by the "active-value" attribute of the subordinate section.
Although a GCV subordinate section is not an actual GCV, the objects are represented programmatically as GCValues for ease of manipulation via the GCDefinitions class.
GCGroup
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 |
GCSubordinates(org.w3c.dom.Element definition,
GCOwner owner)
Constructor for use by
GCValue.construct() method. |
protected |
GCSubordinates(java.lang.String activeValue,
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. |
java.lang.String |
getActiveValue()
Get the active-value for this subordinates group.
|
void |
setActiveValue(java.lang.String activeValue)
Set the active-value for this subordinates section.
|
protected boolean |
validateActiveValue()
Validate the current active value against the current group leader.
|
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 GCSubordinates(java.lang.String activeValue, GCOwner owner) throws GCVArgumentException
GCValue
construct()
method.activeValue
- active-value valueowner
- GCDefinitions
instance that owns the subordinate sectionGCVArgumentException
- thrown if name is invalidprotected GCSubordinates(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 void setActiveValue(java.lang.String activeValue) throws GCVArgumentException
null
or empty.activeValue
- active-valueGCVArgumentException
- thrown is activeValue is incorrect.public java.lang.String getActiveValue()
protected boolean validateActiveValue()
true
if active value is valid.