|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public final class NoteRecord
NOTE: Comment Associated with a Cell (0x001C)
Field Summary | |
---|---|
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 visible |
static short |
sid
|
Constructor Summary | |
---|---|
NoteRecord()
Construct a new NoteRecord and
fill its data with the default values |
|
NoteRecord(RecordInputStream in)
Read the record data from the supplied RecordInputStream |
Method Summary | |
---|---|
protected boolean |
authorIsMultibyte()
For unit testing only! |
java.lang.Object |
clone()
|
java.lang.String |
getAuthor()
Name of the original comment author |
int |
getColumn()
Return the column that contains the comment |
protected int |
getDataSize()
|
short |
getFlags()
Options flags. |
int |
getRow()
Return the row that contains the comment |
int |
getShapeId()
Object id for OBJ record that contains the comment |
short |
getSid()
return the non static version of the id for this record. |
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record. |
void |
setAuthor(java.lang.String author)
Name of the original comment author |
void |
setColumn(int col)
Specify the column that contains the comment |
void |
setFlags(short flags)
Options flag |
void |
setRow(int row)
Specify the row that contains the comment |
void |
setShapeId(int id)
Object id for OBJ record that contains the comment |
java.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 |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
public static final NoteRecord[] EMPTY_ARRAY
public static final short NOTE_HIDDEN
public static final short NOTE_VISIBLE
Constructor Detail |
---|
public NoteRecord()
NoteRecord
and
fill its data with the default values
public NoteRecord(RecordInputStream in)
RecordInputStream
Method Detail |
---|
public short getSid()
Record
getSid
in class Record
public void serialize(LittleEndianOutput out)
StandardRecord
RecordBase.getRecordSize()
} minus four
( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
by thye superclass).
serialize
in class StandardRecord
protected int getDataSize()
getDataSize
in class StandardRecord
public java.lang.String toString()
toString
in class Record
public int getRow()
public void setRow(int row)
row
- the row that contains the commentpublic int getColumn()
public void setColumn(int col)
col
- the column that contains the commentpublic short getFlags()
NOTE_VISIBLE
,
NOTE_HIDDEN
public void setFlags(short flags)
flags
- the options flagNOTE_VISIBLE
,
NOTE_HIDDEN
protected boolean authorIsMultibyte()
public int getShapeId()
public void setShapeId(int id)
public java.lang.String getAuthor()
public void setAuthor(java.lang.String author)
author
- the name of the original author of the commentpublic java.lang.Object clone()
clone
in class Record
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |