com.hfg.xml.msofficexml.part.CommentsPart Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation

com.hfg xml, html, svg, and bioinformatics utility library

There is a newer version: 20240423

package com.hfg.xml.msofficexml.part;


import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeOpenXMLContentType;
import com.hfg.xml.msofficexml.OfficeXML;
import com.hfg.xml.msofficexml.docx.Docx;
import com.hfg.xml.msofficexml.docx.wordprocessingml.WmlComments;
import com.hfg.xml.msofficexml.docx.wordprocessingml.WmlParagraph;
import com.hfg.xml.msofficexml.docx.wordprocessingml.WmlXML;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML comments part.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class CommentsPart extends OfficeXMLPart
{

   //---------------------------------------------------------------------------
   public CommentsPart(Docx inDocx)
   {
       super(inDocx);
       setFile(WmlXML.COMMENTS_FILE);

       XMLTag rootNode = new WmlComments();
       rootNode.addXMLNamespaceDeclaration(WmlXML.WORDPROCESSINGML_NAMESPACE);
       rootNode.addXMLNamespaceDeclaration(OfficeXML.OFFICE_NAMESPACE);
       setRootNode(rootNode);
   }

    //---------------------------------------------------------------------------
    /**
     Convenience short cut method.
     */
    public int addComment(WmlParagraph inValue)
    {
        return ((WmlComments)getRootNode()).addComment(inValue);
    }

    //---------------------------------------------------------------------------
    @Override
    public OfficeOpenXMLContentType getContentType()
    {
        return OfficeOpenXMLContentType.COMMENTS;
    }

}