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

Klasse Contents

java.lang.Object

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

public class Contents
extends Object

Constants and factory methods for common fragments of content used by HtmlDoclet.

The string content of these fragments is generally obtained from the resources found in the doclet’s configuration.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final Content	allClassesAndInterfacesLabel
final Content	allImplementedInterfacesLabel
final Content	allModulesLabel
final Content	allPackagesLabel
final Content	allSuperinterfacesLabel
final Content	also
final Content	annotateTypeOptionalMemberSummaryLabel
final Content	annotateTypeRequiredMemberSummaryLabel
final Content	annotationType
final Content	annotationTypeDetailsLabel
final Content	annotationTypeMemberDetail
final Content	annotationTypeOptionalMemberLabel
final Content	annotationTypeRequiredMemberLabel
final Content	annotationtypes
final Content	annotationTypes
final Content	classes
final Content	classLabel
final Content	constantFieldLabel
final Content	constantsSummaryTitle
final Content	constructorDetailsLabel
final Content	constructorLabel
final Content	constructors
final Content	constructorSummaryLabel
final Content	contentsHeading
final Content	default_
final Content	defaultPackageLabel
final Content	deprecatedAPI
final Content	deprecatedForRemovalPhrase
final Content	deprecatedLabel
final Content	deprecatedPhrase
final Content	descriptionFromClassLabel
final Content	descriptionFromInterfaceLabel
final Content	descriptionLabel
final Content	detailLabel
final Content	enclosingClassLabel
final Content	enclosingInterfaceLabel
final Content	enum_
final Content	enumConstantDetailLabel
final Content	enumConstantLabel
final Content	enumConstantSummary
final Content	enums
final Content	exceptionClass
final Content	exceptionClasses
final Content	exportedTo
final Content	externalSpecifications
final Content	fieldDetailsLabel
final Content	fieldLabel
final Content	fields
final Content	fieldSummaryLabel
final Content	fromLabel
final Content	functionalInterface
final Content	functionalInterfaceMessage
final Content	helpLabel
final Content	helpSubNavLabel
final Content	hierarchyForAllPackages
final Content	implementation
final Content	implementingClassesLabel
final Content	inClass
final Content	indexLabel
final Content	inInterface
final Content	interfaceLabel
final Content	interfaces
final Content	methodDetailLabel
final Content	methodLabel
final Content	methods
final Content	methodSummary
final Content	modifierAndTypeLabel
final Content	modifierLabel
final Content	module_
final Content	moduleLabel
final Content	modulesLabel
final Content	moduleSubNavLabel
final Content	navAnnotationTypeMember
final Content	navAnnotationTypeOptionalMember
final Content	navAnnotationTypeRequiredMember
final Content	navClassesAndInterfaces
final Content	navConstructor
final Content	navDescription
final Content	navEnum
final Content	navField
final Content	navHelpNavigation
final Content	navHelpPages
final Content	navMethod
final Content	navModules
final Content	navNested
final Content	navPackages
final Content	navProperty
final Content	navServices
final Content	nestedClassSummary
final Content	newAPI
final Content	newLabel
final Content	noScriptMessage
final Content	openedTo
final Content	openModuleLabel
final Content	overridesLabel
final Content	overviewLabel
final Content	package_
final Content	packageHierarchies
final Content	packageLabel
final Content	packagesLabel
final Content	packageSubNavLabel
final Content	packageSummaryLabel
final Content	parameters
final Content	previewAPI
final Content	previewLabel
final Content	previewMark
final Content	previewPhrase
final Content	properties
final Content	propertyDetailsLabel
final Content	propertyLabel
final Content	propertySummaryLabel
final Content	recordComponents
final Content	records
final Content	referencedIn
final Content	relatedPackages
final Content	returns
final Content	seeAlso
final Content	serializedForm
final Content	servicesLabel
final Content	specificationLabel
final Content	specifiedByLabel
final Content	subclassesLabel
final Content	subinterfacesLabel
final Content	summaryLabel
final Content	systemPropertiesLabel
final Content	systemPropertiesSummaryLabel
final Content	throws_
final Content	treeLabel
final Content	typeLabel
final Content	typeParameters
final Content	useLabel
final Content	valueLabel

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Content	getContent(String key)	Gets a Content object, containing the string for a given key in the doclet’s resources.
Content	getContent(String key, Object o0)	Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.
Content	getContent(String key, Object o0, Object o1)	Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.
Content	getContent(String key, Object o0, Object o1, Object o2)	Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.
Content	getNavLinkLabelContent(VisibleMemberTable.Kind kind)	Gibt a label that describes the VisibleMemberTable kind zurück.
Content	getNonBreakString(String text)	Gets a Content object for a string, substituting for any space characters found in the named resource string.
Content	join(Content separator, Collection<Content> items)	Returns content composed of items joined together with the specified separator.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

