001package com.hfg.xml.msoffice2003.spreadsheetml;
002
003import com.hfg.xml.XMLTag;
004
005
006//------------------------------------------------------------------------------
007/**
008 Comment tag for use with Microsoft's Office 2003 SpreadsheetML.
009
010 @author J. Alex Taylor, hairyfatguy.com
011 */
012//------------------------------------------------------------------------------
013// com.hfg Library
014//
015// This library is free software; you can redistribute it and/or
016// modify it under the terms of the GNU Lesser General Public
017// License as published by the Free Software Foundation; either
018// version 2.1 of the License, or (at your option) any later version.
019//
020// This library is distributed in the hope that it will be useful,
021// but WITHOUT ANY WARRANTY; without even the implied warranty of
022// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
023// Lesser General Public License for more details.
024//
025// You should have received a copy of the GNU Lesser General Public
026// License along with this library; if not, write to the Free Software
027// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
028//
029// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
030// jataylor@hairyfatguy.com
031//------------------------------------------------------------------------------
032
033public class ExcelComment extends XMLTag
034{
035
036   //---------------------------------------------------------------------------
037   public ExcelComment(String inValue)
038   {
039      super(SpreadsheetML.COMMENT);
040
041      addSubtag(new ExcelData(null, inValue));
042   }
043
044   //---------------------------------------------------------------------------
045   /**
046    Specifies the author of this comment.
047    */
048   public ExcelComment setAuthor(String inValue)
049   {
050      setAttribute(SpreadsheetML.AUTHOR_ATT, inValue);
051      return this;
052   }
053
054   //---------------------------------------------------------------------------
055   /**
056    Specifies whether this comment is displayed regardless of whether the user is hovering over the cell or not.
057    */
058   public ExcelComment setShowAlways(boolean inValue)
059   {
060      setAttribute(SpreadsheetML.SHOW_ALWAYS_ATT, inValue ? 1 : 0);
061      return this;
062   }
063
064}