com.spire.xls.core.spreadsheet.shapes
Class XlsComment

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.shapes.XlsShape
          com.spire.xls.core.spreadsheet.shapes.XlsComment

All Implemented Interfaces:

IComment, ICommentShape, IShape, ITextBox, ITextBoxShape

public class XlsComment
extends XlsShape
implements ICommentShape

Constructor Summary

XlsComment(java.lang.Object parent)

Method Summary

IShape	deepCloneInner(java.lang.Object parent, java.util.HashMap hashNewNames, java.util.HashMap dicFontIndexes, boolean addToCollections) Creates a clone of the current shape.
java.lang.String	getAuthor() Comment's author.
boolean	getAutoSize() True if the size of the specified object is changed automatically to fit text within its boundaries.
int	getColumn() Column of the commented cell.
IShapeFill	getFill() Represents fill properties.
CommentHAlignType	getHAlignment() Horizontal alignment of the text.
IRichTextString	getRichText() Text of the comment.
int	getRow() Row of the commented cell.
ExcelShapeType	getShapeType() Type of shape , Read Only.
java.lang.String	getText() Sets text of the comment.
TextRotationType	getTextRotation() Text rotation.
CommentVAlignType	getVAlignment() Vertical alignment of the text.
boolean	isTextLocked() Indicates whether comment text is locked.
void	isTextLocked(boolean value) Indicates whether comment text is locked.
boolean	isVisible() Indicates whether comment is visible.
void	remove() Removes object.
void	setAuthor(java.lang.String value) Comment's author.
void	setAutoSize(boolean value) True if the size of the specified object is changed automatically to fit text within its boundaries.
void	setColumn(int value) Column of the commented cell.
void	setHAlignment(CommentHAlignType value) Horizontal alignment of the text.
void	setRow(int value) Row of the commented cell.
void	setText(java.lang.String value) Sets text of the comment.
void	setTextRotation(TextRotationType value) Text rotation.
void	setVAlignment(CommentVAlignType value) Vertical alignment of the text.

Methods inherited from class com.spire.xls.core.spreadsheet.shapes.XlsShape

deepClone, deepClone, getAlternativeText, getAlternativeTextTitle, getBottomRow, getBottomRowOffset, getHeight, getID, getLeft, getLeftColumn, getLeftColumnOffset, getLine, getName, getOnAction, getResizeBehave, getRightColumn, getRightColumnOffset, getRotation, getShadow, getShapeId, getThreeD, getTop, getTopRow, getTopRowOffset, getUpdatePositions, getVisible, getVmlShape, getWidth, hasFill, hasFill, hasLineFormat, hasLineFormat, isFlipH, isFlipH, isFlipV, isFlipV, isGroup, isLockAspectRatio, isLockAspectRatio, isLocked, isLocked, isPrintable, isPrintable, isRelative, isRelative, scale, setAlternativeText, setAlternativeTextTitle, setBottomRow, setBottomRowOffset, setHeight, setLeft, setLeftColumn, setLeftColumnOffset, setName, setOnAction, setResizeBehave, setRightColumn, setRightColumnOffset, setRotation, setShapeType, setTop, setTopRow, setTopRowOffset, setUpdatePositions, setVisible, setWidth

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Methods inherited from interface com.spire.xls.core.ITextBoxShape

getLine

Methods inherited from interface com.spire.xls.core.IShape

getAlternativeText, getHeight, getID, getLeft, getName, getOnAction, getResizeBehave, getRotation, getShadow, getThreeD, getTop, getVisible, getWidth, isLockAspectRatio, isLockAspectRatio, isLocked, isLocked, isPrintable, isPrintable, scale, setHeight, setName, setOnAction, setResizeBehave, setRotation, setTop, setVisible, setWidth

Constructor Detail

XlsComment

public XlsComment(java.lang.Object parent)

Method Detail

getShapeType

public ExcelShapeType getShapeType()

Description copied from class: XlsShape

Type of shape , Read Only.

Specified by:

getShapeType in interface IShape

Overrides:

getShapeType in class XlsShape

getAuthor

public java.lang.String getAuthor()

Comment's author.

Specified by:

getAuthor in interface IComment

setAuthor

public void setAuthor(java.lang.String value)

Comment's author.

getAutoSize

public boolean getAutoSize()

Description copied from class: XlsShape

True if the size of the specified object is changed automatically to fit text within its boundaries.

Specified by:

getAutoSize in interface IComment

Overrides:

getAutoSize in class XlsShape

setAutoSize

public void setAutoSize(boolean value)

Description copied from class: XlsShape

True if the size of the specified object is changed automatically to fit text within its boundaries.

Overrides:

setAutoSize in class XlsShape

getColumn

public int getColumn()

Column of the commented cell.

Specified by:

getColumn in interface IComment

setColumn

public void setColumn(int value)

Column of the commented cell.

getRow

public int getRow()

Row of the commented cell.

Specified by:

getRow in interface IComment

setRow

public void setRow(int value)

Row of the commented cell.

getText

public java.lang.String getText()

Description copied from interface: ITextBox

Sets text of the comment.

Specified by:

getText in interface ITextBox

setText

public void setText(java.lang.String value)

Description copied from interface: ITextBox

Sets text of the comment.

Specified by:

setText in interface ITextBox

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

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

getRichText

public IRichTextString getRichText()

Description copied from interface: ITextBox

Text of the comment. Read-only.

Specified by:

getRichText in interface ITextBox

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

remove

public void remove()

Description copied from class: XlsShape

Removes object.

Specified by:

remove in interface IShape

Overrides:

remove in class XlsShape

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

isVisible

public boolean isVisible()

Indicates whether comment is visible.

Specified by:

isVisible in interface IComment

getFill

public IShapeFill getFill()

Description copied from class: XlsShape

Represents fill properties.

Specified by:

getFill in interface IShape

Overrides:

getFill in class XlsShape

deepCloneInner

public IShape deepCloneInner(java.lang.Object parent,
                             java.util.HashMap hashNewNames,
                             java.util.HashMap dicFontIndexes,
                             boolean addToCollections)

Creates a clone of the current shape.

Parameters:

parent - New parent for the shape object.

hashNewNames - Hashtable with new worksheet names.

dicFontIndexes - Dictionary with new font indexes.

Returns:

A copy of the current shape.