001package com.hfg.xml.msofficexml.docx.part;
002
003import java.util.List;
004
005import com.hfg.util.StringBuilderPlus;
006import com.hfg.util.collection.CollectionUtil;
007import com.hfg.xml.msofficexml.OfficeXML;
008import com.hfg.xml.msofficexml.docx.Docx;
009import com.hfg.xml.msofficexml.docx.RelationshipXML;
010import com.hfg.xml.msofficexml.docx.wordprocessingml.*;
011
012//------------------------------------------------------------------------------
013/**
014 Represents an Office Open XML numbering part.
015
016 @author J. Alex Taylor, hairyfatguy.com
017 */
018//------------------------------------------------------------------------------
019// com.hfg XML/HTML Coding Library
020//
021// This library is free software; you can redistribute it and/or
022// modify it under the terms of the GNU Lesser General Public
023// License as published by the Free Software Foundation; either
024// version 2.1 of the License, or (at your option) any later version.
025//
026// This library is distributed in the hope that it will be useful,
027// but WITHOUT ANY WARRANTY; without even the implied warranty of
028// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
029// Lesser General Public License for more details.
030//
031// You should have received a copy of the GNU Lesser General Public
032// License along with this library; if not, write to the Free Software
033// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
034//
035// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
036// jataylor@hairyfatguy.com
037//------------------------------------------------------------------------------
038
039public class NumberingPart extends DocxPart
040{
041
042   public static Integer ORDERED_LIST_ID;
043   public static Integer UNORDERED_LIST_ID;
044
045   //###########################################################################
046   // PRIVATE FIELDS
047   //###########################################################################
048
049   private int mAbstractNumIdSrc = 0;
050   private int mNumIdSrc = 1;
051
052   private WmlXMLTag mNumberingTag;
053
054   //###########################################################################
055   // CONSTRUCTORS
056   //###########################################################################
057
058   //---------------------------------------------------------------------------
059   public NumberingPart(Docx inDocx)
060   {
061      super(inDocx);
062
063      setFile(WmlXML.NUMBERING_FILE);
064
065      mNumberingTag = new WmlXMLTag(WmlXML.NUMBERING, inDocx);
066
067      mNumberingTag.addXMLNamespaceDeclaration(WmlXML.WORDPROCESSINGML_NAMESPACE)
068            .addXMLNamespaceDeclaration(RelationshipXML.RELATIONSHIP_NAMESPACE)
069            .addXMLNamespaceDeclaration(OfficeXML.MARKUP_CAPABILITY_NAMESPACE)
070            .addXMLNamespaceDeclaration(WmlXML.WORDML_14_NAMESPACE)
071            .addXMLNamespaceDeclaration(WmlXML.WORDML_15_NAMESPACE)
072            .addXMLNamespaceDeclaration(WmlXML.WORDML_16_NAMESPACE)
073            .addXMLNamespaceDeclaration(WmlXML.WORDML_16_COMMENTS_EXTENSIBLE_NAMESPACE)
074            .addXMLNamespaceDeclaration(WmlXML.WORDML_16_COMMENTS_IDS_NAMESPACE)
075            .addXMLNamespaceDeclaration(WmlXML.WORDML_16_SYMEX_NAMESPACE);
076
077      StringBuilderPlus ignorable = new StringBuilderPlus().setDelimiter(" ")
078            .delimitedAppend(WmlXML.WORDML_14_NAMESPACE.getPrefix())
079            .delimitedAppend(WmlXML.WORDML_15_NAMESPACE.getPrefix())
080            .delimitedAppend(WmlXML.WORDML_16_NAMESPACE.getPrefix())
081            .delimitedAppend(WmlXML.WORDML_16_COMMENTS_EXTENSIBLE_NAMESPACE.getPrefix())
082            .delimitedAppend(WmlXML.WORDML_16_COMMENTS_IDS_NAMESPACE.getPrefix())
083            .delimitedAppend(WmlXML.WORDML_16_SYMEX_NAMESPACE.getPrefix());
084      mNumberingTag.setAttribute(OfficeXML.IGNORABLE_ATT, ignorable);
085
086      setRootNode(mNumberingTag);
087
088      defineDefaults();
089   }
090
091   //###########################################################################
092   // PUBLIC METHODS
093   //###########################################################################
094
095   //---------------------------------------------------------------------------
096   public int addNumberingDef(WmlAbstractNumbering inValue)
097   {
098      mNumberingTag.addSubtag(inValue);
099
100      int numberingId = assignNumberingId();
101
102      WmlXMLTag numTag = mNumberingTag.addSubtag(WmlXML.NUM, getParentDoc());
103      numTag.setAttribute(WmlXML.NUMBERING_ID_ATT, numberingId);
104      numTag.addSubtag(WmlXML.ABSTRACT_NUM_ID).setAttribute(WmlXML.VALUE_ATT, inValue.getId());
105
106      return numberingId;
107   }
108
109   //---------------------------------------------------------------------------
110   private synchronized int assignAbstractNumId()
111   {
112      return mAbstractNumIdSrc++;
113   }
114
115   //---------------------------------------------------------------------------
116   private synchronized int assignNumberingId()
117   {
118      return mNumIdSrc++;
119   }
120
121   //---------------------------------------------------------------------------
122   private void defineDefaults()
123   {
124      List<WmlAbstractNumbering> defaultAbstractNumberings = WmlAbstractNumbering.generateDefaultValues((Docx) getParentDoc());
125      if (CollectionUtil.hasValues(defaultAbstractNumberings))
126      {
127         for (WmlAbstractNumbering numberingDef : defaultAbstractNumberings)
128         {
129            int numberingId = addNumberingDef(numberingDef);
130            WmlNumberingFormat numberingFormat = numberingDef.getLevels().get(0).getNumberingFormat();
131            if (numberingFormat.equals(WmlNumberingFormat.bullet))
132            {
133               UNORDERED_LIST_ID = numberingId;
134            }
135            else if (numberingFormat.equals(WmlNumberingFormat.decimal))
136            {
137               ORDERED_LIST_ID = numberingId;
138            }
139         }
140      }
141   }
142}
143
144