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 from HSSFComment to low-level records.

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
private NoteRecord	note

Constructor Summary

Constructors

Constructor and Description
CommentShape(HSSFComment hssfShape, int shapeId) Creates the low-level records for a comment.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	addStandardOptions(HSSFShape shape, EscherOptRecord opt) Sets standard escher options for a comment.
private NoteRecord	createNoteRecord(HSSFComment shape, int shapeId) Creates the low level NoteRecord which holds the comment attributes.
NoteRecord	getNoteRecord() Return the NoteRecord 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

note

private NoteRecord note

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

createNoteRecord

private NoteRecord createNoteRecord(HSSFComment shape,
                          int shapeId)

Creates the low level NoteRecord which holds the comment attributes.

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 class AbstractShape

Parameters:

shape - The highlevel shape.

opt - The escher records holding the proerties

Returns:

number of escher options added

getNoteRecord

public NoteRecord getNoteRecord()

Return the NoteRecord holding the comment attributes

Returns:

NoteRecord holding the comment attributes