se.entra.phantom.common

Class CFont

java.lang.Object

se.entra.phantom.common.CFont

public class CFont
extends Object

Class holding the font definition of an item or component. This font can be an indexed font or a Java-style Font.

Author:

Christopher Mindus

Constructor Summary

Constructors

Constructor and Description
CFont() Creates an default font.
CFont(Font... fonts) Creates a font initialized with a Java-style Font's.
CFont(Font font) Creates a font initialized with a Java-style Font.
CFont(int index) Creates a font initialized with an index.
CFont(List<Font> fonts) Creates a font initialized with a Java-style Font's.

Method Summary

Modifier and Type	Method and Description
Font	getFont() Gets the Java-style Font.
Font[]	getFonts() Gets all available fonts if this has been specified as a list or an array.
int	getIndex() Gets the index of a font.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CFont

public CFont()

Creates an default font.

CFont

public CFont(int index)

Creates a font initialized with an index.

Parameters:

index - the font index combined with possible BOLD and ITALIC attributes.

Throws:

IllegalArgumentException - for invalid index.

CFont

public CFont(Font font)

Creates a font initialized with a Java-style Font.

Parameters:

font - the font to use.

Throws:

IllegalArgumentException - for invalid font.

CFont

public CFont(Font... fonts)

Creates a font initialized with a Java-style Font's. The first font available on the client will be used, the rest will be ignored.

Parameters:

fonts - the font(s) to use.

Throws:

IllegalArgumentException - for invalid font.

CFont

public CFont(List<Font> fonts)

Creates a font initialized with a Java-style Font's. The first font available on the client will be used, the rest will be ignored.

Parameters:

fonts - the list of font(s) to use.

Throws:

IllegalArgumentException - for invalid font.

Method Detail

getIndex

public int getIndex()

Gets the index of a font.

Returns:

the index of the font combined with possible BOLD and ITALIC attributes, or -1 if the index is not used, but rather the Java-style Font that is retrieved using getFont().

getFont

public Font getFont()

Gets the Java-style Font.

Returns:

A font, or null if an index or default font is used.

getFonts

public Font[] getFonts()

Gets all available fonts if this has been specified as a list or an array. If a font index is used, the font array returned will be zero in length.

Returns:

An array of fonts, zero in length if no font nor font list has been specified.