Package org.apache.poi.hssf.record

Class NoteRecord

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.NoteRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class NoteRecord extends StandardRecord
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(NoteRecord other)

    • 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)

    • 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:

    • 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

    • copy

      public NoteRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()