org.apache.poi.hssf.record
public final class NoteRecord extends StandardRecord
Modifier and Type | Field and 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 visible
|
static short |
sid |
Constructor and Description |
---|
NoteRecord()
Construct a new
NoteRecord and
fill its data with the default values |
NoteRecord(RecordInputStream in)
Read the record data from the supplied
RecordInputStream |
Modifier and Type | Method and Description |
---|---|
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.
|
getRecordSize, serialize
cloneViaReserialise, serialize
public static final short sid
public static final NoteRecord[] EMPTY_ARRAY
public static final short NOTE_HIDDEN
public static final short NOTE_VISIBLE
public NoteRecord()
NoteRecord
and
fill its data with the default valuespublic NoteRecord(RecordInputStream in)
RecordInputStream
public short getSid()
Record
public void serialize(LittleEndianOutput out)
StandardRecord
RecordBase.getRecordSize()
}serialize
in class StandardRecord
protected int getDataSize()
getDataSize
in class StandardRecord
public java.lang.String toString()
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
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 commentCopyright 2016 The Apache Software Foundation or its licensors, as applicable.