ru.novosoft.dc.rtf.dom
Class FootnoteContext

java.lang.Object
  |
  +--ru.novosoft.dc.rtf.dom.FootnoteContext

public final class FootnoteContext

extends java.lang.Object

Footnotes and endnotes properties.

Field Summary

static byte	ALLOW_BOTH Footnote/endnote type: footnotes and endnotes.
static byte	ALLOW_ENDNOTES Footnote/endnote type: endnotes only.
static byte	ALLOW_FOOTNOTES Footnote/endnote type: footnotes only (or nothing).
static byte	ALPHABETIC_LOWERCASE Numbering: Alphabetic lowercase (a, b, c, etc.)
static byte	ALPHABETIC_UPPERCASE Numbering: Alphabetic uppercase (A, B, C, etc.)
static byte	ARABIC Numbering: Arabic (1, 2, 3, etc.)
static byte	CHICAGO Numbering: Chicago Manual of Style (*, †, ‡, ).
static byte	CHINESE_1 Numbering: Chinese 1.
static byte	CHINESE_2 Numbering: Chinese 2.
static byte	CHINESE_3 Numbering: Chinese 3.
static byte	CHINESE_4 Numbering: Chinese 4.
static byte	CIRCLE Numbering: Circle.
static byte	CONTINUE_NOTICE Index of the notice for continued footnote/endnote.
static byte	CONTINUE_SEPARATOR Index of the continued footnote/endnote separator.
static byte	DOUBLE_BYTE Numbering: double-byte.
static byte	KANJI_3 Numbering: Kanji 3.
static byte	KANJI_4 Numbering: Kanji 4.
static byte	KANJI_WITH_DIGIT Numbering: Kanji numbering with the digit character.
static byte	KANJI_WITHOUT_DIGIT Numbering: Kanji numbering without the digit character.
static byte	KOREAN_CHOSUNG Numbering: Korean 1.
static byte	KOREAN_GANADA Numbering: Korean 2.
static byte	NO_RESTART Continuous numbering.
static byte	RESTART_EACH_PAGE Restart numbering each page (footnotes only).
static byte	RESTART_EACH_SECTION Restart numbering each section.
static byte	ROMAN_LOWERCASE Numbering: Roman lowercase (i, ii, iii, etc.)
static byte	ROMAN_UPPERCASE Numbering: Roman uppercase (I, II, III, etc.)
static byte	SEPARATOR Index of the footnote/endnote separator;
static byte	ZODIAC_1 Numbering: Chinese Zodiac 1.
static byte	ZODIAC_2 Numbering: Chinese Zodiac 2.
static byte	ZODIAC_3 Numbering: Chinese Zodiac 3.

Constructor Summary

FootnoteContext()

Method Summary

boolean	areEndnotesAtSectionEnd() Return true if endnotes are at the end of section.
boolean	areFootnotesAtBottom() Return true if footnotes are at the bottom of page.
void	exportTo(org.w3c.dom.Element elem) Export the contents of this object to the specified DOM element.
int	getEndnoteNumbering() Return the endnote numbering style.
int	getEndnoteNumberingRestart() Return the type of the footnote numbering restart.
RTFFlow	getEndnoteSeparator(int index) Return the endnote separator of the specified index or null if the default separator is used.
int	getEndnoteStart() Return the beginning endnote number.
int	getFootnoteNumbering() Return the footnote numbering style.
int	getFootnoteNumberingRestart() Return the type of the footnote numbering restart.
RTFFlow	getFootnoteSeparator(int index) Return the footnote separator of the specified index or null if the default separator is used.
int	getFootnoteStart() Return the beginning footnote number.
int	getNotesType() Return the type of using footnotes/endnotes.
void	setEndnoteNumbering(int value) Set a style for the endnote numbering.
void	setEndnoteNumberingRestart(int value) Set a value for the endnote numbering restart type.
void	setEndnotesAtSectionEnd(boolean value) Set a value for the "endnotes at section end" flag.
void	setEndnoteSeparator(int index, RTFFlow value) Set endnote separator of the specified index.
void	setEndnoteStart(int value) Set the beginning endnote number (the default is 1).
void	setFootnoteNumbering(int value) Set a style for the footnote numbering.
void	setFootnoteNumberingRestart(int value) Set a value for the footnote numbering restart type.
void	setFootnotesAtBottom(boolean value) Set a value for the "footnotes at page bottom" flag.
void	setFootnoteSeparator(int index, RTFFlow value) Set footnote separator of the specified index.
void	setFootnoteStart(int value) Set the beginning footnote number (the default is 1).
void	setNotesType(int value) Set a type of using footnotes/endnotes.

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_FOOTNOTES

public static final byte ALLOW_FOOTNOTES

Footnote/endnote type: footnotes only (or nothing).

ALLOW_ENDNOTES

public static final byte ALLOW_ENDNOTES

Footnote/endnote type: endnotes only.

ALLOW_BOTH

public static final byte ALLOW_BOTH

Footnote/endnote type: footnotes and endnotes.

SEPARATOR

public static final byte SEPARATOR

Index of the footnote/endnote separator;

CONTINUE_SEPARATOR

public static final byte CONTINUE_SEPARATOR

Index of the continued footnote/endnote separator.

CONTINUE_NOTICE

public static final byte CONTINUE_NOTICE

Index of the notice for continued footnote/endnote.

ARABIC

public static final byte ARABIC

Numbering: Arabic (1, 2, 3, etc.)

ALPHABETIC_LOWERCASE

