Package com.adobe.xfa

Class 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 -->.

    • 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

      • 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)