com.hfg.xml.msofficexml.docx.wordprocessingml.WmlFooter 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.OfficeXML;
import com.hfg.xml.msofficexml.docx.Docx;
import com.hfg.xml.msofficexml.docx.RelationshipXML;
import com.hfg.xml.msofficexml.docx.drawingml.DmlXML;
import com.hfg.xml.msofficexml.docx.part.FooterPart;
import com.hfg.xml.msofficexml.docx.wordprocessingml.field.WmlSimpleField;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML footer (<w:ftr>) tag.

 @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 WmlFooter extends WmlContentContainer
{
   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public WmlFooter(Docx inDocx)
   {
      super(WmlXML.FOOTER, inDocx);
      // Word is sensitive to the namespace prefixes being used.
      // To ensure that tags are prefixed, we pre-define the namespace.
      addXMLNamespaceDeclaration(WmlXML.WORDPROCESSINGML_NAMESPACE);

      addXMLNamespaceDeclaration(RelationshipXML.RELATIONSHIP_NAMESPACE);
      addXMLNamespaceDeclaration(OfficeXML.OFFICE_NAMESPACE);
      addXMLNamespaceDeclaration(WmlXML.WORDPROCESSING_DRAWING_NAMESPACE);
      addXMLNamespaceDeclaration(DmlXML.DRAWINGML_NAMESPACE);
      addXMLNamespaceDeclaration(DmlXML.PIC_NAMESPACE);

      setPart(new FooterPart(inDocx, this));
   }


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

   //---------------------------------------------------------------------------
   @Override
   public FooterPart getPart()
   {
      return (FooterPart) super.getPart();
   }

   //---------------------------------------------------------------------------
   /**
    Calls generatePage_X_of_Y() and then adds it to the footer.
    */
   public WmlParagraph addPage_X_of_Y()
   {
      WmlParagraph p = generatePage_X_of_Y();
      addSubtag(p);

      return p;
   }

   //---------------------------------------------------------------------------
   /*
   
     
     Page 
     1
      of 
     1
   
    */
   public WmlParagraph generatePage_X_of_Y()
   {
      WmlParagraph p = new WmlParagraph(getParentDoc());

      p.addTextRun("Page ");

      WmlSimpleField simpleField = new WmlSimpleField(getParentDoc())
            .setInstruction(" PAGE ");

      WmlTextRun run = new WmlTextRun(getParentDoc()).addText("1");
      run.getProperties().disableSpellingAndGrammarChecks();
      simpleField.addSubtag(run);
      p.addSubtag(simpleField);

      p.addTextRun(" of ");

      simpleField = new WmlSimpleField(getParentDoc())
            .setInstruction(" NUMPAGES ");

      run = new WmlTextRun(getParentDoc()).addText("1");
      run.getProperties().disableSpellingAndGrammarChecks();
      simpleField.addSubtag(run);
      p.addSubtag(simpleField);

      return p;
   }

   //---------------------------------------------------------------------------
   public WmlParagraph addParagraph()
   {
      WmlParagraph p = new WmlParagraph(getParentDoc());
      addSubtag(p);

      return p;
   }

   //---------------------------------------------------------------------------
   public WmlParagraph addParagraph(String inContent)
   {
      WmlParagraph p = addParagraph();
      p.addTextRun().addText(inContent);

      return p;
   }

   //---------------------------------------------------------------------------
   public WmlTable addTable()
   {
      WmlTable table = new WmlTable(getParentDoc());
      addSubtag(table);

      return table;
   }

}