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

public Class Navigation

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, .Objects, javax.lang.model.element.Element, .ElementKind, .ModuleElement, .PackageElement, .TypeElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, .Links, jdk.javadoc.internal.doclets.toolkit.util.DocFile, .DocLink, .DocPath, .DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlAttr, .HtmlId, .HtmlTag, .HtmlTree, .Text
Factory for navigation bar.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Navigation.PageMode

Field Summary

Modifier and TypeField and Description
private final HtmlConfiguration
configuration

private final Contents
contents

private final Navigation.PageMode
documentedPage

private final Element
element

private final HtmlIds
htmlIds

private final Links
links

private final HtmlOptions
options

private final DocPath
path

private final DocPath
pathToRoot

private final String
rowListTitle

private Content
userHeader

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
private void
addItemToList(Content list, Content item)

private void
addSearch(Content target)

private void
addThemePanel(Content target)

private void
addThemeSwitcher(Content target)

private Content
createModuleSelector()

public Content

Returns:

the navigation content
getContent()

Returns the navigation content.

private String
getTitle(Element elem)

public Navigation
setUserHeader(Content userHeader)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
private final HtmlConfiguration configuration
contentsback to summary
private final Contents contents
documentedPageback to summary
private final Navigation.PageMode documentedPage
elementback to summary
private final Element element
htmlIdsback to summary
private final HtmlIds htmlIds
optionsback to summary
private final HtmlOptions options
pathback to summary
private final DocPath path
pathToRootback to summary
private final DocPath pathToRoot
rowListTitleback to summary
private final String rowListTitle
userHeaderback to summary
private Content userHeader

Constructor Detail

Navigationback to summary
public Navigation(Element element, HtmlConfiguration configuration, Navigation.PageMode page, DocPath path)

Creates a Navigation object for a specific file, to be written in a specific HTML version.

Parameters
element:Element

element being documented. null if its not an element documentation page

configuration:HtmlConfiguration

the configuration object

page:Navigation.PageMode

the kind of page being documented

path:DocPath

the DocPath object

Method Detail

addActivePageLinkback to summary
private void addActivePageLink(Content target, Content label, boolean display)
addBreadcrumbLinksback to summary
protected void addBreadcrumbLinks(Element elem, List<Content> contents, boolean selected)

Adds breadcrumb navigation links for element and its containing elements to contents. Only module, package and type elements are supported in breadcrumb navigation.

Parameters
elem:Element

a module, package or type element

contents:List<Content>

the list to which links are added

selected:boolean

true if elem is the current page element

addDeprecatedLinkback to summary
private void addDeprecatedLink(Content target)
addHelpLinkback to summary
private void addHelpLink(Content target)
addIndexLinkback to summary
private void addIndexLink(Content target)
addItemToListback to summary
private void addItemToList(Content list, Content item)
addMainNavLinksback to summary
private void addMainNavLinks(Content target)

Adds the links for the main navigation.

Parameters
target:Content

the content to which the main navigation will added

addNewLinkback to summary
private void addNewLink(Content target)
addOverviewLinkback to summary
private void addOverviewLink(Content target)

Adds a link to the overview page if indicated by the configuration. Otherwise a link to the first module or package is added.

Parameters
target:Content

content to add the link to

addPageElementLinkback to summary
private void addPageElementLink(Content list)
addPreviewLinkback to summary
private void addPreviewLink(Content target)
addSearchback to summary
private void addSearch(Content target)
addSearchLinkback to summary
private void addSearchLink(Content target)
addThemePanelback to summary
private void addThemePanel(Content target)
addThemeSwitcherback to summary
private void addThemeSwitcher(Content target)
addTreeLinkback to summary
private void addTreeLink(Content target)
createModuleSelectorback to summary
private Content createModuleSelector()
getContentback to summary
public Content getContent()

Returns the navigation content.

Returns:Content

the navigation content

getTitleback to summary
private String getTitle(Element elem)
setUserHeaderback to summary
public Navigation setUserHeader(Content userHeader)
jdk.javadoc.internal.doclets.formats.html back to summary

public final Enum Navigation.PageMode

extends Enum<Navigation.PageMode>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Navigation.PageMode
ALL_CLASSES

public static final Navigation.PageMode
ALL_PACKAGES

public static final Navigation.PageMode
CLASS

public static final Navigation.PageMode
CONSTANT_VALUES

public static final Navigation.PageMode
DEPRECATED

public static final Navigation.PageMode
DOC_FILE

public static final Navigation.PageMode
EXTERNAL_SPECS

public static final Navigation.PageMode
HELP

public static final Navigation.PageMode
INDEX

public static final Navigation.PageMode
MODULE

public static final Navigation.PageMode
NEW

public static final Navigation.PageMode
OVERVIEW

public static final Navigation.PageMode
PACKAGE

public static final Navigation.PageMode
PREVIEW

public static final Navigation.PageMode
RESTRICTED

public static final Navigation.PageMode
SEARCH

public static final Navigation.PageMode
SEARCH_TAGS

public static final Navigation.PageMode
SERIALIZED_FORM

public static final Navigation.PageMode
SYSTEM_PROPERTIES

public static final Navigation.PageMode
TREE

public static final Navigation.PageMode
USE

Constructor Summary

AccessConstructor and Description
private
PageMode()

Method Summary

Modifier and TypeMethod and Description
public static Navigation.PageMode
valueOf(String name)

public static Navigation.PageMode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ALL_CLASSESback to summary
public static final Navigation.PageMode ALL_CLASSES
ALL_PACKAGESback to summary
public static final Navigation.PageMode ALL_PACKAGES
CLASSback to summary
public static final Navigation.PageMode CLASS
CONSTANT_VALUESback to summary
public static final Navigation.PageMode CONSTANT_VALUES
DEPRECATEDback to summary
public static final Navigation.PageMode DEPRECATED
DOC_FILEback to summary
public static final Navigation.PageMode DOC_FILE
EXTERNAL_SPECSback to summary
public static final Navigation.PageMode EXTERNAL_SPECS
HELPback to summary
public static final Navigation.PageMode HELP
INDEXback to summary
public static final Navigation.PageMode INDEX
MODULEback to summary
public static final Navigation.PageMode MODULE
NEWback to summary
public static final Navigation.PageMode NEW
OVERVIEWback to summary
public static final Navigation.PageMode OVERVIEW
PACKAGEback to summary
public static final Navigation.PageMode PACKAGE
PREVIEWback to summary
public static final Navigation.PageMode PREVIEW
RESTRICTEDback to summary
public static final Navigation.PageMode RESTRICTED
SEARCHback to summary
public static final Navigation.PageMode SEARCH
SEARCH_TAGSback to summary
public static final Navigation.PageMode SEARCH_TAGS
SERIALIZED_FORMback to summary
public static final Navigation.PageMode SERIALIZED_FORM
SYSTEM_PROPERTIESback to summary
public static final Navigation.PageMode SYSTEM_PROPERTIES
TREEback to summary
public static final Navigation.PageMode TREE
USEback to summary
public static final Navigation.PageMode USE

Constructor Detail

PageModeback to summary
private PageMode()

Method Detail

valueOfback to summary
public static Navigation.PageMode valueOf(String name)
valuesback to summary
public static Navigation.PageMode[] values()