com.tutego.jrtf

Class RtfTextPara

java.lang.Object

com.tutego.jrtf.RtfPara

com.tutego.jrtf.RtfTextPara

public abstract class RtfTextPara
extends RtfPara

Represents a RTF paragraph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RtfTextPara.BorderStyle Enumerator for different border styles.
static class	RtfTextPara.TabKind Different kind of tabs.
static class	RtfTextPara.TabLead Leading symbols.

Constructor Summary

Constructors

Constructor and Description
RtfTextPara()

Method Summary

Methods

Modifier and Type	Method and Description
RtfTextPara	alignCentered()
RtfTextPara	alignJustified()
RtfTextPara	alignLeft()
RtfTextPara	alignRight()
RtfTextPara	bottomBorder(RtfTextPara.BorderStyle borderStyle) Border bottom.
RtfTextPara	breakPageBeforeParagraph() Break page before the paragraph.
RtfTextPara	cellWidth(double width, RtfUnit unit) Sets the width of a cell if the paragraph is used in a table.
RtfTextPara	hyphenationOff() Hyphenation for the paragraph off.
RtfTextPara	hyphenationOn() Hyphenation for the paragraph on.
RtfTextPara	indentFirstLine(double indentation, RtfUnit unit) First-line indent by given amount.
RtfTextPara	indentLeft(double indentation, RtfUnit unit) Left indent by given amount.
RtfTextPara	indentRight(double indentation, RtfUnit unit) Right indent by given amount.
RtfTextPara	keep() Keep paragraph intact.
RtfTextPara	keepWithNextParagraph() Keep paragraph with the next paragraph.
RtfTextPara	leftBorder(RtfTextPara.BorderStyle borderStyle) Border left.
RtfTextPara	leftToRight() Text in this paragraph will be displayed with left to right precedence.
RtfTextPara	level(int level) Outline level of the paragraph.
RtfTextPara	noLineNumbering() No line numbering.
RtfTextPara	noWidowOrOrphanControl() No widow/orphan control.
RtfTextPara	partOfTable() Paragraph is part of a table.
RtfTextPara	reset() Resets to default paragraph properties.
RtfTextPara	rightBorder(RtfTextPara.BorderStyle borderStyle) Border right.
RtfTextPara	rightToLeft() Text in this paragraph will be displayed with right to left precedence.
RtfTextPara	spaceAfterLine(double space, RtfUnit unit) Space after line by given amount.
RtfTextPara	spaceBeforeLine(double space, RtfUnit unit) Space before line by given amount.
RtfTextPara	spaceBetweenLines(double space, RtfUnit unit) Space between lines by a given amount.
RtfTextPara	spaceBetweenLinesAutomatically() Line spacing is automatically determined by the tallest character in the line.
RtfTextPara	spaceBetweenLinesMultiple(double space, RtfUnit unit) Space between lines is a multiple of single line spacing.
RtfTextPara	spaceBetweenLinesMultipleAtLeastOrExactly(double space, RtfUnit unit) "At Least" or "exactly" space between lines is a multiple of single line spacing.
RtfTextPara	tab(double tabPostion, RtfUnit unit) Defines a tab.
RtfTextPara	tab(RtfTextPara.TabKind tabKind, double tabPostion, RtfUnit unit) Defines a tab.
RtfTextPara	tab(RtfTextPara.TabKind tabKind, RtfTextPara.TabLead tabLead, double tabPostion, RtfUnit unit) Defines a tab with an additional tab lead.
RtfTextPara	topBorder(RtfTextPara.BorderStyle borderStyle) Border top.

Methods inherited from class com.tutego.jrtf.RtfPara

p, p, pard, row, row, row, ul, ul

Methods inherited from class java.lang.Object

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

Constructor Detail

RtfTextPara

public RtfTextPara()

Method Detail

reset

public RtfTextPara reset()

Resets to default paragraph properties.

Returns:

this-object.

hyphenationOn

public RtfTextPara hyphenationOn()

Hyphenation for the paragraph on.

Returns:

this-object.

hyphenationOff

public RtfTextPara hyphenationOff()

Hyphenation for the paragraph off.

Returns:

this-object.

partOfTable

public RtfTextPara partOfTable()

Paragraph is part of a table.

Returns:

this-object.

keep

public RtfTextPara keep()

Keep paragraph intact.

Returns:

this-object.

noWidowOrOrphanControl

public RtfTextPara noWidowOrOrphanControl()

No widow/orphan control.

Returns:

this-object.

keepWithNextParagraph

public RtfTextPara keepWithNextParagraph()

Keep paragraph with the next paragraph.

Returns:

this-object.

level

public RtfTextPara level(int level)

Outline level of the paragraph.

Parameters:

level - Outline level.

Returns:

this-object.

noLineNumbering

public RtfTextPara noLineNumbering()

No line numbering.

Returns:

this-object.

breakPageBeforeParagraph

public RtfTextPara breakPageBeforeParagraph()

Break page before the paragraph.

Returns:

this-object.

alignLeft

public RtfTextPara alignLeft()

Returns:

this-object.

