com.hfg.xml.msofficexml.docx.drawingml.text.DmlTextRun 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.drawingml.text;

import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.docx.drawingml.DmlXML;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML drawingml text run (<a:r>) 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 DmlTextRun  extends XMLTag
{
   private DmlTextRunProperties mProperties;

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

   //---------------------------------------------------------------------------
   public DmlTextRun()
   {
      super(DmlXML.TEXT_RUN);
   }

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

   //---------------------------------------------------------------------------
   /**
    * Returns whether or not this text run has a run properties subtag.
    */
   public boolean hasProperties()
   {
      return (getOptionalSubtagByName(DmlXML.RUN_PROPS) != null);
   }

   //---------------------------------------------------------------------------
   public void setProperties(DmlTextRunProperties inValue)
   {
      mProperties = getOptionalSubtagByName(DmlXML.RUN_PROPS);
      if (mProperties != null)
      {
         removeSubtag(mProperties);
      }

      mProperties = inValue;
      if (inValue != null)
      {
         addSubtag(inValue);
      }
   }

   //---------------------------------------------------------------------------
   /**
    * Returns the run properties tag if one exists or else instantiates a new one.
    * @return the run properties for this table
    */
   public DmlTextRunProperties getProperties()
   {
      if (null == mProperties)
      {
         // Check if it has been added via addSubtag()...
         mProperties = getOptionalSubtagByName(DmlXML.RUN_PROPS);
         if (null == mProperties)
         {
            mProperties = new DmlTextRunProperties();
            addSubtag(0, mProperties);
         }
      }

      return mProperties;
   }

   //---------------------------------------------------------------------------
   public DmlTextRun addText(String inText)
   {
      addSubtag(new DmlText().setContent(inText));

      return this;
   }



}