com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlTable 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.spreadsheetml;



import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.xlsx.CellRange;
import com.hfg.xml.msofficexml.xlsx.Xlsx;
import com.hfg.xml.msofficexml.xlsx.part.TablePart;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML table definition (<ssml:table>) tag.
 This is the root tag of a table 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 SsmlTable extends SsmlXMLTag
{
   //###########################################################################
   // PRIVATE FIELDS
   //###########################################################################

   private TablePart mParentTablePart;
   private XMLTag    mTableColumnsTag;
   private XMLTag    mAutoFilterTag;

   private CellRange mCellRange;
   private int       mColumnIndex = 1;

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

   //---------------------------------------------------------------------------
   public SsmlTable(TablePart inParentTablePart)
   {
      super(SsmlXML.TABLE, (Xlsx) inParentTablePart.getParentDoc());

      mParentTablePart = inParentTablePart;

      // Set some default attributes

   }

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

   //---------------------------------------------------------------------------
   public SsmlTable setId(int inValue)
   {
      setAttribute(SsmlXML.ID_ATT, inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public TablePart getParentTablePart()
   {
      return mParentTablePart;
   }

   //---------------------------------------------------------------------------
   public SsmlTable setName(String inValue)
   {
      String existingTableName = getAttributeValue(SsmlXML.NAME_ATT);
      if (existingTableName != null)
      {
         getParentTablePart().getParentWorksheetPart().getRootNode().renameTable(existingTableName, inValue);
      }

      setAttribute(SsmlXML.NAME_ATT, inValue);
      setAttribute(SsmlXML.DISPLAY_NAME_ATT, inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public String getName()
   {
      return getAttributeValue(SsmlXML.NAME_ATT);
   }

   //---------------------------------------------------------------------------
   public SsmlTable setCellRange(CellRange inValue)
   {
      mCellRange = inValue;

      setAttribute(SsmlXML.REF_RANGE_ATT, mCellRange);

      // Add an autoFilter tag with the same ref range
      if (null == mAutoFilterTag)
      {
         mAutoFilterTag = new XMLTag(SsmlXML.AUTO_FILTER);
         addSubtag(mAutoFilterTag);
      }
      mAutoFilterTag.setAttribute(SsmlXML.REF_RANGE_ATT, mCellRange);

      return this;
   }

   //---------------------------------------------------------------------------
   public SsmlTable addColumn(String inName)
   {
      if (null == mTableColumnsTag)
      {
         mTableColumnsTag = new XMLTag(SsmlXML.TABLE_COLUMNS);
         addSubtag(mTableColumnsTag);
      }

      XMLTag columnTag = new XMLTag(SsmlXML.TABLE_COLUMN);
      columnTag.setAttribute(SsmlXML.ID_ATT, mColumnIndex++);
      columnTag.setAttribute(SsmlXML.NAME_ATT, inName);
      mTableColumnsTag.addSubtag(columnTag);

      mTableColumnsTag.setAttribute(SsmlXML.COUNT_ATT, mColumnIndex - 1);

      return this;
   }
}