alignRight

public RtfTextPara alignRight()

Returns:

this-object.

alignJustified

public RtfTextPara alignJustified()

Returns:

this-object.

alignCentered

public RtfTextPara alignCentered()

Returns:

this-object.

indentFirstLine

public RtfTextPara indentFirstLine(double indentation,
                          RtfUnit unit)

First-line indent by given amount.

Parameters:

indentation - Indentation.

unit - Measurement unit.

Returns:

this-object.

indentLeft

public RtfTextPara indentLeft(double indentation,
                     RtfUnit unit)

Left indent by given amount.

Parameters:

indentation - Indentation.

unit - Measurement unit.

Returns:

this-object.

indentRight

public RtfTextPara indentRight(double indentation,
                      RtfUnit unit)

Right indent by given amount.

Parameters:

indentation - Indentation.

unit - Measurement unit.

Returns:

this-object.

spaceBeforeLine

public RtfTextPara spaceBeforeLine(double space,
                          RtfUnit unit)

Space before line by given amount. If not set default is 0.

Parameters:

space - Space.

unit - Measurement unit.

Returns:

this-object.

spaceAfterLine

public RtfTextPara spaceAfterLine(double space,
                         RtfUnit unit)

Space after line by given amount. If not set default is 0.

Parameters:

space - Space.

unit - Measurement unit.

Returns:

this-object.

spaceBetweenLines

public RtfTextPara spaceBetweenLines(double space,
                            RtfUnit unit)

Space between lines by a given amount. If not set default is 0.

Parameters:

space - Space. If space is a positive value, this size is used only if it's taller than the tallest character (otherwise, the tallest character is used). If space is a negative value, the absolute value of space is used, even if it is shorter than the tallest character.

unit - Measurement unit.

Returns:

this-object.

spaceBetweenLinesMultipleAtLeastOrExactly

public RtfTextPara spaceBetweenLinesMultipleAtLeastOrExactly(double space,
                                                    RtfUnit unit)

"At Least" or "exactly" space between lines is a multiple of single line spacing. If not set default is 0.

Parameters:

space - Single space between lines.

unit - Measurement unit.

Returns:

this-object.

See Also:

spaceBetweenLines(double, RtfUnit)

spaceBetweenLinesMultiple

public RtfTextPara spaceBetweenLinesMultiple(double space,
                                    RtfUnit unit)

Space between lines is a multiple of single line spacing. If not set default is 0.

Parameters:

space - Space.

unit - Measurement unit.

Returns:

this-object.

See Also:

spaceBetweenLines(double, RtfUnit)

spaceBetweenLinesAutomatically

public RtfTextPara spaceBetweenLinesAutomatically()

Line spacing is automatically determined by the tallest character in the line. The call is equal to spaceBetweenLines(double, RtfUnit) with 0 as first argument.

Returns:

this-object.

See Also:

spaceBetweenLines(double, RtfUnit)

rightToLeft

public RtfTextPara rightToLeft()

Text in this paragraph will be displayed with right to left precedence.

Returns:

this-object.

leftToRight

public RtfTextPara leftToRight()

Text in this paragraph will be displayed with left to right precedence. This is the default.

Returns:

this-object.

tab

public RtfTextPara tab(double tabPostion,
              RtfUnit unit)

Defines a tab.

Parameters:

tabPostion - Position of the tabulator.

unit - Measurement.

Returns:

this-object.

tab

public RtfTextPara tab(RtfTextPara.TabKind tabKind,
              double tabPostion,
              RtfUnit unit)

Defines a tab.

Parameters:

tabKind - What kind of tab. Can be null.

tabPostion - Position of the tabulator.

unit - Measurement.

Returns:

this-object.

tab

public RtfTextPara tab(RtfTextPara.TabKind tabKind,
              RtfTextPara.TabLead tabLead,
              double tabPostion,
              RtfUnit unit)

Defines a tab with an additional tab lead.

Parameters:

tabKind - What kind of tab. Can be null.

tabLead - Leading characters. Can be null.

tabPostion - Position of the tabulator.

unit - Measurement.

Returns:

this-object.

topBorder

public RtfTextPara topBorder(RtfTextPara.BorderStyle borderStyle)

Border top.

Parameters:

borderStyle - Style of the border.

Returns:

this-object.

bottomBorder

public RtfTextPara bottomBorder(RtfTextPara.BorderStyle borderStyle)

Border bottom.

Parameters:

borderStyle - Style of the border.

Returns:

this-object.

leftBorder

public RtfTextPara leftBorder(RtfTextPara.BorderStyle borderStyle)

Border left.

Parameters:

borderStyle - Style of the border.

Returns:

this-object.

rightBorder

public RtfTextPara rightBorder(RtfTextPara.BorderStyle borderStyle)

Border right.

Parameters:

borderStyle - Style of the border.

Returns:

this-object.

cellWidth

public RtfTextPara cellWidth(double width,
                    RtfUnit unit)

Sets the width of a cell if the paragraph is used in a table.

Parameters:

width - Width of the cell.

unit - Unit of the width.

Returns:

this-object.