Package com.adobe.xfa

Class Comment

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Comment

All Implemented Interfaces:

Peer

public final class Comment
extends Node

A class to represent the XML comment nodes in the DOM.

A comment's data is all of the characters between the starting <!-- and ending -->.

Nested Class Summary

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

Node.ChangeLogger

Field Summary

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
Comment(Element parent, Node prevSibling, java.lang.String comment)	Instantiates a node with the given comment.

Method Summary

Modifier and Type	Method	Description
Node	clone(Element parent)
java.lang.String	getClassAtom()	Gets this node's atomic class name.
java.lang.String	getClassName()	Gets the name of this object's class.
java.lang.String	getData()	Gets this node's data.
java.lang.String	getName()	Gets this node's name.
boolean	isLeaf()	Is this node is a leaf.
void	postSave()
void	preSave(boolean bSaveXMLScript)
void	serialize(java.io.OutputStream outStream, DOMSaveOptions options, int level, Node prevSibling)	The helper function used by saveXML()
void	setScriptProperty(java.lang.String sPropertyName, Arg propertyValue)

Methods inherited from class com.adobe.xfa.Node

assignNode, checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getAll, getFirstXFAChild, getFirstXMLChild, getFirstXMLChildElement, getIndex, getLastXMLChild, getLocked, getModel, getNextXFASibling, getNextXMLSibling, getNextXMLSiblingElement, getNodeAsXML, getNodes, getOwnerDocument, getPIAsXML, getPIName, getPreviousXMLSibling, getPrivateName, getProperty, getProperty, getPropName, getScriptTable, getSibling, getSOMExpression, getSOMExpression, getSomName, getUniqueSOMName, getWillDirty, getXFAChildCount, getXFAParent, getXfaPeer, getXMLChildCount, getXMLParent, hasChanged, isContainer, isDefault, isDirty, isMapped, isPermsLockSet, isPropertySpecified, isSpecified, isTransient, isTransient, isTransparent, locateChildByClass, locateChildByName, logValueChangeHelper, makeDefault, makeNonDefault, notifyPeers, peekOneOfChild, performSOMAssignment, remove, resolveNode, resolveNode, resolveNode, resolveNodes, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setName, setPermsLock, setPrivateName, setWillDirty, setXfaPeer, unLock, validateSchema, validateUsage, validateUsageFailedIsFatal

Methods inherited from class com.adobe.xfa.Obj

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Comment

public Comment(Element parent,
               Node prevSibling,
               java.lang.String comment)

Instantiates a node with the given comment.

Parameters:

parent - the node's parent, if any.

prevSibling - the node's previous sibling, if any.

comment - the node's comment.

Method Detail

clone

public Node clone(Element parent)

Specified by:

clone in class Node

getClassAtom

public java.lang.String getClassAtom()

Gets this node's atomic class name.

Overrides:

getClassAtom in class Obj

Returns:

the atomic class name.

getClassName

public java.lang.String getClassName()

Description copied from class: Obj

Gets the name of this object's class. Overriden by derived classes such as Element that have a local name that may be returned instead.

Overrides:

getClassName in class Obj

Returns:

the class name.

getData

public java.lang.String getData()

Description copied from class: Node

Gets this node's data.

Overrides:

getData in class Node

Returns:

the data appropriate for the various node types.

See Also:

Node.getData()

getName

public java.lang.String getName()

Gets this node's name.

Specified by:

getName in class Node

Returns:

the comment name which is the constant value "#comment".

isLeaf

public boolean isLeaf()

Description copied from class: Node

Is this node is a leaf.

Specified by:

isLeaf in class Node

Returns:

true if this node is a leaf and false otherwise.

postSave

public void postSave()

Specified by:

postSave in class Node

preSave

public void preSave(boolean bSaveXMLScript)

Specified by:

preSave in class Node

serialize

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

Description copied from class: Node

The helper function used by saveXML()

Specified by:

serialize in class Node

Parameters:

outStream - Streamfile to write to

options - save options

level - the indent level

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

Throws:

java.io.IOException

setScriptProperty

public void setScriptProperty(java.lang.String sPropertyName,
                              Arg propertyValue)