com.spire.xls
Class ExcelCommentObject

java.lang.Object
  com.spire.xls.ExcelCommentObject

All Implemented Interfaces:

IComment, ICommentShape, IShape, ITextBox, ITextBoxShape

Direct Known Subclasses:

ExcelComment

public class ExcelCommentObject
extends java.lang.Object
implements ICommentShape

Constructor Summary

ExcelCommentObject(ICommentShape commentShape)

Method Summary

java.lang.String	getAlternativeText() Alternative text.
java.lang.String	getAuthor() Gets the author of the comment.
boolean	getAutoSize() Indicates whether the size of the specified object is changed automatically to fit text within its boundaries.
int	getColumn() Gets column of the commented range.
IShapeFill	getFill()
CommentHAlignType	getHAlignment() Horizontal alignment of the text.
int	getHeight() Gets height of comment.
int	getID() Returns the type for the specified object.
int	getLeft() Gets position of left
IShapeLineFormat	getLine()
java.lang.String	getName() Gets name of object.
java.lang.String	getOnAction()
java.lang.Object	getParent()
ResizeBehaveType	getResizeBehave() Specifies all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted.
IRichTextString	getRichText() Gets comment rich text.
int	getRotation() Returns the rotation of the shape, in degrees.
int	getRow() Gets row of the commented range.
IShadow	getShadow()
ExcelShapeType	getShapeType() Gets shape type of object.
java.lang.String	getText() Gets comment text
TextRotationType	getTextRotation() Text rotation.
IFormat3D	getThreeD()
int	getTop() Gets top of object.
CommentVAlignType	getVAlignment() Vertical alignment of the text.
boolean	getVisible() Determines whether the object is visible.
int	getWidth() Gets width of object.
boolean	isLockAspectRatio() True means that don't allow changes in aspect ratio.
void	isLockAspectRatio(boolean value) True means that don't allow changes in aspect ratio.
boolean	isLocked() True if the object is locked, False if the object can be modified when the sheet is protected.
void	isLocked(boolean value) True if the object is locked, False if the object can be modified when the sheet is protected.
boolean	isPrintable() True if the object is printable
void	isPrintable(boolean value) True if the object is printable
boolean	isTextLocked() Indicates whether comment text is locked.
void	isTextLocked(boolean value) Indicates whether comment text is locked.
boolean	isVisible() Indicates whether the comment is visible.
void	isVisible(boolean value) Indicates whether the comment is visible.
void	remove() Removes comment.
void	scale(int scaleWidth, int scaleHeight) Scales all comments.
void	setAlternativeText(java.lang.String value) Sets alternative text.
void	setAutoSize(boolean value) Sets whether the size of the specified object is changed automatically to fit text within its boundaries.
void	setCommentLocation(boolean isMoveWithCell, boolean isSizeWithCell)
void	setHAlignment(CommentHAlignType value) Horizontal alignment of the text.
void	setHeight(int value) Sets height of comment.
void	setLeft(int value) Sets position of left
void	setName(java.lang.String value) Sets name of object.
void	setOnAction(java.lang.String value)
void	setResizeBehave(ResizeBehaveType value) Sets all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted.
void	setRotation(int value) Sets the rotation of the shape, in degrees.
void	setShapeType(ExcelShapeType value) Sets shape type of object.
void	setText(java.lang.String value) Sets comment text
void	setTextRotation(TextRotationType value) Text rotation.
void	setTop(int value) Sets top of object.
void	setVAlignment(CommentVAlignType value) Vertical alignment of the text.
void	setVisible(boolean value) Determines whether the object is visible.
void	setWidth(int value) Sets width of object.

Constructor Detail

ExcelCommentObject

public ExcelCommentObject(ICommentShape commentShape)

Method Detail

setCommentLocation

public void setCommentLocation(boolean isMoveWithCell,
                               boolean isSizeWithCell)

getAuthor

public java.lang.String getAuthor()

Gets the author of the comment.

Specified by:

getAuthor in interface IComment

isVisible

public boolean isVisible()

Indicates whether the comment is visible.

Specified by:

isVisible in interface IComment

isVisible

public void isVisible(boolean value)

Indicates whether the comment is visible.

getRow

public int getRow()

Gets row of the commented range.

Specified by:

getRow in interface IComment

getColumn

public int getColumn()

Gets column of the commented range.

Specified by:

getColumn in interface IComment

getRichText

public IRichTextString getRichText()

Gets comment rich text.

Specified by:

getRichText in interface ITextBox

getLine

public IShapeLineFormat getLine()

Specified by:

getLine in interface ITextBoxShape

getFill

public IShapeFill getFill()

Specified by:

getFill in interface IShape

getText

public java.lang.String getText()

Gets comment text

Specified by:

getText in interface ITextBox

setText

public void setText(java.lang.String value)

Sets comment text

Specified by:

setText in interface ITextBox

getAutoSize

public boolean getAutoSize()

Indicates whether the size of the specified object is changed automatically to fit text within its boundaries. Read/write Boolean.

Specified by:

getAutoSize in interface IComment

setAutoSize

public void setAutoSize(boolean value)

Sets whether the size of the specified object is changed automatically to fit text within its boundaries. Read/write Boolean.

getResizeBehave

public ResizeBehaveType getResizeBehave()

Specifies all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted.

Specified by:

getResizeBehave in interface IShape

