org.docgene.api

Class SentenceStyle

java.lang.Object

org.docgene.api.SentenceStyle

public class SentenceStyle
extends java.lang.Object

Represents a sentence style.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	background The sentence background color.
java.lang.String	color The sentence text color.
java.lang.String	fontFace The sentence font face.
java.lang.String	namedSize The sentence named size.
int	size The sentence numeric size value.
int	type The font type. it is a OR of the enumeration values in the FontType interface.

Constructor Summary

Constructors

Constructor and Description
SentenceStyle()

Method Summary

Modifier and Type	Method and Description
static SentenceStyle	createColorStyle(java.lang.String color) Creates a sentence with a font of a specified color.
static SentenceStyle	createColorStyle(java.lang.String color, java.lang.String background) Creates a sentence with a font of a specified color and background color.
static SentenceStyle	createFontFamilyStyle(java.lang.String fontFace) Creates a sentence with a font of a specified family.
static SentenceStyle	createSizeStyle(int size) Creates a sentence with a font of a specified size.
static SentenceStyle	createSizeStyle(java.lang.String namedSize) Creates a sentence with a font of a specified named size.
static SentenceStyle	createStyle(int type, int size, java.lang.String color, java.lang.String background, java.lang.String fontFace) Creates a sentence with a font of a specified color.
static SentenceStyle	createStyle(int type, java.lang.String namedSize, java.lang.String color, java.lang.String background, java.lang.String fontFace) Creates a sentence with a font of a specified color, background color, size, font face.
static SentenceStyle	createTypeStyle(int type) Creates a sentence with a font of a specified type.
boolean	isDefaultStyle() Return true if the style is the default style.
SentenceStyle	setBackground(java.lang.String background) Set the background color of the font.
SentenceStyle	setColor(java.lang.String color) Set the color of the font.
SentenceStyle	setFontFamily(java.lang.String fontFace) Set the family of the font.
SentenceStyle	setSize(int size) Set the specified size of the font.
SentenceStyle	setSize(java.lang.String namedSize) Set the specified named size of the font.
SentenceStyle	setType(int type) Set the specified type of the font.

Methods inherited from class java.lang.Object

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

Field Detail

color

public java.lang.String color

The sentence text color.

fontFace

public java.lang.String fontFace

The sentence font face.

See Also:

FontFace

background

public java.lang.String background

The sentence background color.

size

public int size

The sentence numeric size value.

namedSize

public java.lang.String namedSize

The sentence named size.

See Also:

FontSize

type

public int type

The font type. it is a OR of the enumeration values in the FontType interface.

See Also:

FontType

Constructor Detail

SentenceStyle

public SentenceStyle()

Method Detail

isDefaultStyle

public boolean isDefaultStyle()

Return true if the style is the default style.

Returns:

true if the style is the default style

setType

public SentenceStyle setType(int type)

Set the specified type of the font.

Parameters:

type - the font type

Returns:

this style

See Also:

FontType

createTypeStyle

public static SentenceStyle createTypeStyle(int type)

Creates a sentence with a font of a specified type.

Parameters:

type - the font type

Returns:

the style

See Also:

FontType

createSizeStyle

public static SentenceStyle createSizeStyle(int size)

Creates a sentence with a font of a specified size.

Parameters:

size - the font size

Returns:

the style

setSize

public SentenceStyle setSize(int size)

Set the specified size of the font.

Parameters:

size - the font size

Returns:

this style

createSizeStyle

public static SentenceStyle createSizeStyle(java.lang.String namedSize)

Creates a sentence with a font of a specified named size.

Parameters:

namedSize - the font size

Returns:

the style

setSize

public SentenceStyle setSize(java.lang.String namedSize)

Set the specified named size of the font.

Parameters:

namedSize - the font size

Returns:

this style

createColorStyle

public static SentenceStyle createColorStyle(java.lang.String color)

Creates a sentence with a font of a specified color.

Parameters:

color - the font color

Returns:

the style

setColor

public SentenceStyle setColor(java.lang.String color)

Set the color of the font.

Parameters:

color - the font color

Returns:

this style

setBackground

public SentenceStyle setBackground(java.lang.String background)

Set the background color of the font.

Parameters:

background - the font background color

Returns:

this style

createColorStyle

public static SentenceStyle createColorStyle(java.lang.String color,
                                             java.lang.String background)

Creates a sentence with a font of a specified color and background color.

Parameters:

color - the font color

background - the font background color

Returns:

the style

createFontFamilyStyle

public static SentenceStyle createFontFamilyStyle(java.lang.String fontFace)

Creates a sentence with a font of a specified family.

Parameters:

fontFace - the font face

Returns:

the style

See Also:

FontFace

setFontFamily

public SentenceStyle setFontFamily(java.lang.String fontFace)

Set the family of the font.

Parameters:

fontFace - the font family

Returns:

this style

createStyle

public static SentenceStyle createStyle(int type,
                                        int size,
                                        java.lang.String color,
                                        java.lang.String background,
                                        java.lang.String fontFace)

Creates a sentence with a font of a specified color.

Parameters:

type - the font type

size - tyhe font size

color - the font color

background - the font background color

fontFace - the font face

Returns:

the style

createStyle

public static SentenceStyle createStyle(int type,
                                        java.lang.String namedSize,
                                        java.lang.String color,
                                        java.lang.String background,
                                        java.lang.String fontFace)

Creates a sentence with a font of a specified color, background color, size, font face.

Parameters:

type - the font type

namedSize - the font size

color - the font color

background - the font background color

fontFace - the font face

Returns:

the style