public interface ParagraphProperties
Modifier and Type | Field and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
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'.
|
static final int LINE_SPACING_RELATIVE
static final double LINE_SPACING_ABSOLUTE
static final int INDENT_DEFAULT
int getFirstLineIndent()
void setFirstLineIndent(int firstLineIndent)
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).FormulaField getFirstLineIndentFormula()
void setFirstLineIndentFormula(FormulaField formula)
formula
- The formula whose return value determines the property 'first line indent'.int getLeftIndent()
void setLeftIndent(int leftIndent)
leftIndent
- The new value of the property 'left indent'.java.lang.IllegalArgumentException
- If a negative number is passedFormulaField getLeftIndentFormula()
void setLeftIndentFormula(FormulaField formula)
formula
- The formula whose return value determines the property 'left indent'.int getRightIndent()
void setRightIndent(int newValue)
newValue
- The new value of the property 'rightIndent'.java.lang.IllegalArgumentException
- If a negative number is passedFormulaField getRightIndentFormula()
void setRightIndentFormula(FormulaField formula)
formula
- The formula whose return value determines the property 'right indent'.int getLineSpacingAbsolute()
setLineSpacingAbsolute(int)
,
LINE_SPACING_RELATIVE
void setLineSpacingAbsolute(int newValue)
newValue
- Absolute distance between baselines in this paragraph, measured in twips, or
LINE_SPACING_RELATIVE in order to restore the default setting.java.lang.IllegalArgumentException
- If a negative number is passed which is not LINE_SPACING_RELATIVE.getLineSpacingAbsolute()
,
LINE_SPACING_RELATIVE
FormulaField getLineSpacingAbsoluteFormula()
setLineSpacingAbsolute(int)
void setLineSpacingAbsoluteFormula(FormulaField formula)
formula
- formula whose return value determines the absolute distance between baselines in this paragraph, measured in twipssetLineSpacingAbsolute(int)
double getLineSpacingRelative()
LINE_SPACING_ABSOLUTE
,
getLineSpacingRelative()
void setLineSpacingRelative(double newValue)
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")java.lang.IllegalArgumentException
- If a negative number is passed which is not LINE_SPACING_ABSOLUTELINE_SPACING_ABSOLUTE
,
getLineSpacingRelative()
FormulaField getLineSpacingRelativeFormula()
getLineSpacingRelative()
void setLineSpacingRelativeFormula(FormulaField formula)
formula
- formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraphsetLineSpacingRelative(double)
Copyright © 1999-2020 by i-net software GmbH