setResizeBehave

public void setResizeBehave(ResizeBehaveType value)

Sets all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted.

Specified by:

setResizeBehave in interface IShape

getVisible

public boolean getVisible()

Description copied from interface: IShape

Determines whether the object is visible.

Specified by:

getVisible in interface IShape

setVisible

public void setVisible(boolean value)

Description copied from interface: IShape

Determines whether the object is visible.

Specified by:

setVisible in interface IShape

getHeight

public int getHeight()

Gets height of comment.

Specified by:

getHeight in interface IShape

setHeight

public void setHeight(int value)

Sets height of comment.

Specified by:

setHeight in interface IShape

getHAlignment

public CommentHAlignType getHAlignment()

Description copied from interface: ITextBox

Horizontal alignment of the text.

Specified by:

getHAlignment in interface ITextBox

setHAlignment

public void setHAlignment(CommentHAlignType value)

Description copied from interface: ITextBox

Horizontal alignment of the text.

Specified by:

setHAlignment in interface ITextBox

getVAlignment

public CommentVAlignType getVAlignment()

Description copied from interface: ITextBox

Vertical alignment of the text.

Specified by:

getVAlignment in interface ITextBox

setVAlignment

public void setVAlignment(CommentVAlignType value)

Description copied from interface: ITextBox

Vertical alignment of the text.

Specified by:

setVAlignment in interface ITextBox

getTextRotation

public TextRotationType getTextRotation()

Description copied from interface: ITextBox

Text rotation.

Specified by:

getTextRotation in interface ITextBox

setTextRotation

public void setTextRotation(TextRotationType value)

Description copied from interface: ITextBox

Text rotation.

Specified by:

setTextRotation in interface ITextBox

getID

public int getID()

Description copied from interface: IShape

Returns the type for the specified object. Read-only Integer.

Specified by:

getID in interface IShape

getLeft

public int getLeft()

Gets position of left

Specified by:

getLeft in interface IShape

setLeft

public void setLeft(int value)

Sets position of left

getName

public java.lang.String getName()

Gets name of object.

Specified by:

getName in interface IShape

setName

public void setName(java.lang.String value)

Sets name of object.

Specified by:

setName in interface IShape

getTop

public int getTop()

Gets top of object.

Specified by:

getTop in interface IShape

setTop

public void setTop(int value)

Sets top of object.

Specified by:

setTop in interface IShape

getWidth

public int getWidth()

Gets width of object.

Specified by:

getWidth in interface IShape

setWidth

public void setWidth(int value)

Sets width of object.

Specified by:

setWidth in interface IShape

getShapeType

public ExcelShapeType getShapeType()

Gets shape type of object.

Specified by:

getShapeType in interface IShape

setShapeType

public void setShapeType(ExcelShapeType value)

Sets shape type of object.

Parameters:

value -

isLocked

public boolean isLocked()

Description copied from interface: IShape

True if the object is locked, False if the object can be modified when the sheet is protected.

Specified by:

isLocked in interface IShape

isLocked

public void isLocked(boolean value)

Description copied from interface: IShape

True if the object is locked, False if the object can be modified when the sheet is protected.

Specified by:

isLocked in interface IShape

isPrintable

public boolean isPrintable()

Description copied from interface: IShape

True if the object is printable

Specified by:

isPrintable in interface IShape

isPrintable

public void isPrintable(boolean value)

Description copied from interface: IShape

True if the object is printable

Specified by:

isPrintable in interface IShape

getAlternativeText

public java.lang.String getAlternativeText()

Alternative text.

Specified by:

getAlternativeText in interface IShape

setAlternativeText

public void setAlternativeText(java.lang.String value)

Sets alternative text.

getParent

public java.lang.Object getParent()

isTextLocked

public boolean isTextLocked()

Description copied from interface: ITextBox

Indicates whether comment text is locked.

Specified by:

isTextLocked in interface ITextBox

isTextLocked

public void isTextLocked(boolean value)

Description copied from interface: ITextBox

Indicates whether comment text is locked.

Specified by:

isTextLocked in interface ITextBox

getOnAction

public java.lang.String getOnAction()

Specified by:

getOnAction in interface IShape

setOnAction

public void setOnAction(java.lang.String value)

Specified by:

setOnAction in interface IShape

isLockAspectRatio

public boolean isLockAspectRatio()

Description copied from interface: IShape

True means that don't allow changes in aspect ratio.

Specified by:

isLockAspectRatio in interface IShape

isLockAspectRatio

public void isLockAspectRatio(boolean value)

Description copied from interface: IShape

True means that don't allow changes in aspect ratio.

Specified by:

isLockAspectRatio in interface IShape

getShadow

public IShadow getShadow()

Specified by:

getShadow in interface IShape

getThreeD

public IFormat3D getThreeD()

Specified by:

getThreeD in interface IShape

getRotation

public int getRotation()

Returns the rotation of the shape, in degrees.

Specified by:

getRotation in interface IShape

setRotation

public void setRotation(int value)

Sets the rotation of the shape, in degrees.

Specified by:

setRotation in interface IShape

remove

public void remove()

Removes comment.

Specified by:

remove in interface IShape

scale

public void scale(int scaleWidth,
                  int scaleHeight)

Scales all comments.

Specified by:

scale in interface IShape

Parameters:

scaleWidth - Width scale in percents.

scaleHeight - Height scale in percents.