com.hfg.xml.msoffice2003.spreadsheetml.ExcelComment 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.msoffice2003.spreadsheetml;

import com.hfg.xml.XMLTag;


//------------------------------------------------------------------------------
/**
 Comment tag for use with Microsoft's Office 2003 SpreadsheetML.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg 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 ExcelComment extends XMLTag
{

   //---------------------------------------------------------------------------
   public ExcelComment(String inValue)
   {
      super(SpreadsheetML.COMMENT);

      addSubtag(new ExcelData(null, inValue));
   }

   //---------------------------------------------------------------------------
   /**
    Specifies the author of this comment.
    */
   public ExcelComment setAuthor(String inValue)
   {
      setAttribute(SpreadsheetML.AUTHOR_ATT, inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   /**
    Specifies whether this comment is displayed regardless of whether the user is hovering over the cell or not.
    */
   public ExcelComment setShowAlways(boolean inValue)
   {
      setAttribute(SpreadsheetML.SHOW_ALWAYS_ATT, inValue ? 1 : 0);
      return this;
   }

}