com.lowagie.text

Class Font

Implemented Interfaces:
Comparable
Known Direct Subclasses:
RtfFont, RtfFont

public class Font
extends java.lang.Object
implements Comparable

Contains all the specifications of a font: fontfamily, size, style and color.

Example:

 
 Paragraph p = new Paragraph("This is a paragraph", new
 Font(Font.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)) );
 
 

Field Summary

static int
BOLD
this is a possible style.
static int
BOLDITALIC
this is a possible style.
static int
COURIER
a possible value of a font family.
static int
DEFAULTSIZE
the value of the default size.
static int
HELVETICA
a possible value of a font family.
static int
ITALIC
this is a possible style.
static int
NORMAL
this is a possible style.
static int
STRIKETHRU
this is a possible style.
static int
SYMBOL
a possible value of a font family.
static int
TIMES_ROMAN
a possible value of a font family.
static int
UNDEFINED
the value of an undefined attribute.
static int
UNDERLINE
this is a possible style.
static int
ZAPFDINGBATS
a possible value of a font family.
private BaseFont
baseFont
the external font
private Color
color
the value of the color.
private int
family
the value of the fontfamily.
private float
size
the value of the fontsize.
private int
style
the value of the style.

Constructor Summary

Font()
Constructs a Font.
Font(Font other)
Copy constructor of a Font
Font(BaseFont bf)
Constructs a Font.
Font(BaseFont bf, float size)
Constructs a Font.
Font(BaseFont bf, float size, int style)
Constructs a Font.
Font(BaseFont bf, float size, int style, Color color)
Constructs a Font.
Font(int family)
Constructs a Font.
Font(int family, float size)
Constructs a Font.
Font(int family, float size, int style)
Constructs a Font.
Font(int family, float size, int style, Color color)
Constructs a Font.

Method Summary

Color
color()
Gets the color of this font.
int
compareTo(Object object)
Compares this Font with another
Font
difference(Font font)
Replaces the attributes that are equal to null with the attributes of a given font.
int
family()
Gets the family of this font.
BaseFont
getBaseFont()
Gets the BaseFont inside this object.
BaseFont
getCalculatedBaseFont(boolean specialEncoding)
Gets the BaseFont this class represents.
float
getCalculatedSize()
Gets the size that can be used with the calculated BaseFont .
int
getCalculatedStyle()
Gets the style that can be used with the calculated BaseFont .
static int
getFamilyIndex(String family)
Translates a String -value of a certain family into the index that is used for this family in this class.
String
getFamilyname()
Gets the familyname as a String.
static int
getStyleValue(String style)
Translates a String -value of a certain style into the index value is used for this style in this class.
boolean
isBold()
checks if this font is Bold.
boolean
isItalic()
checks if this font is Bold.
boolean
isStandardFont()
Checks if the properties of this font are undefined or null.
boolean
isStrikethru()
checks if the style of this font is STRIKETHRU.
boolean
isUnderlined()
checks if this font is underlined.
float
leading(float linespacing)
Gets the leading that can be used with this font.
void
setColor(Color color)
Sets the color.
void
setColor(int red, int green, int blue)
Sets the color.
void
setFamily(String family)
Sets the family using a String ("Courier", "Helvetica", "Times New Roman", "Symbol" or "ZapfDingbats").
void
setSize(float size)
Sets the size.
void
setStyle(String style)
Sets the style using a String containing one of more of the following values: normal, bold, italic, underline, strike.
void
setStyle(int style)
Sets the style.
float
size()
Gets the size of this font.
int
style()
Gets the style of this font.

Field Details

BOLD

public static final int BOLD
this is a possible style.
Field Value:
1

BOLDITALIC

public static final int BOLDITALIC
this is a possible style.
Field Value:
3

COURIER

public static final int COURIER
a possible value of a font family.
Field Value:
0

DEFAULTSIZE

public static final int DEFAULTSIZE
the value of the default size.
Field Value:
12

HELVETICA

public static final int HELVETICA
a possible value of a font family.
Field Value:
1

ITALIC

public static final int ITALIC
this is a possible style.
Field Value:
2

NORMAL

public static final int NORMAL
this is a possible style.
Field Value:
0

STRIKETHRU

public static final int STRIKETHRU
this is a possible style.
Field Value:
8

SYMBOL

public static final int SYMBOL
a possible value of a font family.
Field Value:
3

TIMES_ROMAN

public static final int TIMES_ROMAN
a possible value of a font family.
Field Value:
2

UNDEFINED

public static final int UNDEFINED
the value of an undefined attribute.
Field Value:
-1

UNDERLINE

public static final int UNDERLINE
this is a possible style.
Field Value:
4

ZAPFDINGBATS

public static final int ZAPFDINGBATS
a possible value of a font family.
Field Value:
4

baseFont

private BaseFont baseFont
the external font

color

