com.tutego.jrtf

Class RtfSectionFormatAndHeaderFooter

java.lang.Object

com.tutego.jrtf.RtfSectionFormatAndHeaderFooter

public class RtfSectionFormatAndHeaderFooter
extends Object

Section-Formatting.

Method Summary

Methods

Modifier and Type	Method and Description
static RtfSectionFormatAndHeaderFooter	beginningPageNumber(int pageNumber) Beginning page number of this current section.
static RtfSectionFormatAndHeaderFooter	bottomAlignText() Text is bottom-aligned.
static RtfSectionFormatAndHeaderFooter	breakStartsNewColumn() Section break starts a new column.
static RtfSectionFormatAndHeaderFooter	breakStartsNewEvenPage() Section break starts at an even page.
static RtfSectionFormatAndHeaderFooter	breakStartsNewOddPage() Section break starts at an odd page.
static RtfSectionFormatAndHeaderFooter	breakStartsNewPage() Section break starts a new page.
static RtfSectionFormatAndHeaderFooter	centerVerticalText() Text is centered vertically.
static RtfSectionFormatAndHeaderFooter	columns(int columns) Number of columns in this current section.
static RtfSectionFormatAndHeaderFooter	endnotesIncluded() Endnotes are included in this section.
static RtfSectionFormatAndHeaderFooter	footerOnAllPages(RtfPara para) Puts a footer with a given paragraph on all pages in this current section.
static RtfSectionFormatAndHeaderFooter	headerForAllPages(RtfPara para) Puts a header with a given paragraph on all pages in this current section.
static RtfSectionFormatAndHeaderFooter	headerForFirstPage(RtfPara para) Puts a header with a given paragraph on the first page in this current section.
static RtfSectionFormatAndHeaderFooter	headerForLeftHandPages(RtfPara para) Puts a header with a given paragraph on all left-hand pages in this current section.
static RtfSectionFormatAndHeaderFooter	headerForRightHandPages(RtfPara para) Puts a header with a given paragraph on all right-hand pages in this current section.
static RtfSectionFormatAndHeaderFooter	justifyVerticalText() Text is justified vertically.
static RtfSectionFormatAndHeaderFooter	lineBetweenColumns() Puts a line between columns in this current section.
static RtfSectionFormatAndHeaderFooter	noBreak() No section break.
static RtfSectionFormatAndHeaderFooter	reset() Reset to default section properties of this current section.
static RtfSectionFormatAndHeaderFooter	sectionFormatting(RtfSectionFormatAndHeaderFooter... sectionFormats) Builds a RtfSectionFormatAndHeaderFooter objects representing all the section formattings.
static RtfSectionFormatAndHeaderFooter	spaceBetweenColumns(double space, RtfUnit unit) Space between columns in this current section.
static RtfSectionFormatAndHeaderFooter	topAlignText() Text is top-aligned.

Methods inherited from class java.lang.Object

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

Method Detail

sectionFormatting

public static RtfSectionFormatAndHeaderFooter sectionFormatting(RtfSectionFormatAndHeaderFooter... sectionFormats)

Builds a RtfSectionFormatAndHeaderFooter objects representing all the section formattings.

Parameters:

sectionFormats - Sequence of section formats.

Returns:

RtfSectionFormatAndHeaderFooter

reset

public static RtfSectionFormatAndHeaderFooter reset()

Reset to default section properties of this current section.

Returns:

New RtfSectionFormatAndHeaderFooter object.

endnotesIncluded

public static RtfSectionFormatAndHeaderFooter endnotesIncluded()

Endnotes are included in this section.

Returns:

New RtfSectionFormatAndHeaderFooter object.

noBreak

public static RtfSectionFormatAndHeaderFooter noBreak()

No section break.

Returns:

New RtfSectionFormatAndHeaderFooter object.

breakStartsNewColumn

public static RtfSectionFormatAndHeaderFooter breakStartsNewColumn()

Section break starts a new column.

Returns:

