com.inet.report
Interface ParagraphProperties

All Known Implementing Classes:

FieldElement, Paragraph

public interface ParagraphProperties

Interface for elements that displays lines of text.

This class is part of the RDC.

Field Summary

static int	INDENT_DEFAULT Default value for all indents, meaning there is no indent.
static double	LINE_SPACING_ABSOLUTE Constant for line spacing, meaning there is no relative value for the line spacing but that it is determined by an absolute value
static int	LINE_SPACING_RELATIVE Constant for line spacing, meaning there is no absolute value for the line spacing but that it is determined in relation to the default line height of each line in the paragraph.

Method Summary

int	getFirstLineIndent() Returns the value of the property 'first line indent'.
FormulaField	getFirstLineIndentFormula() Returns the formula whose return value determines the property 'first line indent'.
int	getLeftIndent() Returns the value of the property 'left indent'.
FormulaField	getLeftIndentFormula() Returns the formula whose return value determines the property 'left indent'.
int	getLineSpacingAbsolute() Returns the absolute distance between baselines of the lines in this paragraph, measured in twips.
FormulaField	getLineSpacingAbsoluteFormula() Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.
double	getLineSpacingRelative() Returns the factor by which the default line spacing is to be multiplied for this paragraph.
FormulaField	getLineSpacingRelativeFormula() Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.
int	getRightIndent() Returns the value of the property 'rightIndent'.
FormulaField	getRightIndentFormula() Returns the formula whose return value determines the property 'right indent'.
void	setFirstLineIndent(int firstLineIndent) Sets the value of the property 'first line indent'.
void	setFirstLineIndentFormula(FormulaField formula) Sets the formula whose return value determines the property 'first line indent'.
void	setLeftIndent(int leftIndent) Sets the value of the property 'left indent'.
void	setLeftIndentFormula(FormulaField formula) Sets the formula whose return value determines the property 'left indent'.
void	setLineSpacingAbsolute(int newValue) Sets the absolute distance between baselines of the lines in this paragraph, measured in twips.
void	setLineSpacingAbsoluteFormula(FormulaField formula) Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.
void	setLineSpacingRelative(double newValue) Sets the factor by which the default line spacing is to be multiplied for this paragraph.
void	setLineSpacingRelativeFormula(FormulaField formula) Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.
void	setRightIndent(int newValue) Sets the value of the property 'rightIndent'.
void	setRightIndentFormula(FormulaField formula) Sets the formula whose return value determines the property 'right indent'.

Field Detail

LINE_SPACING_RELATIVE

static final int LINE_SPACING_RELATIVE

Constant for line spacing, meaning there is no absolute value for the line spacing but that it is determined in relation to the default line height of each line in the paragraph.

See Also:

getLineSpacingAbsolute(), setLineSpacingAbsolute(int), Constant Field Values

LINE_SPACING_ABSOLUTE

static final double LINE_SPACING_ABSOLUTE

Constant for line spacing, meaning there is no relative value for the line spacing but that it is determined by an absolute value

See Also:

getLineSpacingRelative(), setLineSpacingRelative(double), Constant Field Values

INDENT_DEFAULT

static final int INDENT_DEFAULT

Default value for all indents, meaning there is no indent. Equivalent to 0.

See Also:

setLeftIndent(int), getLeftIndent(), setRightIndent(int), getRightIndent(), setFirstLineIndent(int), getFirstLineIndent(), Constant Field Values

Method Detail

getFirstLineIndent

int getFirstLineIndent()

Returns the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).

Returns:

The value of the property 'first line indent'.

setFirstLineIndent

void setFirstLineIndent(int firstLineIndent)

Sets the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).

Parameters:

firstLineIndent - The new value of the property 'first line indent'. May be negative (which would cause the first line to be left of the left margin).

getFirstLineIndentFormula

FormulaField getFirstLineIndentFormula()

Returns the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).

Returns:

The formula whose return value determines the property 'first line indent'.

Since:

8.0

setFirstLineIndentFormula

void setFirstLineIndentFormula(FormulaField formula)

