com.tutego.jrtf

Class RtfDocfmt

java.lang.Object

com.tutego.jrtf.RtfDocfmt

public class RtfDocfmt
extends Object

Instances represent document format like page width, margins.

Method Summary

Methods

Modifier and Type	Method and Description
static RtfDocfmt	bottomMargin(double margin, RtfUnit unit) Bottom margin.
static RtfDocfmt	defaultTab(double width, RtfUnit unit) Default tab width.
static RtfDocfmt	endnotesOnly() Endnotes only.
static RtfDocfmt	facingPages() Facing pages (activates odd/even headers and gutters).
static RtfDocfmt	footnoteNumberingArabic() Footnote numbering - Arabic numbering (1, 2, 3, _).
static RtfDocfmt	footnoteNumberingUpperAlphabetic() Footnote numbering - Alphabetic uppercase (A, B, C, _).
static RtfDocfmt	footnoteNumberingUpperRoman() Footnote numbering - Roman lowercase (i, ii, iii, _).
static RtfDocfmt	footnotesEndnotes() Footnotes and endnotes both.
static RtfDocfmt	footnotesOnly() Footnotes only or nothing at all (default).
static RtfDocfmt	hyphenationHotZone(double width, RtfUnit unit) Hyphenation hot zone.
static RtfDocfmt	landscape() Landscape format.
static RtfDocfmt	leftMargin(double margin, RtfUnit unit) Left margin.
static RtfDocfmt	pageLayoutView() Sets the view mode of the document to page layout.
static RtfDocfmt	paper(double width, double height, RtfUnit unit) Paper width and height.
static RtfDocfmt	paperHeight(double height, RtfUnit unit) Paper height.
static RtfDocfmt	paperWidth(double width, RtfUnit unit) Paper width.
static RtfDocfmt	revisionMarking() Turns on revision marking.
static RtfDocfmt	revisionProtected() This document is protected for revisions.
static RtfDocfmt	rightMargin(double margin, RtfUnit unit) Right margin.
static RtfDocfmt	switchMargin() Switches margin definitions on left and right pages.
static RtfDocfmt	topMargin(double margin, RtfUnit unit) Top margin.
static RtfDocfmt	widowOrphanControl() Enable widow and orphan control.

Methods inherited from class java.lang.Object

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

Method Detail

defaultTab

public static RtfDocfmt defaultTab(double width,
                   RtfUnit unit)

Default tab width. If not set the default is 720 twips.

Parameters:

width - Width of the tab.

unit - Unit of the tab.

Returns:

New RtfDocfmt object.

hyphenationHotZone

public static RtfDocfmt hyphenationHotZone(double width,
                           RtfUnit unit)

Hyphenation hot zone.

Parameters:

width - Amount of space at the right margin in which words are hyphenated.

unit - Unit of the tab.

Returns:

New RtfDocfmt object.

pageLayoutView

public static RtfDocfmt pageLayoutView()

Sets the view mode of the document to page layout.

Returns:

New RtfDocfmt object.

footnotesOnly

public static RtfDocfmt footnotesOnly()

Footnotes only or nothing at all (default).

Returns:

New RtfDocfmt object.

endnotesOnly

public static RtfDocfmt endnotesOnly()

Endnotes only.

Returns:

New RtfDocfmt object.

footnotesEndnotes

public static RtfDocfmt footnotesEndnotes()

Footnotes and endnotes both.

Returns:

New RtfDocfmt object.

footnoteNumberingArabic

public static RtfDocfmt footnoteNumberingArabic()

Footnote numbering - Arabic numbering (1, 2, 3, _).

Returns:

New RtfDocfmt object.

footnoteNumberingUpperAlphabetic

public static RtfDocfmt footnoteNumberingUpperAlphabetic()

Footnote numbering - Alphabetic uppercase (A, B, C, _).

Returns:

New RtfDocfmt object.

footnoteNumberingUpperRoman

public static RtfDocfmt footnoteNumberingUpperRoman()

Footnote numbering - Roman lowercase (i, ii, iii, _).

Returns:

New RtfDocfmt object.

paperWidth

public static RtfDocfmt paperWidth(double width,
                   RtfUnit unit)

Paper width. Default is 12,240 twips.

Parameters:

width - Width of the page.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

paperHeight

public static RtfDocfmt paperHeight(double height,
                    RtfUnit unit)

Paper height. Default is 15,840 twips.

Parameters:

height - Height of the page.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

paper

public static RtfDocfmt paper(double width,
              double height,
              RtfUnit unit)

Paper width and height.

Parameters:

width - Height of the page.

height - Height of the page.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

leftMargin

public static RtfDocfmt leftMargin(double margin,
                   RtfUnit unit)

Left margin. Default is 1,800 twips.

Parameters:

margin - Left margin.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

rightMargin

public static RtfDocfmt rightMargin(double margin,
                    RtfUnit unit)

Right margin. Default is 1,800 twips.

Parameters:

margin - Right margin.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

topMargin

public static RtfDocfmt topMargin(double margin,
                  RtfUnit unit)

Top margin. Default is 1,440 twips.

Parameters:

margin - Top margin.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

bottomMargin

public static RtfDocfmt bottomMargin(double margin,
                     RtfUnit unit)

Bottom margin. Default is 1,440 twips.

Parameters:

margin - Bottom margin.

unit - Measurement unit.

Returns:

New RtfDocfmt object.

facingPages

public static RtfDocfmt facingPages()

Facing pages (activates odd/even headers and gutters).

Returns:

New RtfDocfmt object.

switchMargin

public static RtfDocfmt switchMargin()

Switches margin definitions on left and right pages.

Returns:

New RtfDocfmt object.

landscape

public static RtfDocfmt landscape()

Landscape format.

Returns:

New RtfDocfmt object.

widowOrphanControl

public static RtfDocfmt widowOrphanControl()

Enable widow and orphan control.

Returns:

New RtfDocfmt object.

revisionProtected

public static RtfDocfmt revisionProtected()

This document is protected for revisions. The user can edit the document, but revision marking cannot be disabled.

Returns:

New RtfDocfmt object.

revisionMarking

public static RtfDocfmt revisionMarking()

Turns on revision marking.

Returns:

New RtfDocfmt object.