Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse Navigation

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.Navigation

public class Navigation
extends Object

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.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	Navigation.PageMode
static interface	Navigation.SubNavLinks	An interface to provide links for the subnavigation area.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
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.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addTypeDetailLink(VisibleMemberTable.Kind kind, boolean link, List<Content> listContents)	Adds the navigation Type detail link.
Content	getContent()	Returns the navigation content.
Navigation	setNavLinkClass(Content navLinkClass)
Navigation	setNavLinkModule(Content navLinkModule)
Navigation	setNavLinkPackage(Content navLinkPackage)
Navigation	setSubNavLinks(Navigation.SubNavLinks subNavLinks)
Navigation	setUserHeader(Content userHeader)

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

Navigation

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.

Parameter:

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

configuration - the configuration object

page - the kind of page being documented

path - the DocPath object

Methodendetails

setNavLinkModule

public Navigation setNavLinkModule(Content navLinkModule)

setNavLinkPackage

public Navigation setNavLinkPackage(Content navLinkPackage)

setNavLinkClass

public Navigation setNavLinkClass(Content navLinkClass)

setUserHeader

public Navigation setUserHeader(Content userHeader)

setSubNavLinks

public Navigation setSubNavLinks(Navigation.SubNavLinks subNavLinks)

addTypeDetailLink

protected void addTypeDetailLink(VisibleMemberTable.Kind kind,
 boolean link,
 List<Content> listContents)

Adds the navigation Type detail link.

Parameter:

kind - the kind of member being documented

link - true if the members are listed and need to be linked

listContents - the list of contents to which the detail will be added.

getContent

public Content getContent()

Returns the navigation content.

Gibt zurück:

the navigation content