com.admc.jcreole.marker

Class TocMarker

java.lang.Object

com.admc.jcreole.marker.BufferMarker

com.admc.jcreole.marker.TocMarker

All Implemented Interfaces:

java.lang.Comparable<BufferMarker>

public class TocMarker
extends BufferMarker

Since:

1.1

Field Summary

Fields inherited from class com.admc.jcreole.marker.BufferMarker

applied, id, markerChar, offset, targetSb

Constructor Summary

Constructors

Constructor and Description
TocMarker(int id, java.lang.String levelInclusions)

Method Summary

Methods

Modifier and Type	Method and Description
void	setDefaultLevelInclusions(java.lang.String levelInclusions) Set levelInclusions only if one has not been set already (and if the levelInclusions parameter of the constructor was null).
void	setSectionHeadings(Sections sectionHeadings)
java.lang.String	toString()
void	updateBuffer() Removes the single character at the indicated point.

Methods inherited from class com.admc.jcreole.marker.BufferMarker

compareTo, equals, getIdString, getMarkerString, getOffset, setContext, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

TocMarker

public TocMarker(int id,
         java.lang.String levelInclusions)

Parameters:

levelInclusions - See param levelInclusions for method SectionHeading.generateToc().

See Also:

Sections.generateToc(String)

Method Detail

setDefaultLevelInclusions

public void setDefaultLevelInclusions(java.lang.String levelInclusions)

Set levelInclusions only if one has not been set already (and if the levelInclusions parameter of the constructor was null).

setSectionHeadings

public void setSectionHeadings(Sections sectionHeadings)

toString

public java.lang.String toString()

Overrides:

toString in class BufferMarker

updateBuffer

public void updateBuffer()

Description copied from class: BufferMarker

Removes the single character at the indicated point. Some subclasses will need to do more than this to update the buffer.

Overrides:

updateBuffer in class BufferMarker