Package org.apache.poi.ss.usermodel
Interface Font
-
- All Known Implementing Classes:
HSSFFont
public interface Font
-
-
Field Summary
Fields Modifier and Type Field Description static byte
ANSI_CHARSET
ANSI character setstatic short
COLOR_NORMAL
normal type of black color.static short
COLOR_RED
Dark Red colorstatic byte
DEFAULT_CHARSET
Default character set.static short
SS_NONE
no type offsetting (not super or subscript)static short
SS_SUB
subscriptstatic short
SS_SUPER
superscriptstatic byte
SYMBOL_CHARSET
Symbol character setstatic int
TWIPS_PER_POINT
Font height is handled in points and 1/20th of points so this is the constant used to convert between those two units.static byte
U_DOUBLE
double underlinedstatic byte
U_DOUBLE_ACCOUNTING
accounting style double underlinestatic byte
U_NONE
not underlinedstatic byte
U_SINGLE
single (normal) underlinestatic byte
U_SINGLE_ACCOUNTING
accounting style single underline
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
getBold()
int
getCharSet()
get character-set to use.short
getColor()
get the color for the fontshort
getFontHeight()
Get the font height in unit's of 1/20th of a point.short
getFontHeightInPoints()
Get the font height in points.String
getFontName()
get the name for the font (i.e.int
getIndex()
get the index within the XSSFWorkbook (sequence within the collection of Font objects)int
getIndexAsInt()
Deprecated.usegetIndex()
insteadboolean
getItalic()
get whether to use italics or notboolean
getStrikeout()
get whether to use a strikeout horizontal line through the text or notshort
getTypeOffset()
get normal,super or subscript.byte
getUnderline()
get type of text underlining to usevoid
setBold(boolean bold)
void
setCharSet(byte charset)
set character-set to use.void
setCharSet(int charset)
set character-set to use.void
setColor(short color)
set the color for the fontvoid
setFontHeight(short height)
set the font height in unit's of 1/20th of a point.void
setFontHeightInPoints(short height)
set the font heightvoid
setFontName(String name)
set the name for the font (i.e.void
setItalic(boolean italic)
set whether to use italics or notvoid
setStrikeout(boolean strikeout)
set whether to use a strikeout horizontal line through the text or notvoid
setTypeOffset(short offset)
set normal,super or subscript.void
setUnderline(byte underline)
set type of text underlining to use
-
-
-
Field Detail
-
COLOR_NORMAL
static final short COLOR_NORMAL
normal type of black color.- See Also:
- Constant Field Values
-
COLOR_RED
static final short COLOR_RED
Dark Red color- See Also:
- Constant Field Values
-
SS_NONE
static final short SS_NONE
no type offsetting (not super or subscript)- See Also:
- Constant Field Values
-
SS_SUPER
static final short SS_SUPER
superscript- See Also:
- Constant Field Values
-
SS_SUB
static final short SS_SUB
subscript- See Also:
- Constant Field Values
-
U_NONE
static final byte U_NONE
not underlined- See Also:
- Constant Field Values
-
U_SINGLE
static final byte U_SINGLE
single (normal) underline- See Also:
- Constant Field Values
-
U_DOUBLE
static final byte U_DOUBLE
double underlined- See Also:
- Constant Field Values
-
U_SINGLE_ACCOUNTING
static final byte U_SINGLE_ACCOUNTING
accounting style single underline- See Also:
- Constant Field Values
-
U_DOUBLE_ACCOUNTING
static final byte U_DOUBLE_ACCOUNTING
accounting style double underline- See Also:
- Constant Field Values
-
ANSI_CHARSET
static final byte ANSI_CHARSET
ANSI character set- See Also:
- Constant Field Values
-
DEFAULT_CHARSET
static final byte DEFAULT_CHARSET
Default character set.- See Also:
- Constant Field Values
-
SYMBOL_CHARSET
static final byte SYMBOL_CHARSET
Symbol character set- See Also:
- Constant Field Values
-
TWIPS_PER_POINT
static final int TWIPS_PER_POINT
Font height is handled in points and 1/20th of points so this is the constant used to convert between those two units.- See Also:
- Constant Field Values
-
-
Method Detail
-
setFontName
void setFontName(String name)
set the name for the font (i.e. Arial)- Parameters:
name
- String representing the name of the font to use
-
getFontName
String getFontName()
get the name for the font (i.e. Arial)- Returns:
- String representing the name of the font to use
-
setFontHeight
void setFontHeight(short height)
set the font height in unit's of 1/20th of a point. Maybe you might want to use the setFontHeightInPoints which matches to the familiar 10, 12, 14 etc..- Parameters:
height
- height in 1/20ths of a point- See Also:
setFontHeightInPoints(short)
-
setFontHeightInPoints
void setFontHeightInPoints(short height)
set the font height- Parameters:
height
- height in the familiar unit of measure - points- See Also:
setFontHeight(short)
-
getFontHeight
short getFontHeight()
Get the font height in unit's of 1/20th of a point.For many users, the related
getFontHeightInPoints()
will be more helpful, as that returns font heights in the more familiar points units, eg 10, 12, 14.- Returns:
- short - height in 1/20ths of a point
- See Also:
getFontHeightInPoints()
-
getFontHeightInPoints
short getFontHeightInPoints()
Get the font height in points.This will return the same font height that is shown in Excel, such as 10 or 14 or 28.
- Returns:
- short - height in the familiar unit of measure - points
- See Also:
getFontHeight()
-
setItalic
void setItalic(boolean italic)
set whether to use italics or not- Parameters:
italic
- italics or not
-
getItalic
boolean getItalic()
get whether to use italics or not- Returns:
- italics or not
-
setStrikeout
void setStrikeout(boolean strikeout)
set whether to use a strikeout horizontal line through the text or not- Parameters:
strikeout
- or not
-
getStrikeout
boolean getStrikeout()
get whether to use a strikeout horizontal line through the text or not- Returns:
- strikeout or not
-
setColor
void setColor(short color)
set the color for the font- Parameters:
color
- to use- See Also:
Note: Use this rather than HSSFColor.AUTOMATIC for default font color
,COLOR_RED
-
getColor
short getColor()
get the color for the font- Returns:
- color to use
- See Also:
COLOR_NORMAL
,COLOR_RED
,HSSFPalette.getColor(short)
-
setTypeOffset
void setTypeOffset(short offset)
set normal,super or subscript.
-
getTypeOffset
short getTypeOffset()
get normal,super or subscript.
-
setUnderline
void setUnderline(byte underline)
set type of text underlining to use- Parameters:
underline
- type- See Also:
U_NONE
,U_SINGLE
,U_DOUBLE
,U_SINGLE_ACCOUNTING
,U_DOUBLE_ACCOUNTING
-
getUnderline
byte getUnderline()
get type of text underlining to use- Returns:
- underlining type
- See Also:
U_NONE
,U_SINGLE
,U_DOUBLE
,U_SINGLE_ACCOUNTING
,U_DOUBLE_ACCOUNTING
-
getCharSet
int getCharSet()
get character-set to use.- Returns:
- character-set
- See Also:
ANSI_CHARSET
,DEFAULT_CHARSET
,SYMBOL_CHARSET
-
setCharSet
void setCharSet(byte charset)
set character-set to use.- See Also:
ANSI_CHARSET
,DEFAULT_CHARSET
,SYMBOL_CHARSET
-
setCharSet
void setCharSet(int charset)
set character-set to use.- See Also:
ANSI_CHARSET
,DEFAULT_CHARSET
,SYMBOL_CHARSET
-
getIndex
int getIndex()
get the index within the XSSFWorkbook (sequence within the collection of Font objects)- Returns:
- unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)
- Since:
- 5.0.0 (used to return a short)
-
getIndexAsInt
@Deprecated @Removal(version="6.0.0") int getIndexAsInt()
Deprecated.usegetIndex()
insteadget the index within the XSSFWorkbook (sequence within the collection of Font objects)- Returns:
- unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)
- Since:
- 4.0.0
-
setBold
void setBold(boolean bold)
-
getBold
boolean getBold()
-
-