org.eclipse.tptp.platform.report.core.internal
Class DStyle

java.lang.Object
  org.eclipse.tptp.platform.report.core.internal.DStyle

All Implemented Interfaces:

IDObject, IDStyle

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DStyle
extends java.lang.Object
implements IDStyle

DStyle describes the way how a paragraph is presented in a document: it is composed of a name, a font, a foreground color, a background color and a format like BULLETS, NUMBERS, ROMAN LETTERS, LETTERS, ARROWS, FINGERS or NOTHING.

See Also:

DStyleRegistry

Field Summary

static int	GLYPH Deprecated. Style property: GLYPH displays an arrow in front of each title and list item.
static int	LETTER Deprecated. Style property: LETTER displays incremented letter in front of each title and list item.
static int	NOTHING Deprecated. Style property: NOTHING displays nothing in front of a paragraph title and list item.
static int	NUMBER Deprecated. Style property: NUMBER displays incremented number in front of each title and list item.
static int	ROMAN_NUMBER Deprecated. Style property: ROMAN_NUMBER displays an incremented roman number in front of each title and list item.
static java.lang.String	T_GLYPH Deprecated.
static java.lang.String	T_LETTER Deprecated.
static java.lang.String	T_NOTHING Deprecated.
static java.lang.String	T_ROMAN_NUMBER Deprecated.

Constructor Summary

DStyle()
Deprecated. Creates a DStyle.

DStyle(java.lang.String n)
Deprecated. Creates a DStyle,Setting only a name with a null font, a null background and foreground color, a null wallpaper and a numberingFormat equal to 0

DStyle(java.lang.String n, IDFont f, IDColor fore, IDColor back)
Deprecated. Creates a DStyle named 'n' with font 'f', foreground color 'fore' and background color 'back'.

DStyle(java.lang.String n, IDStyle s)
Deprecated. Creates a DStyle named 'n' and gets the information background color, foreground color and title format from the style 's'.

Method Summary

boolean	equals(java.lang.Object o) Deprecated. Compares two styles.
IDColor	getBackColor() Deprecated. Gets the background color of the style.
IDFont	getFont() Deprecated. Gets the font of the style.
IDColor	getForeColor() Deprecated. Gets the foreground color of the style.
java.lang.String	getID() Deprecated.
java.lang.String	getName() Deprecated. Access method for the name property.
int	getNumberingFormat() Deprecated. Access method for the numberingFormat property.
IDWallpaper	getWallpaper() Deprecated. Returns the wall paper of the style.
boolean	isValidNumberingFormat(int f) Deprecated. Retruns true if the integer 'f' passed in parameter is a valid format.
java.lang.String	numberingFormatToString(int i) Deprecated. Returns the string numbering format name for this integer value.
void	setBackColor(IDColor c) Deprecated. Sets the background color of the style.
void	setFont(IDFont f) Deprecated. Sets the font of the style.
void	setForeColor(IDColor c) Deprecated. Sets the foreground color of the style.
void	setName(java.lang.String aName) Deprecated. Sets the value of the name property.
void	setNumberingFormat(int aNumberingFormat) Deprecated. Sets the value of the numberingFormat property.
void	setWallpaper(IDWallpaper wallpaper) Deprecated. Changes (replaces) current wallpaper.
int	stringToNumberingFormat(java.lang.String s) Deprecated. Returns the integer numbering format value for this string name.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER

public static final int NUMBER

Deprecated.

Style property: NUMBER displays incremented number in front of each title and list item.
1 Introduction
2 Chapter One
3 Chapter Two
3.1 Paragraph One
3.2 Paragraph Two
4 Chapter Three
....

See Also:

Constant Field Values

ROMAN_NUMBER

public static final int ROMAN_NUMBER

Deprecated.

Style property: ROMAN_NUMBER displays an incremented roman number in front of each title and list item.
I Introduction
II Chapter One
III Chapter Two
III-I Paragraph One
III-II Paragraph Two
IV Chapter Three
....

See Also:

Constant Field Values

T_ROMAN_NUMBER

public static final java.lang.String T_ROMAN_NUMBER

Deprecated.

See Also:

Constant Field Values

LETTER

public static final int LETTER

Deprecated.

Style property: LETTER displays incremented letter in front of each title and list item.
A Introduction
B Chapter One
C Chapter Two
C.a Paragraph One
C.b Paragraph Two
D Chapter Three
....

See Also:

Constant Field Values

T_LETTER

public static final java.lang.String T_LETTER

Deprecated.

See Also:

Constant Field Values

NOTHING

public static final int NOTHING

Deprecated.

Style property: NOTHING displays nothing in front of a paragraph title and list item.
Introduction
Chapter One
Chapter Two
Paragraph One
Paragraph Two
Chapter Three
....

See Also:

Constant Field Values

T_NOTHING

public static final java.lang.String T_NOTHING