private Color color
the value of the color.

family

private int family
the value of the fontfamily.

size

private float size
the value of the fontsize.

style

private int style
the value of the style.

Constructor Details

Font

public Font()
Constructs a Font.

Font

public Font(Font other)
Copy constructor of a Font
Parameters:
other - the font that has to be copied

Font

public Font(BaseFont bf)
Constructs a Font.
Parameters:
bf - the external font

Font

public Font(BaseFont bf,
            float size)
Constructs a Font.
Parameters:
bf - the external font
size - the size of this font

Font

public Font(BaseFont bf,
            float size,
            int style)
Constructs a Font.
Parameters:
bf - the external font
size - the size of this font
style - the style of this font

Font

public Font(BaseFont bf,
            float size,
            int style,
            Color color)
Constructs a Font.
Parameters:
bf - the external font
size - the size of this font
style - the style of this font
color - the Color of this font.

Font

public Font(int family)
Constructs a Font.
Parameters:
family - the family to which this font belongs

Font

public Font(int family,
            float size)
Constructs a Font.
Parameters:
family - the family to which this font belongs
size - the size of this font

Font

public Font(int family,
            float size,
            int style)
Constructs a Font.
Parameters:
family - the family to which this font belongs
size - the size of this font
style - the style of this font

Font

public Font(int family,
            float size,
            int style,
            Color color)
Constructs a Font.
Parameters:
family - the family to which this font belongs
size - the size of this font
style - the style of this font
color - the Color of this font.

Method Details

color

public Color color()
Gets the color of this font.
Returns:
a color

compareTo

public int compareTo(Object object)
Compares this Font with another
Parameters:
object - the other Font
Returns:
a value

difference

public Font difference(Font font)
Replaces the attributes that are equal to null with the attributes of a given font.
Parameters:
font - the font of a bigger element class
Returns:
a Font

family

public int family()
Gets the family of this font.
Returns:
the value of the family

getBaseFont

public BaseFont getBaseFont()
Gets the BaseFont inside this object.
Returns:
the BaseFont

getCalculatedBaseFont

public BaseFont getCalculatedBaseFont(boolean specialEncoding)
Gets the BaseFont this class represents. For the built-in fonts a BaseFont is calculated.
Parameters:
specialEncoding - true to use the special encoding for Symbol and ZapfDingbats, false to always use Cp1252
Returns:
the BaseFont this class represents

getCalculatedSize

public float getCalculatedSize()
Gets the size that can be used with the calculated BaseFont .
Returns:
the size that can be used with the calculated BaseFont

getCalculatedStyle

public int getCalculatedStyle()
Gets the style that can be used with the calculated BaseFont .
Returns:
the style that can be used with the calculated BaseFont

getFamilyIndex

public static int getFamilyIndex(String family)
Translates a String -value of a certain family into the index that is used for this family in this class.
Parameters:
family - A String representing a certain font-family
Returns:
the corresponding index

getFamilyname

public String getFamilyname()
Gets the familyname as a String.
Returns:
the familyname

getStyleValue

public static int getStyleValue(String style)
Translates a String -value of a certain style into the index value is used for this style in this class.
Parameters:
style - A String
Returns:
the corresponding value

isBold

public boolean isBold()
checks if this font is Bold.
Returns:
a boolean

isItalic

public boolean isItalic()
checks if this font is Bold.
Returns:
a boolean

isStandardFont

public boolean isStandardFont()
Checks if the properties of this font are undefined or null.

If so, the standard should be used.

Returns:
a boolean

isStrikethru

public boolean isStrikethru()
checks if the style of this font is STRIKETHRU.
Returns:
a boolean

isUnderlined

public boolean isUnderlined()
checks if this font is underlined.
Returns:
a boolean

leading

public float leading(float linespacing)
Gets the leading that can be used with this font.
Parameters:
linespacing - a certain linespacing
Returns:
the height of a line

setColor

public void setColor(Color color)
Sets the color.
Parameters:
color - the new color of the font

setColor

public void setColor(int red,
                     int green,
                     int blue)
Sets the color.
Parameters:
red - the red-value of the new color
green - the green-value of the new color
blue - the blue-value of the new color

setFamily

public void setFamily(String family)
Sets the family using a String ("Courier", "Helvetica", "Times New Roman", "Symbol" or "ZapfDingbats").
Parameters:
family - A String representing a certain font-family.

setSize

public void setSize(float size)
Sets the size.
Parameters:
size - The new size of the font.

setStyle

public void setStyle(String style)
Sets the style using a String containing one of more of the following values: normal, bold, italic, underline, strike.
Parameters:
style - A String representing a certain style.

setStyle

public void setStyle(int style)
Sets the style.
Parameters:
style - the style.

size

public float size()
Gets the size of this font.
Returns:
a size

style

public int style()
Gets the style of this font.
Returns:
a size