APIdia Launch Partner
Top Description Inners Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class TableOfContents

extends Object
Class Inheritance
Imports
jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocPaths, jdk.javadoc.internal.html.Content, .Entity, .HtmlAttr, .HtmlId, .HtmlTag, .HtmlTree, .ListBuilder, .Text, java.util.Locale
A class used by various HtmlDocletWriter subclasses to build tables of contents.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TableOfContents.Level

Supported hierarchy levels for entries in the table of contents.

Field Summary

Modifier and TypeField and Description
private final ListBuilder
listBuilder

private final HtmlDocletWriter
writer

Constructor Summary

AccessConstructor and Description
public
TableOfContents(HtmlDocletWriter
the writer
writer)

Constructor

Method Summary

Modifier and TypeMethod and Description
protected Content

Returns:

a content object
toContent(boolean
whether to add a filter text input
hasFilterInput)

Returns a content object containing the table of contents, consisting of a header and the contents list itself.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

listBuilderback to summary
private final ListBuilder listBuilder
writerback to summary
private final HtmlDocletWriter writer

Constructor Detail

TableOfContentsback to summary
public TableOfContents(HtmlDocletWriter writer)

Constructor

Parameters
writer:HtmlDocletWriter

the writer

Method Detail

addLinkback to summary
public void addLink(HtmlId id, Content label, TableOfContents.Level level)

Adds a link to the table of contents at the given level.

Parameters
id:HtmlId

the link fragment

label:Content

the link label

level:TableOfContents.Level

the hierarchical level of the link

toContentback to summary
protected Content toContent(boolean hasFilterInput)

Returns a content object containing the table of contents, consisting of a header and the contents list itself. If the contents list is empty, an empty content object is returned.

Parameters
hasFilterInput:boolean

whether to add a filter text input

Returns:Content

a content object

jdk.javadoc.internal.doclets.formats.html back to summary

public final Enum TableOfContents.Level

extends Enum<TableOfContents.Level>
Class Inheritance
Supported hierarchy levels for entries in the table of contents.

Field Summary

Modifier and TypeField and Description
public static final TableOfContents.Level
FIRST

public static final TableOfContents.Level
SECOND

public static final TableOfContents.Level
THIRD

Constructor Summary

AccessConstructor and Description
private
Level()

Method Summary

Modifier and TypeMethod and Description
public static TableOfContents.Level

Returns:

the appropriate level to represent the given HTML heading
forHeading(String tag)

Returns the appropriate level to represent the given HTML heading.

public static TableOfContents.Level
valueOf(String name)

public static TableOfContents.Level[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FIRSTback to summary
public static final TableOfContents.Level FIRST
SECONDback to summary
public static final TableOfContents.Level SECOND
THIRDback to summary
public static final TableOfContents.Level THIRD

Constructor Detail

Levelback to summary
private Level()

Method Detail

forHeadingback to summary
public static TableOfContents.Level forHeading(String tag)

Returns the appropriate level to represent the given HTML heading.

Returns:TableOfContents.Level

the appropriate level to represent the given HTML heading

valueOfback to summary
public static TableOfContents.Level valueOf(String name)
valuesback to summary
public static TableOfContents.Level[] values()