info.bliki.wiki.tags

Class TableOfContentTag

java.lang.Object

info.bliki.htmlcleaner.TagToken

info.bliki.htmlcleaner.TagNode

info.bliki.wiki.tags.HTMLTag

info.bliki.wiki.tags.TableOfContentTag

All Implemented Interfaces:

BaseToken, PlainTextConvertable, ITableOfContent, IBodyTag, Cloneable

public class TableOfContentTag
extends HTMLTag
implements IBodyTag, ITableOfContent

Wiki tag for rendering the "table of contents" inside a wikipedia article

Field Summary

Fields inherited from class info.bliki.wiki.tags.HTMLTag

NEW_LINES, XML_QNAME

Fields inherited from class info.bliki.htmlcleaner.TagNode

ALLOWED_ATTRIBUTES, ALLOWED_ATTRIBUTES_SET

Fields inherited from class info.bliki.htmlcleaner.TagToken

name, originalSource

Constructor Summary

Constructors

Constructor and Description
TableOfContentTag(String name)

Method Summary

Modifier and Type	Method and Description
Object	clone()
List<SectionHeader>	getSectionHeaders() Get a list of the section headers (i.e.
List<Object>	getTableOfContent()
boolean	isReduceTokenStack()
boolean	isShowToC()
boolean	isTOCIdentifier()
void	renderHTML(ITextConverter converter, Appendable writer, IWikiModel model)
void	setShowToC(boolean showToC) Enable or disable the rendering of the "table of content"
void	setTOCIdentifier(boolean isTOCIdentifier)

Methods inherited from class info.bliki.wiki.tags.HTMLTag

appendAttributes, appendEscapedAttributes, getDefaultParentTag, renderHTMLWithoutTag, setTemplate

Methods inherited from class info.bliki.htmlcleaner.TagNode

addAllowedAttribute, addAttribute, addChild, addChildren, addItemForMoving, addObjectAttribute, getAllowedAttributes, getAttributes, getBodyString, getChildren, getItemsToMove, getObjectAttributes, getParent, getParents, isAllowedAttribute, isFormed, makeCopy, renderPlainText, serialize, setFormed, setItemsToMove, setParent

Methods inherited from class info.bliki.htmlcleaner.TagToken

equals, getName, getOriginalSource, hashCode, setName, setOriginalSource, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableOfContentTag

public TableOfContentTag(String name)

Method Detail

renderHTML

public void renderHTML(ITextConverter converter,
                       Appendable writer,
                       IWikiModel model)
                throws IOException

Overrides:

renderHTML in class HTMLTag

Throws:

IOException

isReduceTokenStack

public boolean isReduceTokenStack()

Overrides:

isReduceTokenStack in class TagToken

isShowToC

public boolean isShowToC()

setShowToC

public void setShowToC(boolean showToC)

Enable or disable the rendering of the "table of content"

Specified by:

setShowToC in interface ITableOfContent

Parameters:

showToC - if true render the "table of content"

clone

public Object clone()

Overrides:

clone in class TagNode

getTableOfContent

public List<Object> getTableOfContent()

isTOCIdentifier

public boolean isTOCIdentifier()

setTOCIdentifier

public void setTOCIdentifier(boolean isTOCIdentifier)

getSectionHeaders

public List<SectionHeader> getSectionHeaders()

Description copied from interface: ITableOfContent

Get a list of the section headers (i.e. "==...==", "===...===", "====...====",...) used in this "table of content"

Specified by:

getSectionHeaders in interface ITableOfContent

Returns:

a list with the section headers.