Deprecated.

See Also:

Constant Field Values

GLYPH

public static final int GLYPH

Deprecated.

Style property: GLYPH displays an arrow in front of each title and list item.
- Introduction
- Chapter One
- Chapter Two
- Paragraph One
- Paragraph Two
- Chapter Three
....

See Also:

Constant Field Values

T_GLYPH

public static final java.lang.String T_GLYPH

Deprecated.

See Also:

Constant Field Values

Constructor Detail

DStyle

public DStyle(java.lang.String n,
              IDStyle s)

Deprecated.

Creates a DStyle named 'n' and gets the information background color, foreground color and title format from the style 's'.
Take care: this is not a deep copy, new style and 's' will share font, fore ground and background objects.

Parameters:

n - name of the style

s - style withe specified foreground color, background color and title format.

DStyle

public DStyle(java.lang.String n,
              IDFont f,
              IDColor fore,
              IDColor back)

Deprecated.

Creates a DStyle named 'n' with font 'f', foreground color 'fore' and background color 'back'.

Parameters:

n - name of the style

f - font of the style

fore - foregroundcolor of the style

back - backgroundcolor of the style

DStyle

public DStyle()

Deprecated.

Creates a DStyle. By default this style is named 'unamed' with a null font, a null background and foreground color, a null wallpaper and a numberingFormat equal to 0

DStyle

public DStyle(java.lang.String n)

Deprecated.

Creates a DStyle,Setting only a name with a null font, a null background and foreground color, a null wallpaper and a numberingFormat equal to 0

Method Detail

getName

public java.lang.String getName()

Deprecated.

Access method for the name property.

Specified by:

getName in interface IDStyle

Returns:

the current value of the name property

setName

public void setName(java.lang.String aName)

Deprecated.

Sets the value of the name property. If aName is null the style is named automatically 'unamed'

Specified by:

setName in interface IDStyle

Parameters:

aName - the new value of the name property

getNumberingFormat

public int getNumberingFormat()

Deprecated.

Access method for the numberingFormat property.

Specified by:

getNumberingFormat in interface IDStyle

Returns:

the current value of the numberingFormat property

setNumberingFormat

public void setNumberingFormat(int aNumberingFormat)

Deprecated.

Sets the value of the numberingFormat property.

Specified by:

setNumberingFormat in interface IDStyle

Parameters:

aNumberingFormat - the new value of the numberingFormat property

setFont

public void setFont(IDFont f)

Deprecated.

Sets the font of the style.

Specified by:

setFont in interface IDStyle

Parameters:

f - style font

getFont

public IDFont getFont()

Deprecated.

Gets the font of the style.

Specified by:

getFont in interface IDStyle

setForeColor

public void setForeColor(IDColor c)

Deprecated.

Sets the foreground color of the style.

Specified by:

setForeColor in interface IDStyle

Parameters:

c - style foreground color

setBackColor

public void setBackColor(IDColor c)

Deprecated.

Sets the background color of the style.

Specified by:

setBackColor in interface IDStyle

Parameters:

c - style background color

getBackColor

public IDColor getBackColor()

Deprecated.

Gets the background color of the style.

Specified by:

getBackColor in interface IDStyle

isValidNumberingFormat

public boolean isValidNumberingFormat(int f)

Deprecated.

Retruns true if the integer 'f' passed in parameter is a valid format.

getForeColor

public IDColor getForeColor()

Deprecated.

Gets the foreground color of the style.

Specified by:

getForeColor in interface IDStyle

equals

public boolean equals(java.lang.Object o)

Deprecated.

Compares two styles. Returns true if the font, the foreground color, the background color and the title format are the same.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to be compared

numberingFormatToString

public java.lang.String numberingFormatToString(int i)

Deprecated.

Returns the string numbering format name for this integer value.

Parameters:

i - valid numbering format integer value.

See Also:

stringToNumberingFormat(java.lang.String), isValidNumberingFormat(int)

stringToNumberingFormat

public int stringToNumberingFormat(java.lang.String s)

Deprecated.

Returns the integer numbering format value for this string name.

Parameters:

s - valid numbering format name.

See Also:

stringToNumberingFormat(java.lang.String), isValidNumberingFormat(int)

getWallpaper

public IDWallpaper getWallpaper()

Deprecated.

Returns the wall paper of the style. The wall paper is used by the UI driver to draw the background of DDocument, DCell and DGraphic.

Specified by:

getWallpaper in interface IDStyle

setWallpaper

public void setWallpaper(IDWallpaper wallpaper)

Deprecated.

Changes (replaces) current wallpaper. Please note: stored by a style, all item seems to have a wallpaper, by finally this decision is made by driver which render document (this apply to other styles too).

Specified by:

setWallpaper in interface IDStyle

getID

public java.lang.String getID()

Deprecated.

Specified by:

getID in interface IDStyle

Returns:

the unique id of the style.