|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.FontRecord
public final class FontRecord
Title: Font Record (0x0031)
- describes 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 | |
---|---|
static short |
sid
|
static short |
SS_NONE
|
static short |
SS_SUB
|
static short |
SS_SUPER
|
static byte |
U_DOUBLE
|
static byte |
U_DOUBLE_ACCOUNTING
|
static byte |
U_NONE
|
static byte |
U_SINGLE
|
static byte |
U_SINGLE_ACCOUNTING
|
Constructor Summary | |
---|---|
FontRecord()
|
|
FontRecord(RecordInputStream in)
|
Method Summary | |
---|---|
void |
cloneStyleFrom(FontRecord source)
Clones all the font style information from another FontRecord, onto this one. |
short |
getAttributes()
get the font attributes (see individual bit getters that reference this method) |
short |
getBoldWeight()
get the bold weight for this font (100-1000dec or 0x64-0x3e8). |
byte |
getCharset()
get the character set |
short |
getColorPaletteIndex()
get the font's color palette index |
protected int |
getDataSize()
|
byte |
getFamily()
get the font family (TODO) |
short |
getFontHeight()
gets the height of the font in 1/20th point units |
java.lang.String |
getFontName()
get the name of the font |
short |
getSid()
return the non static version of the id for this record. |
short |
getSuperSubScript()
get the type of super or subscript for the font |
byte |
getUnderline()
get the type of underlining for the font |
int |
hashCode()
|
boolean |
isItalic()
get whether the font is to be italics or not |
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) |
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) |
boolean |
isStruckout()
get whether the font is to be stricken out or not |
boolean |
sameProperties(FontRecord other)
Does this FontRecord have all the same font properties as the supplied FontRecord? Note that Object.equals(Object) will check
for exact objects, while this will check
for exact contents, because normally the
font record's position makes a big
difference too. |
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record. |
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 |
setColorPaletteIndex(short cpi)
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 |
setFontName(java.lang.String fn)
set the name of the font |
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 |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
Methods inherited from class org.apache.poi.hssf.record.StandardRecord |
---|
getRecordSize, serialize |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
clone, cloneViaReserialise, serialize |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
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 Detail |
---|
public FontRecord()
public FontRecord(RecordInputStream in)
Method Detail |
---|
public void setFontHeight(short height)
height
- fontheight (in points/20)public void setAttributes(short attributes)
attributes
- the bitmask to setpublic void setItalic(boolean italics)
italics
- - whether the font is italics or notsetAttributes(short)
public void setStrikeout(boolean strike)
strike
- - whether the font is stricken out or notsetAttributes(short)
public void setMacoutline(boolean mac)
mac
- - whether to do that mac font outline thing or notsetAttributes(short)
public void setMacshadow(boolean mac)
mac
- - whether to do that mac font shadow thing or notsetAttributes(short)
public void setColorPaletteIndex(short cpi)
cpi
- - font color indexpublic void setBoldWeight(short bw)
bw
- - a number between 100-1000 for the fonts "boldness"public void setSuperSubScript(short sss)
sss
- super or subscript optionSS_NONE
,
SS_SUPER
,
SS_SUB
public void setUnderline(byte u)
u
- super or subscript optionU_NONE
,
U_SINGLE
,
U_DOUBLE
,
U_SINGLE_ACCOUNTING
,
U_DOUBLE_ACCOUNTING
public void setFamily(byte f)
f
- familypublic void setCharset(byte charset)
charset
- - character setpublic void setFontName(java.lang.String fn)
fn
- - name of the font (i.e. "Arial")public short getFontHeight()
public short getAttributes()
public boolean isItalic()
getAttributes()
public boolean isStruckout()
getAttributes()
public boolean isMacoutlined()
getAttributes()
public boolean isMacshadowed()
getAttributes()
public short getColorPaletteIndex()
public short getBoldWeight()
public short getSuperSubScript()
SS_NONE
,
SS_SUPER
,
SS_SUB
public byte getUnderline()
U_NONE
,
U_SINGLE
,
U_DOUBLE
,
U_SINGLE_ACCOUNTING
,
U_DOUBLE_ACCOUNTING
public byte getFamily()
public byte getCharset()
public java.lang.String getFontName()
public java.lang.String toString()
Record
toString
in class Record
public void serialize(LittleEndianOutput out)
StandardRecord
RecordBase.getRecordSize()
} minus four
( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
by thye superclass).
serialize
in class StandardRecord
protected int getDataSize()
getDataSize
in class StandardRecord
public short getSid()
Record
getSid
in class Record
public void cloneStyleFrom(FontRecord source)
public int hashCode()
hashCode
in class java.lang.Object
public boolean sameProperties(FontRecord other)
Object.equals(Object)
will check
for exact objects, while this will check
for exact contents, because normally the
font record's position makes a big
difference too.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |