com.tutego.jrtf

Class RtfFields

java.lang.Object

com.tutego.jrtf.RtfFields

public class RtfFields
extends Object

Utility methods around the method RtfText.field(RtfPara, RtfPara).

Method Summary

Methods

Modifier and Type	Method and Description
static RtfText	authorField() Writes field for the author of this document.
static RtfText	field(RtfPara fieldInstructions) Inserts a field with the default string "Refresh >F9<".
static RtfText	field(String fieldInstructions) Inserts a field with the default string "Refresh >F9<".
static RtfText	pageNumberField() Writes field for current pages.
static RtfText	sectionPagesField() Writes field for total number of pages in a section.
static RtfText	tableOfContentsField() Writes field for table of contents.
static RtfText	timeField(String format) Writes out a time field in a given format.

Methods inherited from class java.lang.Object

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

Method Detail

field

public static RtfText field(RtfPara fieldInstructions)

Inserts a field with the default string "Refresh >F9<".

Parameters:

fieldInstructions - Field instructions.

Returns:

RtfText which represents a field.

field

public static RtfText field(String fieldInstructions)

Inserts a field with the default string "Refresh >F9<".

Parameters:

fieldInstructions - Field instructions.

Returns:

RtfText which represents a field.

timeField

public static RtfText timeField(String format)

Writes out a time field in a given format.

Parameters:

format - Format of the time, e.g. "HH:MM"

Returns:

RtfText which represents a field with time.

pageNumberField

public static RtfText pageNumberField()

Writes field for current pages.

Returns:

RtfText which represents a field with page number.

sectionPagesField

public static RtfText sectionPagesField()

Writes field for total number of pages in a section.

Returns:

RtfText which represents a field with totel page numbers.

authorField

public static RtfText authorField()

Writes field for the author of this document.

Returns:

RtfText which represents a field with author.

tableOfContentsField

public static RtfText tableOfContentsField()

Writes field for table of contents.

Returns:

RtfText which represents a field with TOC.