Sets the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).

Parameters:

formula - The formula whose return value determines the property 'first line indent'.

Since:

8.0

getLeftIndent

int getLeftIndent()

Returns the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).

Returns:

The value of the property 'left indent'.

setLeftIndent

void setLeftIndent(int leftIndent)

Sets the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).

Parameters:

leftIndent - The new value of the property 'left indent'.

Throws:

java.lang.IllegalArgumentException - If a negative number is passed

getLeftIndentFormula

FormulaField getLeftIndentFormula()

Returns the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).

Returns:

The formula whose return value determines the property 'left indent'.

Since:

8.0

setLeftIndentFormula

void setLeftIndentFormula(FormulaField formula)

Sets the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).

Parameters:

formula - The formula whose return value determines the property 'left indent'.

Since:

8.0

getRightIndent

int getRightIndent()

Returns the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).

Returns:

The current value of the property 'rightIndent'.

setRightIndent

void setRightIndent(int newValue)

Sets the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).

Parameters:

newValue - The new value of the property 'rightIndent'.

Throws:

java.lang.IllegalArgumentException - If a negative number is passed

getRightIndentFormula

FormulaField getRightIndentFormula()

Returns the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).

Returns:

The formula whose return value determines the property 'right indent'.

Since:

8.0

setRightIndentFormula

void setRightIndentFormula(FormulaField formula)

Sets the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).

Parameters:

formula - The formula whose return value determines the property 'right indent'.

Since:

8.0

getLineSpacingAbsolute

int getLineSpacingAbsolute()

Returns the absolute distance between baselines of the lines in this paragraph, measured in twips. If a relative factor has been set, this will return the constant LINE_SPACING_RELATIVE.

Returns:

Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE

See Also:

setLineSpacingAbsolute(int), LINE_SPACING_RELATIVE

setLineSpacingAbsolute

void setLineSpacingAbsolute(int newValue)

Sets the absolute distance between baselines of the lines in this paragraph, measured in twips. It is also possible to set LINE_SPACING_RELATIVE, which restores the default setting.

Parameters:

newValue - Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE in order to restore the default setting.

Throws:

java.lang.IllegalArgumentException - If a negative number is passed which is not LINE_SPACING_RELATIVE.

See Also:

getLineSpacingAbsolute(), LINE_SPACING_RELATIVE

getLineSpacingAbsoluteFormula

FormulaField getLineSpacingAbsoluteFormula()

Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.

Returns:

Absolute distance between baselines in this paragraph, measured in twips

Since:

8.0

See Also:

setLineSpacingAbsolute(int)

setLineSpacingAbsoluteFormula

void setLineSpacingAbsoluteFormula(FormulaField formula)

Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.

Parameters:

formula - formula whose return value determines the absolute distance between baselines in this paragraph, measured in twips

Since:

8.0

See Also:

setLineSpacingAbsolute(int)

getLineSpacingRelative

double getLineSpacingRelative()

Returns the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. If an absolute value has been set, this will return LINE_SPACING_ABSOLUTE instead.

Returns:

Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if an absolute line spacing distance has been set.

See Also:

LINE_SPACING_ABSOLUTE, getLineSpacingRelative()

setLineSpacingRelative

void setLineSpacingRelative(double newValue)

Sets the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. Setting LINE_SPACING_ABSOLUTE will cause the value to be reset to its default, which is "1".

Parameters:

newValue - Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if the default value is to be set (equivalent to "1")

Throws:

java.lang.IllegalArgumentException - If a negative number is passed which is not LINE_SPACING_ABSOLUTE

See Also:

LINE_SPACING_ABSOLUTE, getLineSpacingRelative()

getLineSpacingRelativeFormula

FormulaField getLineSpacingRelativeFormula()

Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.

Returns:

formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph

Since:

8.0

See Also:

getLineSpacingRelative()

setLineSpacingRelativeFormula

void setLineSpacingRelativeFormula(FormulaField formula)

Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.

Parameters:

formula - formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph

Since:

8.0

See Also:

setLineSpacingRelative(double)