Class NoteRecord

All Implemented Interfaces:
Cloneable

public final class NoteRecord extends StandardRecord implements Cloneable
NOTE: Comment Associated with a Cell (0x001C)
  • Field Details

    • sid

      public static final short sid
      See Also:
    • EMPTY_ARRAY

      public static final NoteRecord[] EMPTY_ARRAY
    • NOTE_HIDDEN

      public static final short NOTE_HIDDEN
      Flag indicating that the comment is hidden (default)
      See Also:
    • NOTE_VISIBLE

      public static final short NOTE_VISIBLE
      Flag indicating that the comment is visible
      See Also:
  • Constructor Details

    • NoteRecord

      public NoteRecord()
      Construct a new NoteRecord and fill its data with the default values
    • NoteRecord

      public NoteRecord(RecordInputStream in)
      Read the record data from the supplied RecordInputStream
      Parameters:
      in - the RecordInputStream to read from
  • Method Details

    • getSid

      public short getSid()
      Description copied from class: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
      Returns:
      id of this record.
    • 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 class StandardRecord
      Parameters:
      out - the output object
    • getDataSize

      protected int getDataSize()
      Specified by:
      getDataSize in class StandardRecord
    • toString

      public String toString()
      Convert this record to string. Used by BiffViewer and other utilities.
      Overrides:
      toString in class Record
    • getRow

      public int getRow()
      Return the row that contains the comment
      Returns:
      the row that contains the comment
    • setRow

      public void setRow(int row)
      Specify the row that contains the comment
      Parameters:
      row - the row that contains the comment
    • getColumn

      public int getColumn()
      Return the column that contains the comment
      Returns:
      the column that contains the comment
    • setColumn

      public void setColumn(int col)
      Specify the column that contains the comment
      Parameters:
      col - the column that contains the comment
    • getFlags

      public short getFlags()
      Options flags.
      Returns:
      the options flag
      See Also:
    • setFlags

      public void setFlags(short flags)
      Options flag
      Parameters:
      flags - the options flag
      See Also:
    • authorIsMultibyte

      protected boolean authorIsMultibyte()
      For unit testing only!
      Returns:
      true, if author element uses multi byte
    • getShapeId

      public int getShapeId()
      Object id for OBJ record that contains the comment
      Returns:
      the Object id for OBJ record that contains the comment
    • setShapeId

      public void setShapeId(int id)
      Object id for OBJ record that contains the comment
      Parameters:
      id - the Object id for OBJ record that contains the comment
    • getAuthor

      public String getAuthor()
      Name of the original comment author
      Returns:
      the name of the original author of the comment
    • setAuthor

      public void setAuthor(String author)
      Name of the original comment author
      Parameters:
      author - the name of the original author of the comment
    • clone

      public NoteRecord clone()
      Overrides:
      clone in class Record