allClassesAndInterfacesLabel

public final Content allClassesAndInterfacesLabel

allImplementedInterfacesLabel

public final Content allImplementedInterfacesLabel

allModulesLabel

public final Content allModulesLabel

allPackagesLabel

public final Content allPackagesLabel

allSuperinterfacesLabel

public final Content allSuperinterfacesLabel

also

public final Content also

annotationTypeOptionalMemberLabel

public final Content annotationTypeOptionalMemberLabel

annotationTypeRequiredMemberLabel

public final Content annotationTypeRequiredMemberLabel

annotateTypeOptionalMemberSummaryLabel

public final Content annotateTypeOptionalMemberSummaryLabel

annotateTypeRequiredMemberSummaryLabel

public final Content annotateTypeRequiredMemberSummaryLabel

annotationType

public final Content annotationType

annotationTypeDetailsLabel

public final Content annotationTypeDetailsLabel

annotationTypeMemberDetail

public final Content annotationTypeMemberDetail

annotationtypes

public final Content annotationtypes

annotationTypes

public final Content annotationTypes

classLabel

public final Content classLabel

classes

public final Content classes

constantFieldLabel

public final Content constantFieldLabel

constantsSummaryTitle

public final Content constantsSummaryTitle

constructorLabel

public final Content constructorLabel

constructorDetailsLabel

public final Content constructorDetailsLabel

constructorSummaryLabel

public final Content constructorSummaryLabel

constructors

public final Content constructors

contentsHeading

public final Content contentsHeading

defaultPackageLabel

public final Content defaultPackageLabel

default_

public final Content default_

deprecatedAPI

public final Content deprecatedAPI

deprecatedLabel

public final Content deprecatedLabel

deprecatedPhrase

public final Content deprecatedPhrase

deprecatedForRemovalPhrase

public final Content deprecatedForRemovalPhrase

descriptionFromClassLabel

public final Content descriptionFromClassLabel

descriptionFromInterfaceLabel

public final Content descriptionFromInterfaceLabel

descriptionLabel

public final Content descriptionLabel

detailLabel

public final Content detailLabel

enclosingClassLabel

public final Content enclosingClassLabel

enclosingInterfaceLabel

public final Content enclosingInterfaceLabel

enumConstantLabel

public final Content enumConstantLabel

enumConstantDetailLabel

public final Content enumConstantDetailLabel

enumConstantSummary

public final Content enumConstantSummary

enum_

public final Content enum_

enums

public final Content enums

exceptionClass

public final Content exceptionClass

exceptionClasses

public final Content exceptionClasses

exportedTo

public final Content exportedTo

externalSpecifications

public final Content externalSpecifications

fieldLabel

public final Content fieldLabel

fieldDetailsLabel

public final Content fieldDetailsLabel

fieldSummaryLabel

public final Content fieldSummaryLabel

fields

public final Content fields

fromLabel

public final Content fromLabel

functionalInterface

public final Content functionalInterface

functionalInterfaceMessage

public final Content functionalInterfaceMessage

helpLabel

public final Content helpLabel

helpSubNavLabel

public final Content helpSubNavLabel

hierarchyForAllPackages

public final Content hierarchyForAllPackages

implementation

public final Content implementation

implementingClassesLabel

public final Content implementingClassesLabel

inClass

public final Content inClass

inInterface

public final Content inInterface

indexLabel

public final Content indexLabel

interfaceLabel

public final Content interfaceLabel

interfaces

public final Content interfaces

methodDetailLabel

public final Content methodDetailLabel

methodLabel

public final Content methodLabel

methodSummary

public final Content methodSummary

methods

public final Content methods

modifierAndTypeLabel

public final Content modifierAndTypeLabel

modifierLabel

public final Content modifierLabel

moduleLabel

public final Content moduleLabel

module_

public final Content module_

moduleSubNavLabel

public final Content moduleSubNavLabel

modulesLabel

public final Content modulesLabel

