Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel
Class XSSFComment

java.lang.Object
  extended by org.apache.poi.xssf.usermodel.XSSFComment
All Implemented Interfaces:
Comment
public class XSSFComment
extends java.lang.Object
implements Comment

Constructor Summary
XSSFComment(CommentsTable comments, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment, com.microsoft.schemas.vml.CTShape vmlShape)
          Creates a new XSSFComment, associated with a given low level comment object.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 CellAddress getAddress()
           
 java.lang.String getAuthor()
           
 ClientAnchor getClientAnchor()
           
 int getColumn()
           
protected  org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment()
           
protected  com.microsoft.schemas.vml.CTShape getCTShape()
           
 int getRow()
           
 XSSFRichTextString getString()
           
 int hashCode()
           
 boolean isVisible()
          Returns whether this comment is visible.
 void setAddress(CellAddress address)
           
 void setAddress(int row, int col)
           
 void setAuthor(java.lang.String author)
          Name of the original comment author.
 void setColumn(int col)
          Set the column of the cell that contains the comment If changing both row and column, use setAddress(int, int).
 void setRow(int row)
          Set the row of the cell that contains the comment If changing both row and column, use setAddress(int, int).
 void setString(RichTextString string)
          Sets the rich text string used by this comment.
 void setString(java.lang.String string)
           
 void setVisible(boolean visible)
          Sets whether this comment is visible.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XSSFComment

public XSSFComment(CommentsTable comments,
                   org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment,
                   com.microsoft.schemas.vml.CTShape vmlShape)
Creates a new XSSFComment, associated with a given low level comment object.

Method Detail

getAuthor

public java.lang.String getAuthor()
Specified by:
getAuthor in interface Comment
Returns:
Name of the original comment author. Default value is blank.

setAuthor

public void setAuthor(java.lang.String author)
Name of the original comment author. Default value is blank.

Specified by:
setAuthor in interface Comment
Parameters:
author - the name of the original author of the comment

getColumn

public int getColumn()
Specified by:
getColumn in interface Comment
Returns:
the 0-based column of the cell that the comment is associated with.

getRow

public int getRow()
Specified by:
getRow in interface Comment
Returns:
the 0-based row index of the cell that the comment is associated with.

isVisible

public boolean isVisible()
Returns whether this comment is visible.

Specified by:
isVisible in interface Comment
Returns:
true if the comment is visible, false otherwise

setVisible

public void setVisible(boolean visible)
Sets whether this comment is visible.

Specified by:
setVisible in interface Comment
Parameters:
visible - true if the comment is visible, false otherwise

getAddress

public CellAddress getAddress()
Specified by:
getAddress in interface Comment

setAddress

public void setAddress(int row,
                       int col)
Specified by:
setAddress in interface Comment

setAddress

public void setAddress(CellAddress address)
Specified by:
setAddress in interface Comment

setColumn

public void setColumn(int col)
Set the column of the cell that contains the comment If changing both row and column, use setAddress(int, int).

Specified by:
setColumn in interface Comment
Parameters:
col - the 0-based column of the cell that contains the comment

setRow

public void setRow(int row)
Set the row of the cell that contains the comment If changing both row and column, use setAddress(int, int).

Specified by:
setRow in interface Comment
Parameters:
row - the 0-based row of the cell that contains the comment

getString

public XSSFRichTextString getString()
Specified by:
getString in interface Comment
Returns:
the rich text string of the comment

setString

public void setString(RichTextString string)
Sets the rich text string used by this comment.

Specified by:
setString in interface Comment
Parameters:
string - the XSSFRichTextString used by this object.

setString

public void setString(java.lang.String string)

getClientAnchor

public ClientAnchor getClientAnchor()
Specified by:
getClientAnchor in interface Comment

getCTComment

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment()
Returns:
the xml bean holding this comment's properties

getCTShape

protected com.microsoft.schemas.vml.CTShape getCTShape()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD