info.bliki.wiki.model.ITableOfContent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bliki-core Show documentation

This is the core project.

The newest version!

package info.bliki.wiki.model;

import info.bliki.wiki.filter.SectionHeader;

import java.util.List;

/**
 * Interface which must be implemented by the tag which renders the "table
 * of content"
 *
 * @see info.bliki.wiki.tags.TableOfContentTag
 */
public interface ITableOfContent {
    /**
     * Enable or disable the rendering of the "table of content"
     *
     * @param showToC
     *          if true render the "table of content"
     */
    public void setShowToC(boolean showToC);

    /**
     * Get a list of the section headers (i.e. "==...==",
     * "===...===", "====...====",...) used in this
     * "table of content"
     *
     * @return a list with the section headers.
     */
    public List getSectionHeaders();
}