com.hfg.xml.msofficexml.xlsx.part.SsmlDrawingPart 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.xlsx.part;

import java.io.File;

import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeOpenXMLContentType;
import com.hfg.xml.msofficexml.docx.RelationshipXML;
import com.hfg.xml.msofficexml.docx.drawingml.DmlXML;
import com.hfg.xml.msofficexml.xlsx.spreadsheetDrawing.WorksheetDrawing;
import com.hfg.xml.msofficexml.part.OfficeXMLPart;
import com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlXML;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML drawing 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 SsmlDrawingPart extends OfficeXMLPart
{
   //###########################################################################
   // PRIVATE FIELDS
   //###########################################################################

   private int                       mDrawingIndex;
   private WorksheetPart             mParentWorksheetPart;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public SsmlDrawingPart(WorksheetPart inParentWorksheetPart)
   {
      super(inParentWorksheetPart.getParentDoc());

      mParentWorksheetPart = inParentWorksheetPart;

      XMLTag rootNode = new WorksheetDrawing(this);

      rootNode.addXMLNamespaceDeclaration(RelationshipXML.RELATIONSHIP_NAMESPACE);
      rootNode.addXMLNamespaceDeclaration(DmlXML.DRAWINGML_NAMESPACE);

      setRootNode(rootNode);
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################


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

   //---------------------------------------------------------------------------
   public WorksheetPart getParentWorksheetPart()
   {
      return mParentWorksheetPart;
   }

   //---------------------------------------------------------------------------
   public SsmlDrawingPart setDrawingIndex(int inValue)
   {
      mDrawingIndex = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   @Override
   public File getFile()
   {
      return new File(SsmlXML.DRAWINGS_DIR, "drawing" + mDrawingIndex + ".xml");
   }

   //---------------------------------------------------------------------------
   @Override
   public WorksheetDrawing getRootNode()
   {
      WorksheetDrawing rootNode = (WorksheetDrawing) super.getRootNode();
      if (null == rootNode)
      {
         rootNode = new WorksheetDrawing(this);
         setRootNode(rootNode);
      }

      return rootNode;
   }

}