com.hfg.xml.msofficexml.docx.part.VbaRelationshipPart 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.docx.part;

import java.io.File;

import com.hfg.util.FileUtil;
import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeXML;
import com.hfg.xml.msofficexml.RelationshipType;
import com.hfg.xml.msofficexml.docx.Docx;
import com.hfg.xml.msofficexml.docx.wordprocessingml.WmlXML;
import com.hfg.xml.msofficexml.part.OfficeXMLPart;

//------------------------------------------------------------------------------
/**
 Represents the VBA relationship part (container) for an Office Open XML.

 @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 VbaRelationshipPart extends OfficeXMLPart
{
   private int mIndex = 1;

   //---------------------------------------------------------------------------
   public VbaRelationshipPart(Docx inDocx)
   {
      super(inDocx);

      setFile(WmlXML.VBA_RELATIONSHIP_FILE);

      setRootNode(new XMLTag(OfficeXML.RELATIONSHIPS));
   }

   //---------------------------------------------------------------------------
   public String addRelationship(RelationshipType inType, File inTarget)
   {
      String id = generateId();

      XMLTag relationshipTag = new XMLTag(OfficeXML.RELATIONSHIP)
            .setAttribute(OfficeXML.ID_ATT, id)
            .setAttribute(OfficeXML.TYPE_ATT, inType)
            .setAttribute(OfficeXML.TARGET_ATT, getRelativePath(inTarget));

      if (inType.equals(RelationshipType.SUB_DOCUMENT))
      {
         relationshipTag.setAttribute(OfficeXML.TARGET_MODE_ATT, "Internal");
      }

      getRootNode().addSubtag(relationshipTag);

      return id;
   }

   //---------------------------------------------------------------------------
   private String generateId()
   {
      return "rId" + (mIndex++);
   }

   //---------------------------------------------------------------------------
   private String getRelativePath(File inFile)
   {
      String path = inFile.getPath();
      if (path.startsWith(getFile().getParentFile().getParentFile().getPath()))
      {
         path = path.substring(getFile().getParentFile().getParentFile().getPath().length() + 1);
      }

      // Also ensure that the file paths consistently use '/' instead of '\' even if
      // generated on a Windoze system.  Windoze separators were causing files to appear corrupt.
      return FileUtil.convertSeparatorsToUnix(path);
   }
}