Package loci.poi.hssf.record
Class NoteRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.NoteRecord
-
public class NoteRecord extends Record
NOTE: Comment Associated with a Cell (1Ch)- Author:
- Yegor Kozlov
-
-
Field Summary
Fields Modifier and Type Field Description static short
NOTE_HIDDEN
Flag indicating that the comment is hidden (default)static short
NOTE_VISIBLE
Flag indicating that the comment is visiblestatic short
sid
-
Constructor Summary
Constructors Constructor Description NoteRecord()
Construct a newNoteRecord
and fill its data with the default valuesNoteRecord(RecordInputStream in)
Constructs aNoteRecord
and fills its fields from the suppliedRecordInputStream
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
Read the record data from the suppliedRecordInputStream
String
getAuthor()
Name of the original comment authorshort
getColumn()
Return the column that contains the commentshort
getFlags()
Options flags.int
getRecordSize()
Size of recordshort
getRow()
Return the row that contains the commentshort
getShapeId()
Object id for OBJ record that contains the commentshort
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
Serialize the record data into the supplied array of bytesvoid
setAuthor(String author)
Name of the original comment authorvoid
setColumn(short col)
Specify the column that contains the commentvoid
setFlags(short flags)
Options flagvoid
setRow(short row)
Specify the row that contains the commentvoid
setShapeId(short id)
Object id for OBJ record that contains the commentString
toString()
Convert this record to string.protected void
validateSid(short id)
Checks the sid matches the expected side for this record-
Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
NOTE_HIDDEN
public static final short NOTE_HIDDEN
Flag indicating that the comment is hidden (default)- See Also:
- Constant Field Values
-
NOTE_VISIBLE
public static final short NOTE_VISIBLE
Flag indicating that the comment is visible- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NoteRecord
public NoteRecord()
Construct a newNoteRecord
and fill its data with the default values
-
NoteRecord
public NoteRecord(RecordInputStream in)
Constructs aNoteRecord
and fills its fields from the suppliedRecordInputStream
.- Parameters:
in
- the stream to read from
-
-
Method Detail
-
getSid
public short getSid()
Description copied from class:Record
return 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:
validateSid
in classRecord
- Parameters:
id
- the expected sid.
-
fillFields
protected void fillFields(RecordInputStream in)
Read the record data from the suppliedRecordInputStream
- Specified by:
fillFields
in 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:
getRecordSize
in classRecord
-
toString
public String 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:
NOTE_VISIBLE
,NOTE_HIDDEN
-
setFlags
public void setFlags(short flags)
Options flag- Parameters:
flags
- the options flag- See Also:
NOTE_VISIBLE
,NOTE_HIDDEN
-
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
public String getAuthor()
Name of the original comment author- Returns:
- the name of the original author of the comment
-
setAuthor
public void setAuthor(String author)
Name of the original comment author- Parameters:
author
- the name of the original author of the comment
-
-