org.fourthline.lemma.processor.xhtml

Class TocProcessor

java.lang.Object

org.fourthline.lemma.processor.AbstractProcessor<org.seamless.xhtml.XHTML,org.seamless.xhtml.XHTML>

org.fourthline.lemma.processor.xhtml.TocProcessor

All Implemented Interfaces:

Processor<org.seamless.xhtml.XHTML,org.seamless.xhtml.XHTML>

public class TocProcessor
extends AbstractProcessor<org.seamless.xhtml.XHTML,org.seamless.xhtml.XHTML>

Replaces toc anchors with a generated table-of-contents.

The table-of-contents is generated by discovering all containers in an XHTML document which are classed as a TocProcessor.SectionType. Depending on their nesting level in the document (and not their name - all are equal), they are added to the table-of-contents.

Author:

Christian Bauer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TocProcessor.SectionType
protected class	TocProcessor.TocItem

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECTION_ELEMENT
static String	TYPE_TOC
static String	TYPE_TOC_ITEM
static String	TYPE_TOC_ITEM_LEVEL
static String	TYPE_TOC_ITEM_PREFIX

Fields inherited from class org.fourthline.lemma.processor.AbstractProcessor

READER_SUFFIX_MAP

Constructor Summary

Constructors

Constructor and Description
TocProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addChildTocItems(TocProcessor.TocItem currentTocItem, org.seamless.xhtml.XHTMLElement currentElement)
protected org.seamless.xhtml.XHTML	addTableOfContents(org.seamless.xhtml.XHTML input, Context context)
protected String	findNearestIdentifier(org.seamless.xhtml.XHTMLElement sectionElement)
protected org.seamless.xhtml.XHTMLElement	findNearestTitleElement(org.seamless.xhtml.XHTMLElement sectionElement)
protected org.seamless.xhtml.XHTML	generateToc(TocProcessor.TocItem root)
org.seamless.xhtml.XHTML	process(org.seamless.xhtml.XHTML input, Context context)

Methods inherited from class org.fourthline.lemma.processor.AbstractProcessor

getParser, getReader, getXPath

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TOC

public static final String TYPE_TOC

See Also:

Constant Field Values

TYPE_TOC_ITEM

public static final String TYPE_TOC_ITEM

See Also:

Constant Field Values

TYPE_TOC_ITEM_PREFIX

public static final String TYPE_TOC_ITEM_PREFIX

See Also:

Constant Field Values

TYPE_TOC_ITEM_LEVEL

public static final String TYPE_TOC_ITEM_LEVEL

See Also:

Constant Field Values

SECTION_ELEMENT

public static final String SECTION_ELEMENT

See Also:

Constant Field Values

Constructor Detail

TocProcessor

public TocProcessor()

Method Detail

process

public org.seamless.xhtml.XHTML process(org.seamless.xhtml.XHTML input,
                                        Context context)

addTableOfContents

protected org.seamless.xhtml.XHTML addTableOfContents(org.seamless.xhtml.XHTML input,
                                                      Context context)

addChildTocItems

protected void addChildTocItems(TocProcessor.TocItem currentTocItem,
                                org.seamless.xhtml.XHTMLElement currentElement)

findNearestIdentifier

protected String findNearestIdentifier(org.seamless.xhtml.XHTMLElement sectionElement)

findNearestTitleElement

protected org.seamless.xhtml.XHTMLElement findNearestTitleElement(org.seamless.xhtml.XHTMLElement sectionElement)

generateToc

protected org.seamless.xhtml.XHTML generateToc(TocProcessor.TocItem root)