com.goldencode.p2j.ui

Enum FontStyle

java.lang.Object

java.lang.Enum<FontStyle>

com.goldencode.p2j.ui.FontStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FontStyle>

public enum FontStyle
extends java.lang.Enum<FontStyle>

Style constants representing the possible styles that can be applied to a font.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOLD
BOLD_ITALIC
ITALIC
PLAIN
UNDERLINE
UNDERLINE_BOLD
UNDERLINE_BOLD_ITALIC
UNDERLINE_ITALIC

Method Summary

Modifier and Type	Method and Description
static FontStyle	createStyle(boolean isBold, boolean isItalic, boolean isUnderline) Create a new font with the given style(s).
boolean	isBold() Check if this is a bold font.
boolean	isItalic() Check if this is an italic font.
boolean	isUnderline() Check if this is an underlined font.
int	toInt() Create an int representation of this style, to be used for serialization.
static FontStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FontStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAIN

public static final FontStyle PLAIN

BOLD

public static final FontStyle BOLD

ITALIC

public static final FontStyle ITALIC

BOLD_ITALIC

public static final FontStyle BOLD_ITALIC

UNDERLINE

public static final FontStyle UNDERLINE

UNDERLINE_BOLD

public static final FontStyle UNDERLINE_BOLD

UNDERLINE_ITALIC

public static final FontStyle UNDERLINE_ITALIC

UNDERLINE_BOLD_ITALIC

public static final FontStyle UNDERLINE_BOLD_ITALIC

Method Detail

values

public static FontStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FontStyle c : FontStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FontStyle valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isBold

public boolean isBold()

Check if this is a bold font.

Returns:

See above.

isItalic

public boolean isItalic()

Check if this is an italic font.

Returns:

See above.

isUnderline

public boolean isUnderline()

Check if this is an underlined font.

Returns:

See above.

createStyle

public static FontStyle createStyle(boolean isBold,
                                    boolean isItalic,
                                    boolean isUnderline)

Create a new font with the given style(s).

Parameters:

isBold - Flag indicating a bold font.

isItalic - Flag indicating an italic font.

isUnderline - Flag indicating an underline font.

Returns:

A new FontStyle.

toInt

public int toInt()

Create an int representation of this style, to be used for serialization. Each bit is set as: bit 0 for bold, bit 1 for italic, bit 2 for underline.

Returns:

Int representation of this style.