Package loci.poi.hssf.model
Class CommentShape
- java.lang.Object
-
- loci.poi.hssf.model.AbstractShape
-
- loci.poi.hssf.model.TextboxShape
-
- loci.poi.hssf.model.CommentShape
-
public class CommentShape extends TextboxShape
Represents a cell comment. This class converts highlevel model data fromHSSFComment
to low-level records.- Author:
- Yegor Kozlov
-
-
Constructor Summary
Constructors Constructor Description CommentShape(HSSFComment hssfShape, int shapeId)
Creates the low-level records for a comment.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected int
addStandardOptions(HSSFShape shape, EscherOptRecord opt)
Sets standard escher options for a comment.NoteRecord
getNoteRecord()
Return theNoteRecord
holding the comment attributes-
Methods inherited from class loci.poi.hssf.model.TextboxShape
getEscherTextbox, getObjRecord, getSpContainer, getTextObjectRecord
-
Methods inherited from class loci.poi.hssf.model.AbstractShape
createAnchor, createShape
-
-
-
-
Constructor Detail
-
CommentShape
public CommentShape(HSSFComment hssfShape, int shapeId)
Creates the low-level records for a comment.- Parameters:
hssfShape
- The highlevel shape.shapeId
- The shape id to use for this shape.
-
-
Method Detail
-
addStandardOptions
protected int addStandardOptions(HSSFShape shape, EscherOptRecord opt)
Sets standard escher options for a comment. This method is responsible for setting default background, shading and other comment properties.- Overrides:
addStandardOptions
in classAbstractShape
- Parameters:
shape
- The highlevel shape.opt
- The escher records holding the proerties- Returns:
- number of escher options added
-
getNoteRecord
public NoteRecord getNoteRecord()
Return theNoteRecord
holding the comment attributes- Returns:
NoteRecord
holding the comment attributes
-
-