navAnnotationTypeMember

public final Content navAnnotationTypeMember

navAnnotationTypeOptionalMember

public final Content navAnnotationTypeOptionalMember

navAnnotationTypeRequiredMember

public final Content navAnnotationTypeRequiredMember

navClassesAndInterfaces

public final Content navClassesAndInterfaces

navConstructor

public final Content navConstructor

navDescription

public final Content navDescription

navEnum

public final Content navEnum

navField

public final Content navField

navHelpNavigation

public final Content navHelpNavigation

navHelpPages

public final Content navHelpPages

navMethod

public final Content navMethod

navModules

public final Content navModules

navNested

public final Content navNested

navPackages

public final Content navPackages

navProperty

public final Content navProperty

navServices

public final Content navServices

nestedClassSummary

public final Content nestedClassSummary

newAPI

public final Content newAPI

newLabel

public final Content newLabel

noScriptMessage

public final Content noScriptMessage

openModuleLabel

public final Content openModuleLabel

openedTo

public final Content openedTo

overridesLabel

public final Content overridesLabel

overviewLabel

public final Content overviewLabel

packageHierarchies

public final Content packageHierarchies

packageLabel

public final Content packageLabel

package_

public final Content package_

packagesLabel

public final Content packagesLabel

packageSubNavLabel

public final Content packageSubNavLabel

packageSummaryLabel

public final Content packageSummaryLabel

parameters

public final Content parameters

previewAPI

public final Content previewAPI

previewLabel

public final Content previewLabel

previewMark

public final Content previewMark

previewPhrase

public final Content previewPhrase

properties

public final Content properties

propertyLabel

public final Content propertyLabel

propertyDetailsLabel

public final Content propertyDetailsLabel

propertySummaryLabel

public final Content propertySummaryLabel

records

public final Content records

recordComponents

public final Content recordComponents

referencedIn

public final Content referencedIn

relatedPackages

public final Content relatedPackages

returns

public final Content returns

seeAlso

public final Content seeAlso

serializedForm

public final Content serializedForm

servicesLabel

public final Content servicesLabel

specificationLabel

public final Content specificationLabel

specifiedByLabel

public final Content specifiedByLabel

subclassesLabel

public final Content subclassesLabel

subinterfacesLabel

public final Content subinterfacesLabel

summaryLabel

public final Content summaryLabel

systemPropertiesLabel

public final Content systemPropertiesLabel

systemPropertiesSummaryLabel

public final Content systemPropertiesSummaryLabel

throws_

public final Content throws_

treeLabel

public final Content treeLabel

typeLabel

public final Content typeLabel

typeParameters

public final Content typeParameters

useLabel

public final Content useLabel

valueLabel

public final Content valueLabel

Methodendetails

getContent

public Content getContent(String key)

Gets a Content object, containing the string for a given key in the doclet’s resources.

Parameter:

key - the key for the desired string

Gibt zurück:

the string

getContent

public Content getContent(String key,
 Object o0)

Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.

Parameter:

key - the key for the desired string

o0 - string or content argument to be formatted into the result

Gibt zurück:

the string

getContent

public Content getContent(String key,
 Object o0,
 Object o1)

Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.

Parameter:

key - the key for the desired string

o0 - string or content argument to be formatted into the result

o1 - string or content argument to be formatted into the result

Gibt zurück:

the string

getContent

public Content getContent(String key,
 Object o0,
 Object o1,
 Object o2)

Gets a Content object, containing the string for a given key in the doclet’s resources, formatted with given arguments.

Parameter:

key - the key for the desired string

o0 - string or content argument to be formatted into the result

o1 - string or content argument to be formatted into the result

o2 - string or content argument to be formatted into the result

Gibt zurück:

the string

join

public Content join(Content separator,
 Collection<Content> items)

Returns content composed of items joined together with the specified separator.

Parameter:

separator - the separator

items - the items

Gibt zurück:

the composition

getNonBreakString

public Content getNonBreakString(String text)

Gets a Content object for a string, substituting for any space characters found in the named resource string.

Parameter:

text - the string

Gibt zurück:

the string content

getNavLinkLabelContent

public Content getNavLinkLabelContent(VisibleMemberTable.Kind kind)

Gibt a label that describes the VisibleMemberTable kind zurück.

Parameter:

kind - the visible member table kind.

Gibt zurück:

a label that describes the VisibleMemberTable kind