Package com.adobe.xfa.form

Class FormSubformSet

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Element

com.adobe.xfa.ProtoableNode

com.adobe.xfa.template.containers.Container

com.adobe.xfa.template.containers.SubformSet

com.adobe.xfa.form.FormSubformSet

All Implemented Interfaces:

Peer

public class FormSubformSet
extends SubformSet

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.xfa.template.containers.Container

Container.ChangeLogger, Container.FormInfo, Container.ValidationState

Nested classes/interfaces inherited from class com.adobe.xfa.Element

Element.DualDomNode, Element.ReplaceContent

Field Summary

Fields inherited from class com.adobe.xfa.Element

AttrIsDefault, AttrIsFragment, AttrIsTransient, CREATEACTION

Fields inherited from class com.adobe.xfa.Node

CREATE_ALWAYS_NEW, CREATE_IF_NOT_EXIST, CREATE_MUST_NOT_EXIST, CREATE_REPLACE, gsXFANamespacePrefix

Fields inherited from interface com.adobe.xfa.ut.Peer

ATTR_CHANGED, CHILD_ADDED, CHILD_REMOVED, DESCENDENT_ADDED, DESCENDENT_ATTR_CHANGED, DESCENDENT_REMOVED, DESCENDENT_VALUE_CHANGED, PARENT_CHANGED, PERMS_LOCK_CLEARED, PERMS_LOCK_SET, PROTO_ATTR_CHANGED, PROTO_CHILD_ADDED, PROTO_CHILD_REMOVED, PROTO_DESCENDENT_ADDED, PROTO_DESCENDENT_ATTR_CHANGED, PROTO_DESCENDENT_REMOVED, PROTO_DESCENDENT_VALUE_CHANGED, PROTO_VALUE_CHANGED, UPDATED, VALUE_CHANGED

Constructor Summary

Constructors

Constructor	Description
FormSubformSet(Element parent, Node prevSibling)

Method Summary

Modifier and Type	Method	Description
Element	getElement(int eTag, boolean bPeek, int nOccurrence, boolean bReturnDefault, boolean bValidate)	Gets this element's sub element whose element tag is given.
FormInstanceManager	getInstanceManager()	Returns the FormInstanceManager for this subformset
boolean	isSpecified(int eTag, boolean bCheckProtos, int nOccurrence)	Check if a property, child, or oneOfChild has been defined for this node
Node	setElement(Node child, int eTag, int nOccurrence)	Set an element value.
void	setInstanceIndex(int nMoveTo)

Methods inherited from class com.adobe.xfa.template.containers.SubformSet

getScriptTable, getUsedTable, isHeightGrowSupported, isWidthGrowSupported, reset

Methods inherited from class com.adobe.xfa.template.containers.Container

getAttribute, getConnectNode, getErrorText, getFormInfo, getInvalidObjects, getRuntimeAccess, getRuntimePresence, getValidationState, isConnectSupported, isContainer, isHeightGrowable, isWidthGrowable, locateChildByClass, setAttribute, setErrorText, setFormInfo, setValidationState

Methods inherited from class com.adobe.xfa.ProtoableNode

clone, createProto, elementGetAttribute, externalProtoFailed, fetchIDValues, getAttributeByName, getExternalProtoSource, getOneOfChild, getPI, getPI, getProto, getProtoed, getText, hasExternalProto, hasProto, isContextSensitiveAttribute, isDefault, isSpecified, notifyPeers, performResolveProtos, preSave, releaseExternalProtos, reResolveProto, resolveProto, setOneOfChild, setPermsLock, setProto, updateIDValues

Methods inherited from class com.adobe.xfa.Element

appendChild, appendChild, appendPI, appendPI, assignNode, clone, connectPeerToDocument, constructKey, constructKeys, copyContent, defaultAttribute, defaultElement, defaultElement, establishID, evaluate, explodeQName, findAttr, findSchemaAttr, foundBadAttribute, foundBadAttribute, getAll, getAppModel, getAtom, getAttr, getAttribute, getAttrIndex, getAttrName, getAttrNS, getAttrProp, getAttrQName, getAttrVal, getChildReln, getClassAll, getClassIndex, getClassName, getDeltas, getElement, getElementClass, getElementLocal, getEnum, getEnum, getEventTable, getFirstXFAChild, getFirstXMLChild, getID, getIndex, getInheritedNS, getInstalledLocale, getIsNull, getLastXMLChild, getLineNumber, getLocalName, getModel, getName, getNode, getNodes, getNodeSchema, getNS, getNumAttrs, getOneOfChild, getPrefix, getProperty, getProperty, getSaveXMLSaveTransient, getSchemaType, getScriptMethodInfo, getSibling, getXFAChild, getXMLChild, getXMLName, getXPath, getXsiNilAttribute, inhibitPrettyPrint, inhibitPrettyPrint, insertChild, isFragment, isHidden, isHidden, isIndexed, isInstalledLocaleAmbient, isLeaf, isNameSpaceAttr, isPropertySpecified, isPropertySpecified, isPropertyValid, isSpecified, isTransient, isTransparent, isValidAttr, isValidChild, isValidElement, loadXML, loadXML, makeDefault, makeNonDefault, newAttribute, optimizeNameSpace, peekAttribute, peekElement, peekOneOfChild, peekProperty, peekProperty, postSave, privateSetName, processTextChildrenDuringParse, removeAttr, removeAttr, removeChild, removePI, removePI, removeWhiteSpace, removeXsiNilAttribute, replaceChild, resetPostLoadXML, resolveAndEnumerateChildren, resolveNodeCreate, resolvePrefix, saveFilteredXML, saveXML, saveXML, serialize, setAttribute, setAttribute, setAttribute, setAttrProp, setDefaultFlag, setDOMProperties, setIsDataWindowRoot, setIsIndexed, setLineNumber, setLocalName, setModel, setName, setNS, setProperty, setProperty, setQName, setSaveXMLSaveTransient, setTransparent, setXMLName, setXsiNilAttribute, updateFromPeer

