Package org.apache.poi.hssf.usermodel
Class HSSFComment
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFShape
org.apache.poi.hssf.usermodel.HSSFSimpleShape
org.apache.poi.hssf.usermodel.HSSFTextbox
org.apache.poi.hssf.usermodel.HSSFComment
- All Implemented Interfaces:
Comment,Shape,SimpleShape
Represents a cell comment - a sticky note associated with a cell.
-
Field Summary
Fields inherited from class org.apache.poi.hssf.usermodel.HSSFTextbox
HORIZONTAL_ALIGNMENT_CENTERED, HORIZONTAL_ALIGNMENT_DISTRIBUTED, HORIZONTAL_ALIGNMENT_JUSTIFIED, HORIZONTAL_ALIGNMENT_LEFT, HORIZONTAL_ALIGNMENT_RIGHT, OBJECT_TYPE_TEXT, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_CENTER, VERTICAL_ALIGNMENT_DISTRIBUTED, VERTICAL_ALIGNMENT_JUSTIFY, VERTICAL_ALIGNMENT_TOPFields inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape
OBJECT_TYPE_ARC, OBJECT_TYPE_COMBO_BOX, OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE, WRAP_BY_POINTS, WRAP_NONE, WRAP_SQUAREFields inherited from class org.apache.poi.hssf.usermodel.HSSFShape
FILL__FILLCOLOR_DEFAULT, LINESTYLE__COLOR_DEFAULT, LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DASHDOTGEL, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHGEL, LINESTYLE_DASHSYS, LINESTYLE_DEFAULT, LINESTYLE_DOTGEL, LINESTYLE_DOTSYS, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_NONE, LINESTYLE_SOLID, LINEWIDTH_DEFAULT, LINEWIDTH_ONE_PT, NO_FILL_DEFAULT, NO_FILLHITTEST_FALSE, NO_FILLHITTEST_TRUE -
Constructor Summary
ConstructorsModifierConstructorDescriptionHSSFComment(EscherContainerRecord spContainer, ObjRecord objRecord, TextObjectRecord textObjectRecord, NoteRecord note) protectedHSSFComment(NoteRecord note, TextObjectRecord txo) HSSFComment(HSSFShape parent, HSSFAnchor anchor) Construct a new comment with the given parent and anchor. -
Method Summary
Modifier and TypeMethodDescriptionvoidafterRemove(HSSFPatriarch patriarch) remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapesprotected HSSFShapeprotected ObjRecordprotected EscherContainerRecordbooleanGet the address of the cell that this comment is attached toName of the original comment authorintReturn defines position of this anchor in the sheet.intReturn the column of the cell that contains the commentprotected NoteRecordReturns the underlying Note recordintgetRow()Return the row of the cell that contains the commentinthashCode()booleanDo we know which cell this comment belongs to?booleanReturns whether this comment is visible.voidvoidsetAddress(int row, int col) Set the address of the cell that this comment is attached tovoidsetAddress(CellAddress address) Set the address of the cell that this comment is attached tovoidName of the original comment authorvoidsetBackgroundImage(int pictureIndex) voidsetColumn(int col) Set the column of the cell that contains the commentvoidsetRow(int row) Set the row of the cell that contains the commentvoidsetShapeType(int shapeType) voidsetVisible(boolean visible) Sets whether this comment is visible.Methods inherited from class org.apache.poi.hssf.usermodel.HSSFTextbox
getHorizontalAlignment, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getVerticalAlignment, setHorizontalAlignment, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setVerticalAlignmentMethods inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape
createTextObjRecord, getShapeId, getShapeType, getString, getTextObjectRecord, getWrapText, setString, setWrapTextMethods inherited from class org.apache.poi.hssf.usermodel.HSSFShape
countOfAllChildren, getAnchor, getEscherContainer, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getObjRecord, getOptRecord, getParent, getPatriarch, getRotationDegree, getShapeName, isFlipHorizontal, isFlipVertical, isNoFill, setAnchor, setFillColor, setFillColor, setFlipHorizontal, setFlipVertical, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill, setParent, setPatriarch, setPropertyValue, setRotationDegreeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.poi.ss.usermodel.Shape
getAnchor, getParent, getShapeName, isNoFill, setFillColor, setLineStyleColor, setNoFill
-
Constructor Details
-
HSSFComment
public HSSFComment(EscherContainerRecord spContainer, ObjRecord objRecord, TextObjectRecord textObjectRecord, NoteRecord note) -
HSSFComment
Construct a new comment with the given parent and anchor.- Parameters:
parent-anchor- defines position of this anchor in the sheet
-
HSSFComment
-
-
Method Details
-
createSpContainer
- Overrides:
createSpContainerin classHSSFTextbox
-
createObjRecord
- Overrides:
createObjRecordin classHSSFTextbox
-
setVisible
public void setVisible(boolean visible) Sets whether this comment is visible.- Specified by:
setVisiblein interfaceComment- Parameters:
visible-trueif the comment is visible,falseotherwise
-
isVisible
public boolean isVisible()Returns whether this comment is visible. -
getAddress
Description copied from interface:CommentGet the address of the cell that this comment is attached to- Specified by:
getAddressin interfaceComment- Returns:
- comment cell address
-
setAddress
Description copied from interface:CommentSet the address of the cell that this comment is attached to- Specified by:
setAddressin interfaceComment
-
setAddress
public void setAddress(int row, int col) Description copied from interface:CommentSet the address of the cell that this comment is attached to- Specified by:
setAddressin interfaceComment
-
getRow
public int getRow()Return the row of the cell that contains the comment -
setRow
public void setRow(int row) Set the row of the cell that contains the comment -
getColumn
public int getColumn()Return the column of the cell that contains the comment -
setColumn
public void setColumn(int col) Set the column of the cell that contains the comment -
getAuthor
Name of the original comment author -
setAuthor
Name of the original comment author -
getNoteRecord
Returns the underlying Note record -
hasPosition
public boolean hasPosition()Do we know which cell this comment belongs to? -
getClientAnchor
Description copied from interface:CommentReturn defines 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, useComment.setAddress(org.apache.poi.ss.util.CellAddress).- Specified by:
getClientAnchorin interfaceComment- Returns:
- defines position of this anchor in the sheet
-
setShapeType
public void setShapeType(int shapeType) - Overrides:
setShapeTypein classHSSFTextbox- Parameters:
shapeType- - shapeType- See Also:
-
afterRemove
Description copied from class:HSSFShaperemove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes- Overrides:
afterRemovein classHSSFTextbox
-
cloneShape
- Overrides:
cloneShapein classHSSFTextbox
-
setBackgroundImage
public void setBackgroundImage(int pictureIndex) -
resetBackgroundImage
public void resetBackgroundImage() -
getBackgroundImageId
public int getBackgroundImageId() -
equals
-
hashCode
public int hashCode()
-