Package com.adobe.xfa

Class Packet

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Element

com.adobe.xfa.Packet

All Implemented Interfaces:

Element.DualDomNode, Peer

public final class Packet
extends Element
implements Element.DualDomNode

A class to represent the children of the XFA app model that are not otherwise represented by a model.

Nested Class Summary

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

Element.DualDomNode, Element.ReplaceContent

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

Node.ChangeLogger

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
Packet(Element parent, Node prevSibling)	Instantiates a packet node.

Method Summary

Modifier and Type	Method	Description
String	getAttribute(String sAttrName)	XFAPackets have no formal schema, so getProperty does not work to return attributes.
String	getContent()	Gets this packet's content.
Node	getFirstXFAChild()	Gets this element's first child that is an XFA node.
String	getName()	Gets this packet's name.
ScriptTable	getScriptTable()
Node	getXmlPeer()
boolean	isValidAttr(int eTag, boolean bReport, String value)	Determines if the given attribute tag is a valid attribute of this packet.
void	removeAttribute(String sAttrName)	Removes the specified attribute.
void	serialize(OutputStream outStream, DOMSaveOptions options, int level, Node prevSibling)	The helper function used by saveXML()
void	setAttribute(String sValue, String sAttrName)	XFAPackets have no formal schema, so setProperty does not work to set attributes.
void	setContent(String sContent)	Sets this packet's content.
void	setXmlPeer(Node peer)

Methods inherited from class com.adobe.xfa.Element

appendChild, appendChild, appendPI, appendPI, assignNode, clone, clone, connectPeerToDocument, constructKey, constructKeys, copyContent, defaultAttribute, defaultElement, defaultElement, establishID, evaluate, explodeQName, findAttr, findSchemaAttr, foundBadAttribute, foundBadAttribute, getAll, getAppModel, getAtom, getAttr, getAttribute, getAttribute, getAttributeByName, getAttrIndex, getAttrName, getAttrNS, getAttrProp, getAttrQName, getAttrVal, getChildReln, getClassAll, getClassIndex, getClassName, getDeltas, getElement, getElement, getElementClass, getElementLocal, getEnum, getEnum, getEventTable, getFirstXMLChild, getID, getIndex, getInheritedNS, getInstalledLocale, getIsNull, getLastXMLChild, getLineNumber, getLocalName, getModel, getNode, getNodes, getNodeSchema, getNS, getNumAttrs, getOneOfChild, getOneOfChild, getPI, getPI, getPrefix, getProperty, getProperty, getSaveXMLSaveTransient, getSchemaType, getScriptMethodInfo, getSibling, getText, getXFAChild, getXMLChild, getXMLName, getXPath, getXsiNilAttribute, inhibitPrettyPrint, inhibitPrettyPrint, insertChild, isContainer, isFragment, isHidden, isHidden, isIndexed, isInstalledLocaleAmbient, isLeaf, isNameSpaceAttr, isPropertySpecified, isPropertySpecified, isPropertyValid, isSpecified, isSpecified, isSpecified, isTransient, isTransparent, isValidChild, isValidElement, loadXML, loadXML, makeDefault, makeNonDefault, newAttribute, optimizeNameSpace, peekAttribute, peekElement, peekOneOfChild, peekProperty, peekProperty, postSave, preSave, privateSetName, processTextChildrenDuringParse, removeAttr, removeAttr, removeChild, removePI, removePI, removeWhiteSpace, removeXsiNilAttribute, replaceChild, resetPostLoadXML, resolveAndEnumerateChildren, resolveNodeCreate, resolvePrefix, saveFilteredXML, saveXML, saveXML, setAttribute, setAttribute, setAttribute, setAttribute, setAttrProp, setDefaultFlag, setDOMProperties, setElement, setIsDataWindowRoot, setIsIndexed, setLineNumber, setLocalName, setModel, setName, setNS, setOneOfChild, 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, isDefault, isDirty, isMapped, isPermsLockSet, isTransient, locateChildByClass, locateChildByName, logValueChangeHelper, notifyPeers, performSOMAssignment, remove, resolveNode, resolveNode, resolveNode, resolveNodes, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setPermsLock, 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

Packet

public Packet(Element parent,
              Node prevSibling)

Instantiates a packet node.

Method Detail

getAttribute

public String getAttribute(String sAttrName)

XFAPackets have no formal schema, so getProperty does not work to return attributes. Instead, provide an accessor to return arbitrary attribute values.

Parameters:

sAttrName - The name of the attribute to return

Returns:

the attribute value, or the empty string if it doesn't exist or is empty.

getContent

public String getContent()

Gets this packet's content. If this packet has content, return it. Note that for packets that contain XML content, this should return an empty string.

Returns:

the packet content. If this packet has text content, the text is returned. Note that for packets that contain XML content, an empty string is returned.

getName

public String getName()

Gets this packet's name.

Overrides:

getName in class Element

Returns:

the name of the element.

getScriptTable

public ScriptTable getScriptTable()

Overrides:

getScriptTable in class Element

isValidAttr

public boolean isValidAttr(int eTag,
                           boolean bReport,
                           String value)

Determines if the given attribute tag is a valid attribute of this packet.

Overrides:

isValidAttr in class Element

Parameters:

eTag - the XFA tag to check

Returns:

true if valid.

See Also:

Element.isValidAttr(int, boolean, String)

getFirstXFAChild

public Node getFirstXFAChild()

Gets this element's first child that is an XFA node.

Overrides:

getFirstXFAChild in class Element

Returns:

null -- the children of packet nodes are not exposed.

serialize

public void serialize(OutputStream outStream,
                      DOMSaveOptions options,
                      int level,
                      Node prevSibling)
               throws IOException,
                      IOException

Description copied from class: Node

The helper function used by saveXML()

Overrides:

serialize in class Element

Parameters:

outStream - Streamfile to write to

options - save options

level - the indent level

prevSibling - our previous sibling -- needed for some markup options.

Throws:

IOException

See Also:

Node.serialize(OutputStream, DOMSaveOptions, int, Node)

removeAttribute

public void removeAttribute(String sAttrName)

Removes the specified attribute.

Parameters:

sAttrName - the name of the attribute to remove.

setAttribute

public void setAttribute(String sValue,
                         String sAttrName)

XFAPackets have no formal schema, so setProperty does not work to set attributes. Instead, this sets arbitrary attribute values. If the attribute exists, we populate it, if it doesn't exist we create it.

Parameters:

sValue - The value of the attribute to set

sAttrName - The name of the attribute to set

setContent

public void setContent(String sContent)

Sets this packet's content.

Parameters:

sContent - the text content value.

setXmlPeer

public void setXmlPeer(Node peer)

Specified by:

setXmlPeer in interface Element.DualDomNode

getXmlPeer

public Node getXmlPeer()

Specified by:

getXmlPeer in interface Element.DualDomNode