org.xwiki.rendering.wikimodel.util

Class TocBuilder

java.lang.Object

org.xwiki.rendering.wikimodel.util.TocBuilder

public class TocBuilder
extends Object

This is an utility class which is used to build tables of content (TOCs).

Since:

4.0M1

Version:

$Id: 7b9148630758f404aa7391ba1dcbe720f8b185ea $

Field Summary

Fields

Modifier and Type	Field and Description
protected int	fBaseLevel
protected Deque<Integer>	fBaseLevelStack
protected int	fLevel

Constructor Summary

Constructors

Constructor and Description
TocBuilder(ITocListener listener)
TocBuilder(ITocListener listener, int totalDepth)
TocBuilder(ITocListener listener, int documentDepth, int headerDepth)
TocBuilder(ITocListener listener, int documentDepth, int headerDepth, int totalDepth)

Method Summary

Methods

Modifier and Type	Method and Description
void	beginDocument()
void	beginHeader(int level)
boolean	checkDepth()
void	endDocument()
void	endHeader()
protected int	getHeaderLevel()
protected void	setHeaderLevel(int level)

Methods inherited from class java.lang.Object

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

Field Detail

fBaseLevel

protected int fBaseLevel

fBaseLevelStack

protected Deque<Integer> fBaseLevelStack

fLevel

protected int fLevel

Constructor Detail

TocBuilder

public TocBuilder(ITocListener listener)

Parameters:

listener -

TocBuilder

public TocBuilder(ITocListener listener,
          int totalDepth)

Parameters:

listener -

totalDepth -

TocBuilder

public TocBuilder(ITocListener listener,
          int documentDepth,
          int headerDepth)

Parameters:

listener -

documentDepth -

headerDepth -

TocBuilder

public TocBuilder(ITocListener listener,
          int documentDepth,
          int headerDepth,
          int totalDepth)

Parameters:

listener -

documentDepth -

headerDepth -

totalDepth -

Method Detail

beginDocument

public void beginDocument()

beginHeader

public void beginHeader(int level)

Parameters:

level -

checkDepth

public boolean checkDepth()

Returns:

true if the current element should be shown

endDocument

public void endDocument()

endHeader

public void endHeader()

getHeaderLevel

protected int getHeaderLevel()

Returns:

the current level of headers

setHeaderLevel

protected void setHeaderLevel(int level)