public static final byte ALPHABETIC_LOWERCASE

Numbering: Alphabetic lowercase (a, b, c, etc.)

ALPHABETIC_UPPERCASE

public static final byte ALPHABETIC_UPPERCASE

Numbering: Alphabetic uppercase (A, B, C, etc.)

ROMAN_LOWERCASE

public static final byte ROMAN_LOWERCASE

Numbering: Roman lowercase (i, ii, iii, etc.)

ROMAN_UPPERCASE

public static final byte ROMAN_UPPERCASE

Numbering: Roman uppercase (I, II, III, etc.)

CHICAGO

public static final byte CHICAGO

Numbering: Chicago Manual of Style (*, †, ‡, ).

KOREAN_CHOSUNG

public static final byte KOREAN_CHOSUNG

Numbering: Korean 1.

KOREAN_GANADA

public static final byte KOREAN_GANADA

Numbering: Korean 2.

CIRCLE

public static final byte CIRCLE

Numbering: Circle.

KANJI_WITHOUT_DIGIT

public static final byte KANJI_WITHOUT_DIGIT

Numbering: Kanji numbering without the digit character.

KANJI_WITH_DIGIT

public static final byte KANJI_WITH_DIGIT

Numbering: Kanji numbering with the digit character.

KANJI_3

public static final byte KANJI_3

Numbering: Kanji 3.

KANJI_4

public static final byte KANJI_4

Numbering: Kanji 4.

DOUBLE_BYTE

public static final byte DOUBLE_BYTE

Numbering: double-byte.

CHINESE_1

public static final byte CHINESE_1

Numbering: Chinese 1.

CHINESE_2

public static final byte CHINESE_2

Numbering: Chinese 2.

CHINESE_3

public static final byte CHINESE_3

Numbering: Chinese 3.

CHINESE_4

public static final byte CHINESE_4

Numbering: Chinese 4.

ZODIAC_1

public static final byte ZODIAC_1

Numbering: Chinese Zodiac 1.

ZODIAC_2

public static final byte ZODIAC_2

Numbering: Chinese Zodiac 2.

ZODIAC_3

public static final byte ZODIAC_3

Numbering: Chinese Zodiac 3.

NO_RESTART

public static final byte NO_RESTART

Continuous numbering.

RESTART_EACH_SECTION

public static final byte RESTART_EACH_SECTION

Restart numbering each section.

RESTART_EACH_PAGE

public static final byte RESTART_EACH_PAGE

Restart numbering each page (footnotes only).

Constructor Detail

FootnoteContext

public FootnoteContext()

Method Detail

setNotesType

public final void setNotesType(int value)

Set a type of using footnotes/endnotes. The allowed types are ALLOW_FOOTNOTES, ALLOW_ENDNOTES, and ALLOW_BOTH.

getNotesType

public final int getNotesType()

Return the type of using footnotes/endnotes.

setFootnoteSeparator

public final void setFootnoteSeparator(int index,
                                       RTFFlow value)

Set footnote separator of the specified index.

getFootnoteSeparator

public final RTFFlow getFootnoteSeparator(int index)

Return the footnote separator of the specified index or null if the default separator is used.

setEndnoteSeparator

public final void setEndnoteSeparator(int index,
                                      RTFFlow value)

Set endnote separator of the specified index.

getEndnoteSeparator

public final RTFFlow getEndnoteSeparator(int index)

Return the endnote separator of the specified index or null if the default separator is used.

setFootnotesAtBottom

public final void setFootnotesAtBottom(boolean value)

Set a value for the "footnotes at page bottom" flag. If true, the footnotes are at the bottom of page, otherwise they are beneath text.

areFootnotesAtBottom

public final boolean areFootnotesAtBottom()

Return true if footnotes are at the bottom of page.

setEndnotesAtSectionEnd

public final void setEndnotesAtSectionEnd(boolean value)

Set a value for the "endnotes at section end" flag. If true, the endnotes are at the end of section, otherwise they are at the end of document.

areEndnotesAtSectionEnd

public final boolean areEndnotesAtSectionEnd()

Return true if endnotes are at the end of section.

setFootnoteNumbering

public final void setFootnoteNumbering(int value)

Set a style for the footnote numbering.

getFootnoteNumbering

public final int getFootnoteNumbering()

Return the footnote numbering style.

setEndnoteNumbering

public final void setEndnoteNumbering(int value)

Set a style for the endnote numbering.

getEndnoteNumbering

public final int getEndnoteNumbering()

Return the endnote numbering style.

setFootnoteStart

public final void setFootnoteStart(int value)

Set the beginning footnote number (the default is 1).

getFootnoteStart

public final int getFootnoteStart()

Return the beginning footnote number.

setEndnoteStart

public final void setEndnoteStart(int value)

Set the beginning endnote number (the default is 1).

getEndnoteStart

public final int getEndnoteStart()

Return the beginning endnote number.

setFootnoteNumberingRestart

public final void setFootnoteNumberingRestart(int value)

Set a value for the footnote numbering restart type.

getFootnoteNumberingRestart

public final int getFootnoteNumberingRestart()

Return the type of the footnote numbering restart.

setEndnoteNumberingRestart

public final void setEndnoteNumberingRestart(int value)

Set a value for the endnote numbering restart type.

getEndnoteNumberingRestart

public final int getEndnoteNumberingRestart()

Return the type of the footnote numbering restart.

exportTo

public void exportTo(org.w3c.dom.Element elem)

Export the contents of this object to the specified DOM element.