com.hfg.xml.msofficexml.docx.wordprocessingml.WmlBookmark Maven / Gradle / Ivy

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.wordprocessingml;



import com.hfg.xml.msofficexml.docx.Docx;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML bookmark.

 @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 WmlBookmark
{
   private Docx   mParentDoc;
   private int    mId;
   private String mName;

   private static int sIdSrc = 0;

   //---------------------------------------------------------------------------
   public WmlBookmark(Docx inDocx)
   {
      mParentDoc = inDocx;
      mId = sIdSrc++;
      mName = "_Ref" + mId;
   }

   //---------------------------------------------------------------------------
   public WmlBookmark(Docx inDocx, String inName)
   {
      mParentDoc = inDocx;
      mId = sIdSrc++;
      mName = inName;

      // For convenience, keep a list of bookmarks in the document.
      inDocx.registerBookmark(this);
   }

   //---------------------------------------------------------------------------
   public int getId()
   {
      return mId;
   }

   //---------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

   //---------------------------------------------------------------------------
   public WmlXMLTag generateBookmarkStart()
   {
      WmlXMLTag tag = new WmlXMLTag(WmlXML.BOOKMARK_START, mParentDoc);
      tag.setAttribute(WmlXML.ID_ATT, getId());
      tag.setAttribute(WmlXML.NAME, name());

      return tag;
   }

   //---------------------------------------------------------------------------
   public WmlXMLTag generateBookmarkEnd()
   {
      WmlXMLTag tag = new WmlXMLTag(WmlXML.BOOKMARK_END, mParentDoc);
      tag.setAttribute(WmlXML.ID_ATT, getId());

      return tag;
   }
}