org.jfree.report.style
Class FontDefinition

java.lang.Object
  org.jfree.report.style.FontDefinition

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class FontDefinition

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

The FontDefinition encapsulates all Font-Style information. The java.awt.Font class does not support extended Styles like Strikethrough or Underline or font metadata like the base encoding.

Author:

Thomas Morgner

See Also:

Serialized Form

Field Summary

static boolean	BOLD a constant to draw a font in bold style.
static boolean	ITALIC a constant to draw a font in italic style.
static boolean	PLAIN a constant to draw a font in plain style.
static boolean	STRIKETHROUGH a constant to draw a font with strikethrough style.
static boolean	UNDERLINE a constant to draw a font with underline style.

Constructor Summary

FontDefinition(java.awt.Font font)
Creates a font definition base on the given AWT font.

FontDefinition(java.lang.String fontName, int fontSize)
Creates a font definition using the given name and size and with no additional style enabled.

FontDefinition(java.lang.String fontName, int fontSize, boolean bold, boolean italic, boolean underline, boolean strikeThrough)
Creates a font definition using the given name and size and with the given styles defined.

FontDefinition(java.lang.String fontName, int fontSize, boolean bold, boolean italic, boolean underline, boolean strikeThrough, java.lang.String encoding, boolean embedded)
Creates a font definition using the given name and size and with the given styles defined.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this one.
java.awt.Font	getFont() returns the AWT-Font defined by this FontDefinition.
java.lang.String	getFontEncoding(java.lang.String defaultEncoding) Returns this fonts string encoding.
java.lang.String	getFontName() Returns the font name of this font definition.
int	getFontSize() Returns the size of the defined font.
int	hashCode() Returns a hash code value for the object.
boolean	isBold() Returns the bold style of this font definition.
boolean	isCourier() Returns true if the logical font name is equivalent to 'Courier', and false otherwise.
boolean	isEmbeddedFont() Returns whether the font should be embedded in the target document.
boolean	isItalic() Returns the italic style of this font definition.
boolean	isSansSerif() Returns true if the logical font name is equivalent to 'SansSerif', and false otherwise.
boolean	isSerif() Returns true if the logical font name is equivalent to 'Serif', and false otherwise.
boolean	isStrikeThrough() Returns the strikethrough style of this font definition.
boolean	isUnderline() Returns the underline style of this font definition.
java.lang.String	toString() Returns a string representation of this font definition.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BOLD

public static final boolean BOLD

a constant to draw a font in bold style.

See Also:

Constant Field Values

ITALIC

public static final boolean ITALIC

a constant to draw a font in italic style.

See Also:

Constant Field Values

UNDERLINE

public static final boolean UNDERLINE

a constant to draw a font with underline style.

See Also:

Constant Field Values

STRIKETHROUGH

public static final boolean STRIKETHROUGH

a constant to draw a font with strikethrough style.

See Also:

Constant Field Values

PLAIN

public static final boolean PLAIN

a constant to draw a font in plain style.

See Also:

Constant Field Values

Constructor Detail

FontDefinition

public FontDefinition(java.lang.String fontName,
                      int fontSize,
                      boolean bold,
                      boolean italic,
                      boolean underline,
                      boolean strikeThrough,
                      java.lang.String encoding,
                      boolean embedded)

Creates a font definition using the given name and size and with the given styles defined.

Parameters:

fontName - the font name used in this font definition.

fontSize - the font size for the defined font.

bold - true, if the font should be bold, false otherwise

italic - true, if the font should be italic, false otherwise

underline - true, if the font should be drawn with underline style, false otherwise

strikeThrough - true, if the font should be drawn with strikethrough style, false otherwise

encoding - the default text encoding that should be used with this font.

embedded - whether this font should be embedded in the target document.

FontDefinition

public FontDefinition(java.lang.String fontName,
                      int fontSize,
                      boolean bold,
                      boolean italic,
                      boolean underline,
                      boolean strikeThrough)

Creates a font definition using the given name and size and with the given styles defined.

Parameters:

fontName - the font name used in this font definition.

fontSize - the font size for the defined font.

bold - true, if the font should be bold, false otherwise

italic - true, if the font should be italic, false otherwise

underline - true, if the font should be drawn with underline style, false otherwise

strikeThrough - true, if the font should be drawn with strikethrough style, false otherwise

FontDefinition

public FontDefinition(java.lang.String fontName,
                      int fontSize)

Creates a font definition using the given name and size and with no additional style enabled.

Parameters:

fontName - the font name used in this font definition.

fontSize - the font size for the defined font.

FontDefinition

public FontDefinition(java.awt.Font font)

Creates a font definition base on the given AWT font.

Parameters:

font - the awt font that should be used as definition source.

Method Detail

getFontName

public java.lang.String getFontName()

Returns the font name of this font definition. The font name is the font face name.

Returns:

the name of the font.

getFontSize

public int getFontSize()

Returns the size of the defined font.

Returns:

the font size in points.

isEmbeddedFont

public boolean isEmbeddedFont()

Returns whether the font should be embedded in the target document.

Returns:

true, if the font should be embedded.

isBold

public boolean isBold()

Returns the bold style of this font definition.

Returns:

true, if the font should be drawn in bold style.

isItalic

public boolean isItalic()

Returns the italic style of this font definition.

Returns:

true, if the font should be drawn in italic style.

isUnderline

public boolean isUnderline()

Returns the underline style of this font definition.

Returns:

true, if the font should be drawn in underline style.

isStrikeThrough

public boolean isStrikeThrough()

Returns the strikethrough style of this font definition.

Returns:

true, if the font should be drawn in strikethrough style.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if a error occured during cloning .

See Also:

Cloneable

getFont

public java.awt.Font getFont()

returns the AWT-Font defined by this FontDefinition.

Returns:

the AWT font.

getFontEncoding

public java.lang.String getFontEncoding(java.lang.String defaultEncoding)

Returns this fonts string encoding. If the font does not define an encoding, the given default encoding is returned.

Parameters:

defaultEncoding - the font encoding to be used if this font definition does not define an own encoding.

Returns:

the font encoding or the default encoding.

toString

public java.lang.String toString()

Returns a string representation of this font definition.

Returns:

a string representation of this font definition.

equals

public boolean equals(java.lang.Object o)

Indicates whether some other object is "equal to" this one.

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

hashCode(), Hashtable

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object)

isSansSerif

public boolean isSansSerif()

Returns true if the logical font name is equivalent to 'SansSerif', and false otherwise.

Returns:

true or false.

isCourier

public boolean isCourier()

Returns true if the logical font name is equivalent to 'Courier', and false otherwise.

Returns:

true or false.

isSerif

public boolean isSerif()

Returns true if the logical font name is equivalent to 'Serif', and false otherwise.

Returns:

true or false.