New RtfSectionFormatAndHeaderFooter object.

breakStartsNewPage

public static RtfSectionFormatAndHeaderFooter breakStartsNewPage()

Section break starts a new page. That is the default.

Returns:

New RtfSectionFormatAndHeaderFooter object.

breakStartsNewEvenPage

public static RtfSectionFormatAndHeaderFooter breakStartsNewEvenPage()

Section break starts at an even page.

Returns:

New RtfSectionFormatAndHeaderFooter object.

breakStartsNewOddPage

public static RtfSectionFormatAndHeaderFooter breakStartsNewOddPage()

Section break starts at an odd page.

Returns:

New RtfSectionFormatAndHeaderFooter object.

columns

public static RtfSectionFormatAndHeaderFooter columns(int columns)

Number of columns in this current section. Default is 1.

Parameters:

columns - Number of columns for this section.

Returns:

New RtfSectionFormatAndHeaderFooter object.

spaceBetweenColumns

public static RtfSectionFormatAndHeaderFooter spaceBetweenColumns(double space,
                                                  RtfUnit unit)

Space between columns in this current section. Default is 720 twips.

Parameters:

space - Space between columns.

unit - Measurement.

Returns:

New RtfSectionFormatAndHeaderFooter object.

lineBetweenColumns

public static RtfSectionFormatAndHeaderFooter lineBetweenColumns()

Puts a line between columns in this current section.

Returns:

New RtfSectionFormatAndHeaderFooter object.

beginningPageNumber

public static RtfSectionFormatAndHeaderFooter beginningPageNumber(int pageNumber)

Beginning page number of this current section. Default is 1.

Parameters:

pageNumber - Beginning page number.

Returns:

New RtfSectionFormatAndHeaderFooter object.

topAlignText

public static RtfSectionFormatAndHeaderFooter topAlignText()

Text is top-aligned. This is the default.

Returns:

New RtfSectionFormatAndHeaderFooter object.

bottomAlignText

public static RtfSectionFormatAndHeaderFooter bottomAlignText()

Text is bottom-aligned.

Returns:

New RtfSectionFormatAndHeaderFooter object.

centerVerticalText

public static RtfSectionFormatAndHeaderFooter centerVerticalText()

Text is centered vertically.

Returns:

New RtfSectionFormatAndHeaderFooter object.

justifyVerticalText

public static RtfSectionFormatAndHeaderFooter justifyVerticalText()

Text is justified vertically.

Returns:

New RtfSectionFormatAndHeaderFooter object.

headerForAllPages

public static RtfSectionFormatAndHeaderFooter headerForAllPages(RtfPara para)

Puts a header with a given paragraph on all pages in this current section.

Parameters:

para - Paragraph for the header.

Returns:

New RtfSectionFormatAndHeaderFooter object.

headerForLeftHandPages

public static RtfSectionFormatAndHeaderFooter headerForLeftHandPages(RtfPara para)

Puts a header with a given paragraph on all left-hand pages in this current section.

Parameters:

para - Paragraph for the header.

Returns:

New RtfSectionFormatAndHeaderFooter object.

headerForRightHandPages

public static RtfSectionFormatAndHeaderFooter headerForRightHandPages(RtfPara para)

Puts a header with a given paragraph on all right-hand pages in this current section.

Parameters:

para - Paragraph for the header.

Returns:

New RtfSectionFormatAndHeaderFooter object.

headerForFirstPage

public static RtfSectionFormatAndHeaderFooter headerForFirstPage(RtfPara para)

Puts a header with a given paragraph on the first page in this current section.

Parameters:

para - Paragraph for the header.

Returns:

New RtfSectionFormatAndHeaderFooter object.

footerOnAllPages

public static RtfSectionFormatAndHeaderFooter footerOnAllPages(RtfPara para)

Puts a footer with a given paragraph on all pages in this current section.

Parameters:

para - Paragraph for the footer.

Returns:

New RtfSectionFormatAndHeaderFooter object.