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
Title: NAMECMT Record (0x0894)
Description: Defines a comment associated with a specified name.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected intshortshortgetSid()return the non static version of the id for this record.voidWrite the data content of this BIFF record.voidsetCommentText(String comment) voidsetNameText(String newName) Updates the name we're associated with, normally used when renaming that NametoString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
NameCommentRecord
-
NameCommentRecord
- Parameters:
ris- the RecordInputstream to read the record from
-
-
Method Details
-
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
-
getSid
public short getSid()return the non static version of the id for this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
getNameText
- Returns:
- the name of the NameRecord to which this comment applies.
-
setNameText
Updates the name we're associated with, normally used when renaming that Name- Parameters:
newName- the new name
-
getCommentText
- Returns:
- the text of the comment.
-
setCommentText
-
getRecordType
public short getRecordType()
-