com.hfg.xml.msofficexml.docx.wordprocessingml.WmlTableRow 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.wordprocessingml;


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

import java.util.List;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML table row (<w:tr>) 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 WmlTableRow extends WmlXMLTag
{
   private WmlTableRowProperties mTableRowProps;

   //---------------------------------------------------------------------------
   public WmlTableRow(Docx inDocx)
   {
      super(WmlXML.TABLE_ROW, inDocx);
   }

   //---------------------------------------------------------------------------
   /**
    * Generates a new table cell.
    */
   public WmlTableCell addCell()
   {
      WmlTableCell cell = new WmlTableCell(getParentDoc());
      addSubtag(cell);

      return cell;
   }

   //---------------------------------------------------------------------------
   /**
    * Generates a new table cell.
    */
   public WmlTableCell addCell(WmlParagraph inParagraph)
   {
      WmlTableCell cell = new WmlTableCell(getParentDoc());
      addSubtag(cell);
      cell.addSubtag(inParagraph);

      return cell;
   }

   //---------------------------------------------------------------------------
   /**
    * Generates a new table cell.
    */
   public WmlTableCell addCell(String inContent)
   {
      WmlTableCell cell = addCell();
      if (StringUtil.isSet(inContent))
      {
         cell.getParagraph().addTextRun().addText(inContent);
      }

      return cell;
   }

   //---------------------------------------------------------------------------
   /**
    * Returns the row cells.
    */
   public List getCells()
   {
      return getSubtagsByName(WmlXML.TABLE_CELL);
   }

   //---------------------------------------------------------------------------
   /**
    * Returns the table row properties tag if one exists or else instantiates a new one.
    * @return the table row properties for this cell
    */
   public WmlTableRowProperties getRowProperties()
   {
      if (null == mTableRowProps)
      {
         // Check it it has been added via addSubtag()...
         mTableRowProps = getOptionalSubtagByName(WmlXML.TABLE_ROW_PROPS);
         if (null == mTableRowProps)
         {
            mTableRowProps = new WmlTableRowProperties(getParentDoc());
            addSubtag(mTableRowProps);
         }
      }

      return mTableRowProps;
   }
}