Package org.nuxeo.ecm.platform.rendering.wiki

Class Toc

java.lang.Object

org.nuxeo.ecm.platform.rendering.wiki.Toc

public class Toc
extends Object

Table of contents model.

A simple linked list of toc entries.

Author:

Bogdan Stefanescu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Toc.Entry

Field Summary

Fields

Modifier and Type	Field	Description
protected Toc.Entry	head
protected Toc.Entry	tail

Constructor Summary

Constructors

Constructor	Description
Toc()

Method Summary

Modifier and Type	Method	Description
String	addHeading(String title, int level)	Adds a heading to the TOC list and returns the ID of that heading (to be used for anchors).

Methods inherited from class java.lang.Object

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

Field Detail

head

protected final Toc.Entry head

tail

protected Toc.Entry tail

Constructor Detail

Toc

public Toc()

Method Detail

addHeading

public String addHeading(String title,
                         int level)

Adds a heading to the TOC list and returns the ID of that heading (to be used for anchors).

Parameters:

title - the heading title

level - the heading level

Returns:

the heading id