com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlTextRun 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 java.util.regex.Pattern;

import com.hfg.xml.XMLNode;
import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeXML;
import com.hfg.xml.msofficexml.xlsx.Xlsx;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML rich text run (<ssml:r>) 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 SsmlTextRun extends SsmlXMLTag
{
   private static final Pattern sMultispacePattern = Pattern.compile("\\s{2,}");

   private SsmlTextRunProperties mProperties;

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

   //---------------------------------------------------------------------------
   public SsmlTextRun(Xlsx inXlsx)
   {
      super(SsmlXML.TEXT_RUN, inXlsx);
   }

   //---------------------------------------------------------------------------
   public SsmlTextRun(Xlsx inXlsx, String inText)
   {
      super(SsmlXML.TEXT_RUN, inXlsx);
      setText(inText);
   }

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

   //---------------------------------------------------------------------------
   public SsmlTextRun setText(String inValue)
   {
      XMLNode textTag = new XMLTag(SsmlXML.TEXT).setContent(inValue);

      if (sMultispacePattern.matcher(inValue).find())
      {
         setAttribute(OfficeXML.SPACE, "preserve");
      }

      addSubtag(textTag);
      return this;
   }

   //---------------------------------------------------------------------------
   public SsmlTextRunProperties getProperties()
   {
      if (null == mProperties)
      {
         // Check it it has been added via addSubtag()...
         mProperties = getOptionalSubtagByName(SsmlXML.TEXT_RUN_PROPS);
         if (null == mProperties)
         {
            mProperties = new SsmlTextRunProperties(getParentDoc());
            addSubtag(mProperties);
         }
      }

      return mProperties;
   }

}