src/java/org/apache/poi/hssf/usermodel/HSSFComment.java

   1 /* ====================================================================
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================== */
  17 package org.apache.poi.hssf.usermodel;
  18
  19 import org.apache.poi.hssf.record.EscherAggregate;
  20 import org.apache.poi.hssf.record.NoteRecord;
  21 import org.apache.poi.hssf.record.TextObjectRecord;
  22 import org.apache.poi.ddf.*;
  23
  24 import java.util.Map;
  25 import java.util.List;
  26 import java.util.Iterator;
  27
  28 /**
  29  * Represents a cell comment - a sticky note associated with a cell.
  30  *
  31  * @author Yegor Kozlov
  32  */
  33 public class HSSFComment extends HSSFTextbox {
  34
  35     private boolean visible;
  36     private short col, row;
  37     private String author;
  38
  39     private NoteRecord note = null;
  40     private TextObjectRecord txo = null;
  41
  42     /**
  43      * Construct a new comment with the given parent and anchor.
  44      *
  45      * @param parent
  46      * @param anchor  defines position of this anchor in the sheet
  47      */
  48     public HSSFComment( HSSFShape parent, HSSFAnchor anchor )
  49     {
  50         super( parent, anchor );
  51         setShapeType(OBJECT_TYPE_COMMENT);
  52
  53         //default color for comments
  54         fillColor = 0x08000050;
  55
  56         //by default comments are hidden
  57         visible = false;
  58
  59         author = "";
  60     }
  61
  62     protected HSSFComment( NoteRecord note, TextObjectRecord txo )
  63     {
  64         this( (HSSFShape)null, (HSSFAnchor)null );
  65         this.txo = txo;
  66         this.note = note;
  67     }
  68
  69     /**
  70      * Returns whether this comment is visible.
  71      *
  72      * @param visible <code>true</code> if the comment is visible, <code>false</code> otherwise
  73      */
  74     public void setVisible(boolean visible){
  75         if(note != null) note.setFlags(visible ? NoteRecord.NOTE_VISIBLE : NoteRecord.NOTE_HIDDEN);
  76         this.visible = visible;
  77     }
  78
  79     /**
  80      * Sets whether this comment is visible.
  81      *
  82      * @return <code>true</code> if the comment is visible, <code>false</code> otherwise
  83      */
  84     public boolean isVisible(){
  85         return this.visible;
  86     }
  87
  88     /**
  89      * Return the row of the cell that contains the comment
  90      *
  91      * @return the 0-based row of the cell that contains the comment
  92      */
  93     public int getRow(){
  94         return row;
  95     }
  96
  97     /**
  98      * Set the row of the cell that contains the comment
  99      *
 100      * @param row the 0-based row of the cell that contains the comment
 101      */
 102     public void setRow(int row){
 103         if(note != null) note.setRow((short)row);
 104         this.row = (short)row;
 105     }
 106
 107     /**
 108      * Return the column of the cell that contains the comment
 109      *
 110      * @return the 0-based column of the cell that contains the comment
 111      */
 112     public short getColumn(){
 113         return col;
 114     }
 115
 116     /**
 117      * Set the column of the cell that contains the comment
 118      *
 119      * @param col the 0-based column of the cell that contains the comment
 120      */
 121     public void setColumn(short col){
 122         if(note != null) note.setColumn(col);
 123         this.col = col;
 124     }
 125
 126     /**
 127      * Name of the original comment author
 128      *
 129      * @return the name of the original author of the comment
 130      */
 131     public String getAuthor(){
 132         return author;
 133     }
 134
 135     /**
 136      * Name of the original comment author
 137      *
 138      * @param author the name of the original author of the comment
 139      */
 140     public void setAuthor(String author){
 141         if(note != null) note.setAuthor(author);
 142         this.author = author;
 143     }
 144
 145     /**
 146      * Sets the rich text string used by this comment.
 147      *
 148      * @param string    Sets the rich text string used by this object.
 149      */
 150     public void setString( HSSFRichTextString string )  {
 151         //if font is not set we must set the default one
 152         if (string.numFormattingRuns() == 0) string.applyFont((short)0);
 153
 154         if (txo != null) {
 155             int frLength = ( string.numFormattingRuns() + 1 ) * 8;
 156             txo.setFormattingRunLength( (short) frLength );
 157             txo.setTextLength( (short) string.length() );
 158             txo.setStr( string );
 159         }
 160         super.setString(string);
 161     }
 162 }