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:
Cloneable
NOTE: Comment Associated with a Cell (0x001C)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NoteRecord[]static 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 valuesRead the record data from the suppliedRecordInputStream -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanFor unit testing only!clone()Name of the original comment authorintReturn the column that contains the commentprotected intshortgetFlags()Options flags.intgetRow()Return the row that contains the commentintObject id for OBJ record that contains the commentshortgetSid()return the non static version of the id for this record.voidWrite the data content of this BIFF record.voidName of the original comment authorvoidsetColumn(int col) Specify the column that contains the commentvoidsetFlags(short flags) Options flagvoidsetRow(int row) Specify the row that contains the commentvoidsetShapeId(int id) Object id for OBJ record that contains the commenttoString()Convert this record to string.Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
EMPTY_ARRAY
-
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
Read the record data from the suppliedRecordInputStream- Parameters:
in- the RecordInputStream to read from
-
-
Method Details
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
serialize
Description copied from class:StandardRecordWrite the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
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:
-
setFlags
public void setFlags(short flags) Options flag- Parameters:
flags- the options flag- See Also:
-
authorIsMultibyte
protected boolean authorIsMultibyte()For unit testing only!- Returns:
- true, if author element uses multi byte
-
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
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
-
clone
-