Methods inherited from class com.adobe.xfa.Node

checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getData, getFirstXMLChildElement, getLocked, getNextXFASibling, getNextXMLSibling, getNextXMLSiblingElement, getNodeAsXML, getOwnerDocument, getPIAsXML, getPIName, getPreviousXMLSibling, getPrivateName, getPropName, getSOMExpression, getSOMExpression, getSomName, getUniqueSOMName, getWillDirty, getXFAChildCount, getXFAParent, getXfaPeer, getXMLChildCount, getXMLParent, hasChanged, isDirty, isMapped, isPermsLockSet, isTransient, locateChildByName, logValueChangeHelper, performSOMAssignment, remove, resolveNode, resolveNode, resolveNode, resolveNodes, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setPrivateName, setWillDirty, setXfaPeer, unLock, validateSchema, validateUsage, validateUsageFailedIsFatal

Methods inherited from class com.adobe.xfa.Obj

addPeer, addPeeredNode, clearPeers, deafen, getClassAtom, getClassTag, getPeer, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, peerRemoved, removePeer, removePeeredNode, setClass, setClassTag, setScriptProperty, unDeafen, unMute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormSubformSet

public FormSubformSet(Element parent,
                      Node prevSibling)

Method Detail

isSpecified

public boolean isSpecified(int eTag,
                           boolean bCheckProtos,
                           int nOccurrence)

Description copied from class: Node

Check if a property, child, or oneOfChild has been defined for this node

Overrides:

isSpecified in class Element

Parameters:

eTag - The XFA tag (name) of the property/child/oneOfChild to check for.

bCheckProtos - if true, check if this property is specified via prototype inheritance. Defaults to true.

nOccurrence - if this property can occur a fix number of times (usually [0..n]), then specify which occurrence to check for. Defaults to 0.

Returns:

True if the property has been specified.

See Also:

Node.isSpecified(int, boolean, int)

getElement

public Element getElement(int eTag,
                          boolean bPeek,
                          int nOccurrence,
                          boolean bReturnDefault,
                          boolean bValidate)

Description copied from class: Element

Gets this element's sub element whose element tag is given.

To return the element, set the returnDefault argument to true. If the element is present, it is returned; otherwise the default element is created and returned.

To peek at the element, set the peek argument to true. If the element is present, it is returned; otherwise null is returned. When set to true, default properties aren't created, and proto references are not expanded.

To create the element, set the peek argument to false. If the element is absent, a default element is created and returned.

If validation argument is true, and the validation fails, this method throws.

If the occurrence argument is out of range, this method throws.

Overrides:

getElement in class ProtoableNode

Parameters:

eTag - the tag of the element to retrieve.

bPeek - whether to peek at the element, or not.

nOccurrence - the n'th occurrence of the element to retrieve.

bReturnDefault - whether to create a default element, or not.

bValidate - whether to validate the element, or not.

Returns:

the element, or null.

setElement

public Node setElement(Node child,
                       int eTag,
                       int nOccurrence)

Description copied from class: Element

Set an element value. Must be a valid 0..1 element, (not a oneOfChild or a 0..n child)

Overrides:

setElement in class ProtoableNode

Parameters:

child - the child to add or set.

eTag - only used if oChild isNull -- in which case we remove the element

See Also:

Element.setElement(Node, int, int)

getInstanceManager

public FormInstanceManager getInstanceManager()

Returns the FormInstanceManager for this subformset

Overrides:

getInstanceManager in class SubformSet

Returns:

a FormInstanceManager

setInstanceIndex

public void setInstanceIndex(int nMoveTo)

Overrides:

setInstanceIndex in class SubformSet