public class Comment
Example:
Workbook workbook = new Workbook();
CommentCollection comments = workbook.getWorksheets().get(0).getComments();
//Add comment to cell A1
int commentIndex = comments.add(0, 0);
Comment comment = comments.get(commentIndex);
comment.setNote("First note.");
comment.getFont().setName("Times New Roman");
//Add comment to cell B2
comments.add("B2");
comment = comments.get("B2");
comment.setNote("Second note.");
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getAuthor() | |
void | setAuthor(java.lang.Stringvalue) | |
Gets and sets Name of the original comment author | ||
boolean | getAutoSize() | |
void | setAutoSize(booleanvalue) | |
Indicates if size of comment is adjusted automatically according to its content. | ||
int | getColumn() | |
Gets the column index of the comment.
|
||
CommentShape | getCommentShape() | |
Get a Shape object that represents the shape attached to the specified comment.
|
||
Font | getFont() | |
Gets the font of comment.
|
||
int | getHeight() | |
void | setHeight(intvalue) | |
Represents the Height of the comment, in unit of pixels. | ||
double | getHeightCM() | |
void | setHeightCM(doublevalue) | |
Represents the height of the comment, in unit of centimeters. | ||
double | getHeightInch() | |
void | setHeightInch(doublevalue) | |
Represents the height of the comment, in unit of inches. | ||
java.lang.String | getHtmlNote() | |
void | setHtmlNote(java.lang.Stringvalue) | |
Gets and sets the html string which contains data and some formats in this comment. | ||
boolean | isVisible() | |
void | setVisible(booleanvalue) | |
Represents if the comment is visible or not. | ||
java.lang.String | getNote() | |
void | setNote(java.lang.Stringvalue) | |
Represents the content of comment. | ||
int | getRow() | |
Gets the row index of the comment.
|
||
int | getTextHorizontalAlignment() | |
void | setTextHorizontalAlignment(intvalue) | |
Gets and sets the text horizontal alignment type of the comment. The value of the property is TextAlignmentType integer constant. | ||
int | getTextOrientationType() | |
void | setTextOrientationType(intvalue) | |
Gets and sets the text orientation type of the comment. The value of the property is TextOrientationType integer constant. | ||
int | getTextVerticalAlignment() | |
void | setTextVerticalAlignment(intvalue) | |
Gets and sets the text vertical alignment type of the comment. The value of the property is TextAlignmentType integer constant. | ||
ThreadedCommentCollection | getThreadedComments() | |
Gets the list of threaded comments;
|
||
int | getWidth() | |
void | setWidth(intvalue) | |
Represents the width of the comment, in unit of pixels. | ||
double | getWidthCM() | |
void | setWidthCM(doublevalue) | |
Represents the width of the comment, in unit of centimeters. | ||
double | getWidthInch() | |
void | setWidthInch(doublevalue) | |
Represents the width of the comment, in unit of inches. |
Method Summary | ||
---|---|---|
FontSetting | characters(int startIndex, int length) | |
Returns a Characters object that represents a range of characters within the comment text.
|
||
void | formatCharacters(int startIndex, int length, Font font, StyleFlag flag) | |
Format some chararcters with the font setting.
|
||
java.util.ArrayList | getCharacters() | |
Returns all Characters objects
that represents a range of characters within the comment text.
|
public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)
public CommentShape getCommentShape()
public int getRow()
public int getColumn()
public ThreadedCommentCollection getThreadedComments()
public java.lang.String getNote() / public void setNote(java.lang.String value)
public java.lang.String getHtmlNote() / public void setHtmlNote(java.lang.String value)
public Font getFont()
public boolean isVisible() / public void setVisible(boolean value)
public int getTextOrientationType() / public void setTextOrientationType(int value)
public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
public boolean getAutoSize() / public void setAutoSize(boolean value)
public double getHeightCM() / public void setHeightCM(double value)
public double getWidthCM() / public void setWidthCM(double value)
public int getWidth() / public void setWidth(int value)
public int getHeight() / public void setHeight(int value)
public double getWidthInch() / public void setWidthInch(double value)
public double getHeightInch() / public void setHeightInch(double value)
public void formatCharacters(int startIndex, int length, Font font, StyleFlag flag)
startIndex
- The start index.length
- The the length.font
- The font setting.flag
- The flag of the font setting.public FontSetting characters(int startIndex, int length)
startIndex
- The index of the start of the character.length
- The number of characters.public java.util.ArrayList getCharacters()