info.bliki.wiki.tags
Class TableOfContentTag

java.lang.Object
  extended by info.bliki.htmlcleaner.TagToken
      extended by info.bliki.htmlcleaner.TagNode
          extended by info.bliki.wiki.tags.HTMLTag
              extended by info.bliki.wiki.tags.TableOfContentTag
All Implemented Interfaces:
BaseToken, ITableOfContent, IBodyTag, java.lang.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
TableOfContentTag(java.lang.String name)
           
 
Method Summary
 java.lang.Object clone()
           
 java.util.List<SectionHeader> getSectionHeaders()
          Get a list of the section headers (i.e.
 java.util.List<java.lang.Object> getTableOfContent()
           
 boolean isReduceTokenStack()
           
 boolean isShowToC()
           
 boolean isTOCIdentifier()
           
 void renderHTML(ITextConverter converter, java.lang.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, appendUnescapedAttributes, renderHTMLWithoutTag, setTemplate
 
Methods inherited from class info.bliki.htmlcleaner.TagNode
addAllowedAttribute, addAttribute, addChild, addChildren, addItemForMoving, addObjectAttribute, getAllowedAttributes, getAttributes, getBodyString, getBodyString, getChildren, getItemsToMove, getObjectAttributes, getParent, getParents, isAllowedAttribute, isFormed, makeCopy, removeAllowedAttribute, 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(java.lang.String name)
Method Detail

renderHTML

public void renderHTML(ITextConverter converter,
                       java.lang.Appendable writer,
                       IWikiModel model)
                throws java.io.IOException
Overrides:
renderHTML in class HTMLTag
Throws:
java.io.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 java.lang.Object clone()
Overrides:
clone in class TagNode

getTableOfContent

public java.util.List<java.lang.Object> getTableOfContent()

isTOCIdentifier

public boolean isTOCIdentifier()

setTOCIdentifier

public void setTOCIdentifier(boolean isTOCIdentifier)

getSectionHeaders

public java.util.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.


Copyright © 2012 Java Wikipedia API (Bliki engine). All Rights Reserved.