Class FontRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.FontRecord

public class FontRecord extends Record
Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)

Description: An element in the Font Table

REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
     
    static final short
     
    static final short
     
    static final short
     
    static final byte
     
    static final byte
     
    static final byte
     
    static final byte
     
    static final byte
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    Constructs a Font record and sets its fields appropriately.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    called by the constructor, should set class level fields.
    short
    get the font attributes (see individual bit getters that reference this method)
    short
    get the bold weight for this font (100-1000dec or 0x64-0x3e8).
    byte
    get the character set
    short
    get the font's color palette index
    byte
    get the font family (TODO)
    short
    gets the height of the font in 1/20th point units
    get the name of the font
    byte
    get the length of the fontname string
    int
    gives the current serialized size of the record.
    short
    return the non static version of the id for this record.
    short
    get the type of super or subscript for the font
    byte
    get the type of underlining for the font
    boolean
    get whether the font is to be italics or not
    boolean
    whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
    boolean
    whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
    boolean
    get whether the font is to be stricken out or not
    int
    serialize(int offset, byte[] data)
    called by the class that is responsible for writing this sucker.
    void
    setAttributes(short attributes)
    set the font attributes (see individual bit setters that reference this method)
    void
    setBoldWeight(short bw)
    set the bold weight for this font (100-1000dec or 0x64-0x3e8).
    void
    setCharset(byte charset)
    set the character set
    void
    set the font's color palette index
    void
    setFamily(byte f)
    set the font family (TODO)
    void
    setFontHeight(short height)
    sets the height of the font in 1/20th point units
    void
    set the name of the font
    void
    set the length of the fontname string
    void
    setItalic(boolean italics)
    set the font to be italics or not
    void
    setMacoutline(boolean mac)
    whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
    void
    setMacshadow(boolean mac)
    whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
    void
    setStrikeout(boolean strike)
    set the font to be stricken out or not
    void
    setSuperSubScript(short sss)
    set the type of super or subscript for the font
    void
    setUnderline(byte u)
    set the type of underlining for the font
    get a string representation of the record (for biffview/debugging)
    protected void
    validateSid(short id)
    called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

    Methods inherited from class loci.poi.hssf.record.Record

    clone, isInValueSection, isValue, serialize

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • FontRecord

      public FontRecord()
    • FontRecord

      public FontRecord(RecordInputStream in)
      Constructs a Font record and sets its fields appropriately.
      Parameters:
      in - the RecordInputstream to read the record from
  • Method Details

    • validateSid

      protected void validateSid(short id)
      Description copied from class: Record
      called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
      Specified by:
      validateSid in class Record
      Parameters:
      id - alleged id for this record
    • fillFields

      protected void fillFields(RecordInputStream in)
      Description copied from class: Record
      called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
      Specified by:
      fillFields in class Record
      Parameters:
      in - the RecordInputstream to read the record from
    • setFontHeight

      public void setFontHeight(short height)
      sets the height of the font in 1/20th point units
      Parameters:
      height - fontheight (in points/20)
    • setAttributes

      public void setAttributes(short attributes)
      set the font attributes (see individual bit setters that reference this method)
      Parameters:
      attributes - the bitmask to set
    • setItalic

      public void setItalic(boolean italics)
      set the font to be italics or not
      Parameters:
      italics - - whether the font is italics or not
      See Also:
    • setStrikeout

      public void setStrikeout(boolean strike)
      set the font to be stricken out or not
      Parameters:
      strike - - whether the font is stricken out or not
      See Also:
    • setMacoutline

      public void setMacoutline(boolean mac)
      whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
      Parameters:
      mac - - whether to do that mac font outline thing or not
      See Also:
    • setMacshadow

      public void setMacshadow(boolean mac)
      whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
      Parameters:
      mac - - whether to do that mac font shadow thing or not
      See Also:
    • setColorPaletteIndex

      public void setColorPaletteIndex(short cpi)
      set the font's color palette index
      Parameters:
      cpi - - font color index
    • setBoldWeight

      public void setBoldWeight(short bw)
      set the bold weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold
      Parameters:
      bw - - a number between 100-1000 for the fonts "boldness"
    • setSuperSubScript

      public void setSuperSubScript(short sss)
      set the type of super or subscript for the font
      Parameters:
      sss - super or subscript option
      See Also:
    • setUnderline

      public void setUnderline(byte u)
      set the type of underlining for the font
      Parameters:
      u - super or subscript option
      See Also:
    • setFamily

      public void setFamily(byte f)
      set the font family (TODO)
      Parameters:
      f - family
    • setCharset

      public void setCharset(byte charset)
      set the character set
      Parameters:
      charset - - characterset
    • setFontNameLength

      public void setFontNameLength(byte len)
      set the length of the fontname string
      Parameters:
      len - length of the font name
      See Also:
    • setFontName

      public void setFontName(String fn)
      set the name of the font
      Parameters:
      fn - - name of the font (i.e. "Arial")
    • getFontHeight

      public short getFontHeight()
      gets the height of the font in 1/20th point units
      Returns:
      fontheight (in points/20)
    • getAttributes

      public short getAttributes()
      get the font attributes (see individual bit getters that reference this method)
      Returns:
      attribute - the bitmask
    • isItalic

      public boolean isItalic()
      get whether the font is to be italics or not
      Returns:
      italics - whether the font is italics or not
      See Also:
    • isStruckout

      public boolean isStruckout()
      get whether the font is to be stricken out or not
      Returns:
      strike - whether the font is stricken out or not
      See Also:
    • isMacoutlined

      public boolean isMacoutlined()
      whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
      Returns:
      mac - whether to do that mac font outline thing or not
      See Also:
    • isMacshadowed

      public boolean isMacshadowed()
      whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
      Returns:
      mac - whether to do that mac font shadow thing or not
      See Also:
    • getColorPaletteIndex

      public short getColorPaletteIndex()
      get the font's color palette index
      Returns:
      cpi - font color index
    • getBoldWeight

      public short getBoldWeight()
      get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold
      Returns:
      bw - a number between 100-1000 for the fonts "boldness"
    • getSuperSubScript

      public short getSuperSubScript()
      get the type of super or subscript for the font
      Returns:
      super or subscript option
      See Also:
    • getUnderline

      public byte getUnderline()
      get the type of underlining for the font
      Returns:
      super or subscript option
      See Also:
    • getFamily

      public byte getFamily()
      get the font family (TODO)
      Returns:
      family
    • getCharset

      public byte getCharset()
      get the character set
      Returns:
      charset - characterset
    • getFontNameLength

      public byte getFontNameLength()
      get the length of the fontname string
      Returns:
      length of the font name
      See Also:
    • getFontName

      public String getFontName()
      get the name of the font
      Returns:
      fn - name of the font (i.e. "Arial")
    • toString

      public String toString()
      Description copied from class: Record
      get a string representation of the record (for biffview/debugging)
      Overrides:
      toString in class Record
    • serialize

      public int serialize(int offset, byte[] data)
      Description copied from class: Record
      called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
      Specified by:
      serialize in class Record
      Parameters:
      offset - to begin writing at
      data - byte array containing instance data
      Returns:
      number of bytes written
    • getRecordSize

      public int getRecordSize()
      Description copied from class: Record
      gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
      Overrides:
      getRecordSize in class Record
    • 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