public Class HSSFComment

Overrides org.apache.poi.hssf.usermodel.HSSFTextbox.afterRemove.

Doc from org.apache.poi.hssf.usermodel.HSSFShape.afterRemove.

remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes

Annotations

@Override

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.getAddress.

Doc from org.apache.poi.ss.usermodel.Comment.getAddress.

Get the address of the cell that this comment is attached to

Returns:CellAddress

comment cell address

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.getAuthor.

Name of the original comment author

Returns:String

the name of the original author of the comment

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.getClientAnchor.

Doc from org.apache.poi.ss.usermodel.Comment.getClientAnchor.

Return defined position of this anchor in the sheet. The anchor is the yellow box/balloon that is rendered on top of the sheets when the comment is visible. To associate a comment with a different cell, use setAddress.

Returns:ClientAnchor

defined position of this anchor in the sheet, can be null

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.getColumn.

Return the column of the cell that contains the comment

Returns:int

the 0-based column of the cell that contains the comment

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.getRow.

Return the row of the cell that contains the comment

Returns:int

the 0-based row of the cell that contains the comment

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Do we know which cell this comment belongs to?

Implements org.apache.poi.ss.usermodel.Comment.isVisible.

Returns whether this comment is visible.

Returns:boolean

true if the comment is visible, false otherwise

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setAddress.

Doc from org.apache.poi.ss.usermodel.Comment.setAddress.

Set the address of the cell that this comment is attached to

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setAddress.

Doc from org.apache.poi.ss.usermodel.Comment.setAddress.

Set the address of the cell that this comment is attached to

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setAuthor.

Name of the original comment author

Parameters

author:String

the name of the original author of the comment

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setColumn.

Set the column of the cell that contains the comment

Parameters

col:int

the 0-based column of the cell that contains the comment

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setRow.

Set the row of the cell that contains the comment

Parameters

row:int

the 0-based row of the cell that contains the comment

Annotations

@Override

Overrides org.apache.poi.hssf.usermodel.HSSFTextbox.setShapeType.

Parameters

shapeType:int

Doc from org.apache.poi.hssf.usermodel.HSSFSimpleShape.setShapeType.

- shapeType

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Comment.setVisible.

Sets whether this comment is visible.

Parameters

visible:boolean

true if the comment is visible, false otherwise

Annotations

@Override