com.adobe.xfa.template.containers

Class Container

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

All Implemented Interfaces:

Peer

Direct Known Subclasses:

AreaContainer, ContentArea, Draw, ExclGroup, Field, PageArea, PageSet, Subform, SubformSet, Variables

public class Container
extends ProtoableNode

A base class to represent all XFA objects that are containers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Container.ChangeLogger Pure-virtual interface for clients of XFANode::compareVersions() which want changes reported in terms of containers & properties instead of elements & attributes.
static class	Container.FormInfo
static class	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 and Description
Container()

Method Summary

Modifier and Type	Method and Description
Attribute	getAttribute(int eTag, boolean bPeek, boolean bValidate) Gets this element's attribute whose attribute tag is given.
Element	getConnectNode(String sConnectionName, int eUsage, boolean bCreate) Get the connect node of this container (if the container supports connect) for a given connection and usage.
String	getErrorText() The errorText property contains the validation error message for the last validation that failed.
Container.FormInfo	getFormInfo()
void	getInvalidObjects(NodeList invalidObjects)
int	getRuntimeAccess(int eParentAccess)
int	getRuntimePresence(int eParentPresence) Return an int for this containers presence property.
ScriptTable	getScriptTable()
Container.ValidationState	getValidationState()
boolean	isConnectSupported() Return whether the container supports connect i.e.
boolean	isContainer() Check to see if this is a container object.
boolean	isHeightGrowable() Returns whether or not this container's height is growable.
boolean	isHeightGrowSupported() Returns whether or not this container support growable heights.
boolean	isWidthGrowable() Returns whether or not this container's width is growable.
boolean	isWidthGrowSupported() Return whether or not this container support growable widths This does not indicate whether the container height is currently growable, just whether it's supported by this container type.
Node	locateChildByClass(int eChildTag, int nIndex)
void	setAttribute(Attribute attr, int eTag) Sets an attribute of this element.
void	setErrorText(String sErrorText)
void	setFormInfo(Container.FormInfo formInfo)
void	setValidationState(Container.ValidationState eValidationState)

Methods inherited from class com.adobe.xfa.ProtoableNode

clone, createProto, elementGetAttribute, externalProtoFailed, fetchIDValues, getAttributeByName, getElement, getExternalProtoSource, getOneOfChild, getPI, getPI, getProto, getProtoed, getText, hasExternalProto, hasProto, isContextSensitiveAttribute, isDefault, isSpecified, notifyPeers, performResolveProtos, preSave, releaseExternalProtos, reResolveProto, resolveProto, setElement, 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, 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

Container

public Container()

Method Detail

getAttribute

public Attribute getAttribute(int eTag,
                              boolean bPeek,
                              boolean bValidate)

Description copied from class: Element

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

To peek at an attribute, set the peek argument to true. If the attribute is present, it is returned; otherwise null is returned.

To create an attribute, set the peek argument to false. If the attribute is absent, a default attribute is created and returned; for attributes with no default, null is returned.

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

Overrides:

getAttribute in class ProtoableNode

Parameters:

eTag - the tag of the attribute.

bPeek - whether to peek at the attribute or not.

bValidate - whether to validate the attribute or not.

Returns:

the attribute.

getFormInfo

public Container.FormInfo getFormInfo()

getRuntimePresence

public int getRuntimePresence(int eParentPresence)

Return an int for this containers presence property. Values will be one of visible, invisible or hidden. This method will check it's parent hierarchy to determine the correct presence.

Returns:

The corresponding int.

getRuntimeAccess

public int getRuntimeAccess(int eParentAccess)

getScriptTable

public ScriptTable getScriptTable()

Overrides:

getScriptTable in class ProtoableNode

getErrorText

public String getErrorText()

The errorText property contains the validation error message for the last validation that failed. This only applies to the FormField, FormSubform, and FormExclGroup.

setErrorText

public void setErrorText(String sErrorText)

getValidationState

public Container.ValidationState getValidationState()

setValidationState

public void setValidationState(Container.ValidationState eValidationState)

getInvalidObjects

public void getInvalidObjects(NodeList invalidObjects)

isConnectSupported

public boolean isConnectSupported()

Return whether the container supports connect i.e. field, exclGroup or subform

Returns:

true if the container supports connect

getConnectNode

public Element getConnectNode(String sConnectionName,
                              int eUsage,
                              boolean bCreate)

Get the connect node of this container (if the container supports connect) for a given connection and usage. Connect is supported for field, exclGroup, and subform

Parameters:

sConnectionName - the name of the connection.

eUsage - the value of the usage property.

bCreate - if TRUE create the connection if it doens't exist

Returns:

the connect node of this subform for a given connection, a null XFANode if none is found. If sConnectionName is empty or the container does not support connect a null XFANode is returned

isContainer

public boolean isContainer()

Description copied from class: Node

Check to see if this is a container object. A container is defined as something that is not a leaf node not properties ( [0..1] occurrences ). It does NOT indicate whether this node derives from XFAContainer

Overrides:

isContainer in class Element

Returns:

true if this node is a container, false otherwise

See Also:

Element.isContainer()

isHeightGrowable

public boolean isHeightGrowable()

Returns whether or not this container's height is growable. If true, then the container is considered growable between range of [minH, maxH] or [0, infinity] when not specified.

Returns:

true if this containers height can grow, false otherwise

isHeightGrowSupported

public boolean isHeightGrowSupported()

Returns whether or not this container support growable heights. This does not indicate whether the container height is currently growable, just whether it's supported by this container type.

isWidthGrowable

public boolean isWidthGrowable()

Returns whether or not this container's width is growable. If true then the container is considered growable between range of [minH, maxH] or [0, infinity] when not specified.

Returns:

true if this containers height can grow, false otherwise

isWidthGrowSupported

public boolean isWidthGrowSupported()

Return whether or not this container support growable widths This does not indicate whether the container height is currently growable, just whether it's supported by this container type.

Comments Helps distinguish - ie text draws supporting growing but arc draws do not.

setAttribute

public void setAttribute(Attribute attr,
                         int eTag)

Sets an attribute of this element. This method treats the w/h attributes and their min/max counterparts as mutually exclusive - setting w/h will remove any min/max and vice versa.

In addition, there are clear rules to resolve conflicts:

1. If h/w is specified, then the container is not growable and any min/max value is irrelevant.
2. Otherwise the container is considered growable. Any min/max attribute that are specified will indicate the range of growableness. The default range is [0, infinity].

In terms of setting min/max values, this method will guard against setting min > max.

Overrides:

setAttribute in class ProtoableNode

Parameters:

attr - the attribute.

eTag - The XFA tag name of the attribute being set.

See Also:

ProtoableNode.setAttribute(Attribute, int), isWidthGrowable(), isHeightGrowable()

setFormInfo

public void setFormInfo(Container.FormInfo formInfo)

locateChildByClass

public Node locateChildByClass(int eChildTag,
                               int nIndex)

Overrides:

locateChildByClass in class Node