Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » record » [javadoc | source]
org.apache.poi.hssf.record
public class: FontRecord [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.FontRecord
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)

Field Summary
public static final  short sid     
public static final  short SS_NONE     
public static final  short SS_SUPER     
public static final  short SS_SUB     
public static final  byte U_NONE     
public static final  byte U_SINGLE     
public static final  byte U_DOUBLE     
public static final  byte U_SINGLE_ACCOUNTING     
public static final  byte U_DOUBLE_ACCOUNTING     
Constructor:
 public FontRecord() 
 public FontRecord(RecordInputStream in) 
    Constructs a Font record and sets its fields appropriately.
    Parameters:
    in - the RecordInputstream to read the record from
Method from org.apache.poi.hssf.record.FontRecord Summary:
equals,   fillFields,   getAttributes,   getBoldWeight,   getCharset,   getColorPaletteIndex,   getFamily,   getFontHeight,   getFontName,   getFontNameLength,   getRecordSize,   getSid,   getSuperSubScript,   getUnderline,   hashCode,   isItalic,   isMacoutlined,   isMacshadowed,   isStruckout,   serialize,   setAttributes,   setBoldWeight,   setCharset,   setColorPaletteIndex,   setFamily,   setFontHeight,   setFontName,   setFontNameLength,   setItalic,   setMacoutline,   setMacshadow,   setStrikeout,   setSuperSubScript,   setUnderline,   toString,   validateSid
Methods from org.apache.poi.hssf.record.Record:
clone,   cloneViaReserialise,   fillFields,   getRecordSize,   getSid,   isInValueSection,   isValue,   serialize,   serialize,   toString,   validateSid
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.record.FontRecord Detail:
 public boolean equals(Object obj) 
    Only returns two for the same exact object - creating a second FontRecord with the same properties won't be considered equal, as the record's position in the record stream matters.
 protected  void fillFields(RecordInputStream in) 
 public short getAttributes() 
    get the font attributes (see individual bit getters that reference this method)
 public short getBoldWeight() 
    get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold
 public byte getCharset() 
    get the character set
 public short getColorPaletteIndex() 
    get the font's color palette index
 public byte getFamily() 
    get the font family (TODO)
 public short getFontHeight() 
    gets the height of the font in 1/20th point units
 public String getFontName() 
    get the name of the font
 public byte getFontNameLength() 
    get the length of the fontname string
 public int getRecordSize() 
 public short getSid() 
 public short getSuperSubScript() 
    get the type of super or subscript for the font
 public byte getUnderline() 
    get the type of underlining for the font
 public int hashCode() 
 public boolean isItalic() 
    get whether the font is to be italics or not
 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)
 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)
 public boolean isStruckout() 
    get whether the font is to be stricken out or not
 public int serialize(int offset,
    byte[] data) 
 public  void setAttributes(short attributes) 
    set the font attributes (see individual bit setters that reference this method)
 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
 public  void setCharset(byte charset) 
    set the character set
 public  void setColorPaletteIndex(short cpi) 
    set the font's color palette index
 public  void setFamily(byte f) 
    set the font family (TODO)
 public  void setFontHeight(short height) 
    sets the height of the font in 1/20th point units
 public  void setFontName(String fn) 
    set the name of the font
 public  void setFontNameLength(byte len) 
    set the length of the fontname string
 public  void setItalic(boolean italics) 
    set the font to be italics or not
 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)
 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)
 public  void setStrikeout(boolean strike) 
    set the font to be stricken out or not
 public  void setSuperSubScript(short sss) 
    set the type of super or subscript for the font
 public  void setUnderline(byte u) 
    set the type of underlining for the font
 public String toString() 
 protected  void validateSid(short id)