Package loci.poi.hssf.record
Class NoteRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.NoteRecord
NOTE: Comment Associated with a Cell (1Ch)
- Author:
- Yegor Kozlov
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortFlag indicating that the comment is hidden (default)static final shortFlag indicating that the comment is visiblestatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a newNoteRecordand fill its data with the default valuesConstructs aNoteRecordand fills its fields from the suppliedRecordInputStream. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidRead the record data from the suppliedRecordInputStreamName of the original comment authorshortReturn the column that contains the commentshortgetFlags()Options flags.intSize of recordshortgetRow()Return the row that contains the commentshortObject id for OBJ record that contains the commentshortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) Serialize the record data into the supplied array of bytesvoidName of the original comment authorvoidsetColumn(short col) Specify the column that contains the commentvoidsetFlags(short flags) Options flagvoidsetRow(short row) Specify the row that contains the commentvoidsetShapeId(short id) Object id for OBJ record that contains the commenttoString()Convert this record to string.protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
NOTE_HIDDEN
public static final short NOTE_HIDDENFlag indicating that the comment is hidden (default)- See Also:
-
NOTE_VISIBLE
public static final short NOTE_VISIBLEFlag indicating that the comment is visible- See Also:
-
-
Constructor Details
-
NoteRecord
public NoteRecord()Construct a newNoteRecordand fill its data with the default values -
NoteRecord
Constructs aNoteRecordand fills its fields from the suppliedRecordInputStream.- Parameters:
in- the stream to read from
-
-
Method Details
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Read the record data from the suppliedRecordInputStream- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
serialize
public int serialize(int offset, byte[] data) Serialize the record data into the supplied array of bytes -
getRecordSize
public int getRecordSize()Size of record- Overrides:
getRecordSizein classRecord
-
toString
Convert this record to string. Used by BiffViewer and other utulities. -
getRow
public short getRow()Return the row that contains the comment- Returns:
- the row that contains the comment
-
setRow
public void setRow(short row) Specify the row that contains the comment- Parameters:
row- the row that contains the comment
-
getColumn
public short getColumn()Return the column that contains the comment- Returns:
- the column that contains the comment
-
setColumn
public void setColumn(short col) Specify the column that contains the comment- Parameters:
col- the column that contains the comment
-
getFlags
public short getFlags()Options flags.- Returns:
- the options flag
- See Also:
-
setFlags
public void setFlags(short flags) Options flag- Parameters:
flags- the options flag- See Also:
-
getShapeId
public short getShapeId()Object id for OBJ record that contains the comment -
setShapeId
public void setShapeId(short id) Object id for OBJ record that contains the comment -
getAuthor
Name of the original comment author- Returns:
- the name of the original author of the comment
-
setAuthor
Name of the original comment author- Parameters:
author- the name of the original author of the comment
-