com.inet.report
Interface TextProperties

All Known Implementing Classes:

FieldElement, Subreport, Text

public interface TextProperties

Interface for all elements with text, i.e. for Text, Subreport, and FieldElement.

See Also:

Text, Subreport, FieldElement

Field Summary

static int	GLYPH_DEFAULT This is the default glyph orientation, that is, the glyphs are to point towards the source of the block progression.
static int	GLYPH_DOWN The glyphs are to always point downwards, regardless of text or block progression.
static int	GLYPH_LEFT The glyphs are to always point to the left, regardless of text or block progression.
static int	GLYPH_RIGHT The glyphs are to always point to the right, regardless of text or block progression.
static int	GLYPH_UP The glyphs are to always point upwards, regardless of text or block progression.
static int	ROTATE_0 Do not rotate element.
static int	ROTATE_180 Rotate to 180 degrees counter-clockwise.
static int	ROTATE_270 Rotate to 270 degrees counter-clockwise.
static int	ROTATE_90 Rotate to 90 degrees counter-clockwise.

Method Summary

int	getGlyphOrientation() Returns the glyph orientation.
FormulaField	getGlyphOrientationFormula() Returns the formula whose return value determines the glyph orientation.
int	getTextRotation() Returns the value of the property 'text rotation'.
FormulaField	getTextRotationFormula() Returns the formula whose return value determines the property 'text rotation'.
void	setGlyphOrientation(int orientation) Sets the orientation of the glyphs.
void	setGlyphOrientationFormula(FormulaField formula) Sets the formula whose return value determines the glyph orientation.
void	setTextRotation(int rotation) Sets the value of the property 'text rotation'.
void	setTextRotationFormula(FormulaField formula) Sets the formula whose return value determines the property 'text rotation'.

Field Detail

ROTATE_0

static final int ROTATE_0

Do not rotate element.

Since:

7.1

See Also:

Constant Field Values

ROTATE_90

static final int ROTATE_90

Rotate to 90 degrees counter-clockwise.

Since:

7.1

See Also:

Constant Field Values

ROTATE_180

static final int ROTATE_180

Rotate to 180 degrees counter-clockwise.

Since:

7.1

See Also:

Constant Field Values

ROTATE_270

static final int ROTATE_270

Rotate to 270 degrees counter-clockwise.

Since:

7.1

See Also:

Constant Field Values

GLYPH_DEFAULT

static final int GLYPH_DEFAULT

This is the default glyph orientation, that is, the glyphs are to point towards the source of the block progression.

Since:

7.1

See Also:

setGlyphOrientation(int), Constant Field Values

GLYPH_RIGHT

static final int GLYPH_RIGHT

The glyphs are to always point to the right, regardless of text or block progression.

Since:

7.1

See Also:

setGlyphOrientation(int), Constant Field Values

GLYPH_LEFT

static final int GLYPH_LEFT

The glyphs are to always point to the left, regardless of text or block progression.

Since:

7.1

See Also:

setGlyphOrientation(int), Constant Field Values

GLYPH_DOWN

static final int GLYPH_DOWN

The glyphs are to always point downwards, regardless of text or block progression.

Since:

7.1

See Also:

setGlyphOrientation(int), Constant Field Values

GLYPH_UP

static final int GLYPH_UP

The glyphs are to always point upwards, regardless of text or block progression.

Since:

7.1

See Also:

setGlyphOrientation(int), Constant Field Values

Method Detail

setGlyphOrientation

void setGlyphOrientation(int orientation)
                         throws java.lang.IllegalArgumentException

Sets the orientation of the glyphs. This is the rotation of every individual charater in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.

Parameters:

orientation - Orientation to be set for the glyphs (i.e. the rotation of every individual character of the line of text)

Throws:

java.lang.IllegalArgumentException - if the orientation parameter is not allowed

Since:

7.1

See Also:

getGlyphOrientation(), GLYPH_DEFAULT, GLYPH_UP, GLYPH_DOWN, GLYPH_RIGHT, GLYPH_LEFT

getGlyphOrientation

int getGlyphOrientation()

Returns the glyph orientation. This is the rotation of every individual charater in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.

Returns:

glyph orientation

Since:

7.1

See Also:

setGlyphOrientation(int), GLYPH_DEFAULT, GLYPH_UP, GLYPH_DOWN, GLYPH_RIGHT, GLYPH_LEFT

setTextRotation

void setTextRotation(int rotation)

Sets the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.

Parameters:

rotation - The new value of the property 'text rotation'. Rotation is done counter-clockwise.

Since:

7.1

See Also:

ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

getTextRotation

int getTextRotation()

Returns the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.

Returns:

The value of the property 'text rotation'.

Since:

7.1

See Also:

ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

getTextRotationFormula

FormulaField getTextRotationFormula()

Returns the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.

Returns:

formula whose return value determines the property 'text rotation'.

Since:

8.0

See Also:

getTextRotation(), setTextRotation(int)

setTextRotationFormula

void setTextRotationFormula(FormulaField formula)

Sets the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.

Parameters:

formula - formula whose return value determines the property 'text rotation'.

Since:

8.0

See Also:

getTextRotation(), setTextRotation(int)

getGlyphOrientationFormula

FormulaField getGlyphOrientationFormula()

Returns the formula whose return value determines the glyph orientation. This is the rotation of every individual charater in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.

Returns:

the formula whose return value determines the glyph orientation

Since:

8.0

setGlyphOrientationFormula

void setGlyphOrientationFormula(FormulaField formula)

Sets the formula whose return value determines the glyph orientation. This is the rotation of every individual charater in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.

Parameters:

formula - the formula whose return value determines the glyph orientation

Since:

8.0