Package org.apache.poi.hssf.record
Class NameCommentRecord
- 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.NameCommentRecord
-
public final class NameCommentRecord extends StandardRecord
Title: NAMECMT Record (0x0894)Description: Defines a comment associated with a specified name.
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description NameCommentRecord(java.lang.String name, java.lang.String comment)
NameCommentRecord(RecordInputStream ris)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCommentText()
protected int
getDataSize()
java.lang.String
getNameText()
short
getRecordType()
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
setCommentText(java.lang.String comment)
void
setNameText(java.lang.String newName)
Updates the name we're associated with, normally used when renaming that Namejava.lang.String
toString()
get a string representation of the record (for biffview/debugging)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NameCommentRecord
public NameCommentRecord(java.lang.String name, java.lang.String comment)
-
NameCommentRecord
public NameCommentRecord(RecordInputStream ris)
- Parameters:
ris
- the RecordInputstream to read the record from
-
-
Method Detail
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
Write 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:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()
return the non static version of the id for this record.
-
toString
public java.lang.String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
getNameText
public java.lang.String getNameText()
- Returns:
- the name of the NameRecord to which this comment applies.
-
setNameText
public void setNameText(java.lang.String newName)
Updates the name we're associated with, normally used when renaming that Name- Parameters:
newName
- the new name
-
getCommentText
public java.lang.String getCommentText()
- Returns:
- the text of the comment.
-
setCommentText
public void setCommentText(java.lang.String comment)
-
getRecordType
public short getRecordType()
-
-