Package org.apache.poi.hssf.record
Class NoteRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.NoteRecord
-
- All Implemented Interfaces:
java.lang.Cloneable
public final class NoteRecord extends StandardRecord implements java.lang.Cloneable
NOTE: Comment Associated with a Cell (0x001C)
-
-
Field Summary
Fields Modifier and Type Field Description static NoteRecord[]
EMPTY_ARRAY
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)
Read the record data from the suppliedRecordInputStream
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NoteRecord
clone()
java.lang.String
getAuthor()
Name of the original comment authorint
getColumn()
Return the column that contains the commentshort
getFlags()
Options flags.int
getRow()
Return the row that contains the commentint
getShapeId()
Object id for OBJ record that contains the commentshort
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
void
setAuthor(java.lang.String author)
Name of the original comment authorvoid
setColumn(int col)
Specify the column that contains the commentvoid
setFlags(short flags)
Options flagvoid
setRow(int row)
Specify the row that contains the commentvoid
setShapeId(int id)
Object id for OBJ record that contains the commentjava.lang.String
toString()
Convert this record to string.-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
EMPTY_ARRAY
public static final NoteRecord[] EMPTY_ARRAY
-
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)
Read the record data from the suppliedRecordInputStream
- Parameters:
in
- the RecordInputStream 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.
-
serialize
public void serialize(LittleEndianOutput out)
-
toString
public java.lang.String toString()
Convert this record to string. Used by BiffViewer and other utilities.
-
getRow
public int getRow()
Return the row that contains the comment- Returns:
- the row that contains the comment
-
setRow
public void setRow(int row)
Specify the row that contains the comment- Parameters:
row
- the row that contains the comment
-
getColumn
public int getColumn()
Return the column that contains the comment- Returns:
- the column that contains the comment
-
setColumn
public void setColumn(int 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 int getShapeId()
Object id for OBJ record that contains the comment- Returns:
- the Object id for OBJ record that contains the comment
-
setShapeId
public void setShapeId(int id)
Object id for OBJ record that contains the comment- Parameters:
id
- the Object id for OBJ record that contains the comment
-
getAuthor
public java.lang.String getAuthor()
Name of the original comment author- Returns:
- the name of the original author of the comment
-
setAuthor
public void setAuthor(java.lang.String author)
Name of the original comment author- Parameters:
author
- the name of the original author of the comment
-
clone
public NoteRecord clone()
-
-