|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.NoteRecord
public class NoteRecord
NOTE: Comment Associated with a Cell (1Ch)
| Field Summary | |
|---|---|
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)
Constructs a NoteRecord and fills its fields
from the supplied RecordInputStream. |
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
protected void |
fillFields(RecordInputStream in)
Read the record data from the supplied RecordInputStream |
java.lang.String |
getAuthor()
Name of the original comment author |
short |
getColumn()
Return the column that contains the comment |
short |
getFlags()
Options flags. |
int |
getRecordSize()
Size of record |
short |
getRow()
Return the row that contains the comment |
short |
getShapeId()
Object id for OBJ record that contains the comment |
short |
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 bytes |
void |
setAuthor(java.lang.String author)
Name of the original comment author |
void |
setColumn(short col)
Specify the column that contains the comment |
void |
setFlags(short flags)
Options flag |
void |
setRow(short row)
Specify the row that contains the comment |
void |
setShapeId(short id)
Object id for OBJ record that contains the comment |
java.lang.String |
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 org.apache.poi.hssf.record.Record |
|---|
cloneViaReserialise, isInValueSection, isValue, 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 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)
NoteRecord and fills its fields
from the supplied RecordInputStream.
in - the stream to read from| Method Detail |
|---|
public short getSid()
Record
getSid in class Recordprotected void validateSid(short id)
validateSid in class Recordid - the expected sid.protected void fillFields(RecordInputStream in)
RecordInputStream
fillFields in class Recordin - the RecordInputstream to read the record from
public int serialize(int offset,
byte[] data)
serialize in class Recordoffset - offset in the datadata - the data to serialize into
public int getRecordSize()
getRecordSize in class Recordpublic java.lang.String toString()
toString in class Recordpublic short getRow()
public void setRow(short row)
row - the row that contains the commentpublic short getColumn()
public void setColumn(short col)
col - the column that contains the commentpublic short getFlags()
NOTE_VISIBLE,
NOTE_HIDDENpublic void setFlags(short flags)
flags - the options flagNOTE_VISIBLE,
NOTE_HIDDENpublic short getShapeId()
public void setShapeId(short 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 | |||||||||