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

public final Enum HtmlStyles

extends Enum<HtmlStyles>
implements HtmlStyle
Class Inheritance
All Implemented Interfaces
jdk.javadoc.internal.html.HtmlStyle
Imports
java.util.Locale, java.util.regex.Pattern, jdk.javadoc.internal.html.HtmlStyle

Enum representing HTML styles, with associated entries in the stylesheet files.

API Note

Despite the name, the members of this enum provide values for the HTML class attribute, and not the HTML style attribute. This is to avoid confusion with the widespread use of the word "class" in the Java ecosystem, and the potential for clashes with methods called setClass instead of setStyle.

API Note

The description of some members refer to "elements". This typically refers to "HTML elements", but may in some cases refer to or "language model elements". The usage is made explicit when it is not clear from the surrounding context.

API Note

The stylized use of editor-fold comments and line comments (beginning //) is to support extracting details of declarations with external tools. Edit with care!

See Also
WhatWG: class attribute

Field Summary

Modifier and TypeField and Description
public static final HtmlStyles
aboutLanguage

The class for the element containing the information (such as the product name and version) provided by the -header or -footer command line option.

public static final HtmlStyles
activeTableTab

The class of the "tab" that indicates the currently displayed contents of a table.

public static final HtmlStyles
allClassesIndexPage

The class of the body element for the "All Classes" index page.

public static final HtmlStyles
allPackagesIndexPage

The class of the body element for the "All Packages" index page.

public static final HtmlStyles
annotations

The class of a span element containing any annotations in the signature of an element.

public static final HtmlStyles
block

The class of a div element containing part of a documentation comment.

public static final HtmlStyles
blockList

The class of a ul element containing parts of documentation comments.

public static final HtmlStyles
bold

The class of text highlighted with the type bold.

public static final HtmlStyles
caption

The class for the caption of a table.

public static final HtmlStyles
checkboxes

The class for a div element containing a row of checkboxes to select items to view in summary tables.

public static final HtmlStyles
circle

The class of a ul element in the hierarchical tree view.

public static final HtmlStyles
classDeclarationPage

The class of the body element for a class-declaration page.

public static final HtmlStyles
classDescription

The class of the element used to present the documentation comment for a type element.

public static final HtmlStyles
classUsePage

The class of the body element for a class-use page.

public static final HtmlStyles
classUses

The class of a ul element listing classes in the uses page.

public static final HtmlStyles
colConstructorName

The class of the cells in a table column used to display the name of a constructor.

public static final HtmlStyles
colFirst

The class of the first column of cells in a table.

public static final HtmlStyles
colLast

The class of the last column of cells in a table.

public static final HtmlStyles
colPlain

The class of the cells in a table column used to display additional information without any particular style.

public static final HtmlStyles
colSecond

The class of the second column of cells in a table.

public static final HtmlStyles
colSummaryItemName

The class of the cells in a table column used to display the name of a summary item.

public static final HtmlStyles
constantDetails

The class for the section containing the list of details for all the enum constants declared in a enum element.

public static final HtmlStyles
constantsSummary

The class for a section element on the "Constants Field Values" page, and the class for the section element for the enum constants of an enum class.

public static final HtmlStyles
constantsSummaryPage

The class of the body element for the constants-summary page.

public static final HtmlStyles
constructorDetails

The class for the section containing the list of details for all the constructors declared in a type element.

public static final HtmlStyles
constructorSummary

The class for the section element containing a summary of the constructors for a type.

public static final HtmlStyles
contentsList

The class for a ul element in various summary pages containing links to the contents of the page.

public static final HtmlStyles
copy

The class for a button element to copy some page content to the clipboard.

private final String
public static final HtmlStyles
currentSelection

The class for the link representing the current element in breadcrumb navigation and table of contents.

public static final HtmlStyles
deprecatedInReleasePage

The class of the body element for the page listing any deprecated items.

public static final HtmlStyles
deprecatedLabel

The class for the "Deprecated" label in a block describing the "deprecated" status of a declaration.

public static final HtmlStyles
deprecatedListPage

The class of the body element for the page listing any deprecated items.

public static final HtmlStyles
deprecationBlock

The class for a block describing the "deprecated" status of a declaration.

public static final HtmlStyles
deprecationComment

The class for the details in a block describing the "deprecated" status of a declaration.

public static final HtmlStyles
descriptionFromTypeLabel

The class for a label indicating the element from which a description has been copied.

public static final HtmlStyles
detail

The class for the section element containing the details for a single enclosed element.

public static final HtmlStyles
details

The class for the overall section element for all the details about enclosed program elements.

public static final HtmlStyles
detailsList

The class for the list of sublists containing the details for the different kinds of program elements.

public static final HtmlStyles
detailsTable

The class of a div element used to present details of a program element.

public static final HtmlStyles
docFilePage

The class of the body element for a "doc-file" page..

public static final HtmlStyles
elementName

The class of a span containing the element name in the element's signature.

public static final HtmlStyles
evenRowColor

A class used to provide the background for the rows of a table, to provide a "striped" effect.

public static final HtmlStyles
exceptions

The class of a span element containing any exceptions in a signature of an executable element.

public static final HtmlStyles
extendsImplements

The class of a span element containing the extends or implements section in a signature of a type element.

public static final HtmlStyles
externalLink

The class of an a element for a link with an external target.

public static final HtmlStyles
externalSpecsPage

The class of the body element for the "external specifications" page.

public static final HtmlStyles
fieldDetails

The class for the section containing the list of details for all the fields declared in a type element.

public static final HtmlStyles
fieldSummary

The class for a section element containing a summary of the fields of a type.

public static final HtmlStyles
filterInput

The class for the input element to filter items in the table of contents.

public static final HtmlStyles
fourColumnSummary

The class of a div element whose content should be rendered as a table with four columns.

public static final HtmlStyles
header

The class for the element that contains all of the main heading for the page.

public static final HtmlStyles
helpFootnote

The class of the footnote at the bottom of the page.

public static final HtmlStyles
helpNote

The class of the "Note:" prefix.

public static final HtmlStyles
helpPage

The class of the body element for the "help" page.

public static final HtmlStyles
helpSection

The class of each subsection in the page.

public static final HtmlStyles
helpSectionList

The class of lists in a subsection in the page.

public static final HtmlStyles
helpSubTOC

The class of the second-level lists in the table of contents for the page.

public static final HtmlStyles
helpTOC

The class of the top level list for the table of contents for the page.

public static final HtmlStyles
hideSidebar

The class for the button element to hide the sidebar.

public static final HtmlStyles
hierarchy

The class of a section element containing a hierarchical tree view.

public static final HtmlStyles
highlighted

The class of text highlighted with the type highlighted.

public static final HtmlStyles
horizontal

The class of a ul element with horizontal (inline) display style.

public static final HtmlStyles
horizontalScroll

The class of a div element that allows its horizontal overflow to be scrolled.

public static final HtmlStyles
implementationLabel

The class of a span element containing implementation details of a "provides" entry in a module page.

public static final HtmlStyles
index

The class of a dl element in the body of index pages.

public static final HtmlStyles
indexPage

The class of the body element for a page in either the "single" or "split index".

public static final HtmlStyles
indexRedirectPage

The class of the body element for the top-level redirect page.

public static final HtmlStyles
inheritance

The class of a div element containing the inheritance tree of a class page.

public static final HtmlStyles
inheritedList

The class of a div element containing a summary of inherited members in the class page.

public static final HtmlStyles
invalidTag

The class of an element that acts as a notification for an invalid tag or other invalid items.

public static final HtmlStyles
italic

The class of text highlighted with the type italic.

public static final HtmlStyles
legalCopy

The class of a p element containing legal copy in the page footer.

public static final HtmlStyles
mainGrid

The class for the div element containing the sidebar and main content.

public static final HtmlStyles
memberDetails

The class for the section containing the list of details for all the members declared in a annotation type element.

public static final HtmlStyles
memberList

The class for the list containing the details for the members of a given element kind.

public static final HtmlStyles
memberNameLink

The class of an a element for a link in member summary lists.

public static final HtmlStyles
memberSignature

The class of an element containing a member signature.

public static final HtmlStyles
memberSummary

The class for a section element containing the members of a given kind for a type.

public static final HtmlStyles
methodDetails

The class for the section containing the list of details for all the methods declared in a type element.

public static final HtmlStyles
methodSummary

The class for the section element containing a summary of the methods of a type.

public static final HtmlStyles
modifiers

The class of a span containing any modifiers in the signature of an element.

public static final HtmlStyles
moduleDeclarationPage

The class of the body element for a module-declaration page.

public static final HtmlStyles
moduleDescription

The class of the element used to present the documentation comment for a module element, excluding block tags.

public static final HtmlStyles
moduleIndexPage

The class of the body element for the module-index page.

public static final HtmlStyles
moduleSignature

The class of an element containing a module signature.

public static final HtmlStyles
modulesSummary

The class for the section element containing a summary of the module dependencies of a module.

public static final HtmlStyles
nameValue

The class of a dl element containing serial UID information in the serialized form page.

public static final HtmlStyles
nestedClassSummary

The class for the section element containing a summary of the nested classes of a type.

public static final HtmlStyles
newApiListPage

The class of the body element for the page listing new API elements.

public static final HtmlStyles
notes

The class of the dl element used to present the block tags in the documentation comment for a package, type or member element.

public static final HtmlStyles
oddRowColor

A class used to provide the background for the rows of a table, to provide a "striped" effect.

public static final HtmlStyles
packageDeclarationPage

The class of the body element for a package-declaration page.

public static final HtmlStyles
packageDescription

The class of the element used to present the documentation comment for package element.

public static final HtmlStyles
packageHierarchyLabel

The class of a span element containing the package hierarchy label in the tree page.

public static final HtmlStyles
packageIndexPage

The class of the body element for the package-index page.

public static final HtmlStyles
packages

The class of a section element containing the packages section in the constant field values page.

public static final HtmlStyles
packageSignature

The class of an element containing a package signature.

public static final HtmlStyles
packagesSummary

The class for the section element containing a summary of the packages provided by a module, and the class for the list of packages on the "All Packages" index page.

public static final HtmlStyles
packageTreePage

The class of the body element for the page for the package hierarchy.

public static final HtmlStyles
packageUsePage

The class of the body element for a package-use page.

public static final HtmlStyles
packageUses

The class of a li element containing a content section of the package uses page.

public static final HtmlStyles
pageSearchDetails

The class for a details element in the search page to show additional information.

public static final HtmlStyles
pageSearchInfo

The class for a div element in the search page which contains additional information.

public static final HtmlStyles
parameters

The class of a span containing any parameters in the signature of an executable element.

public static final HtmlStyles
permits

The class of a span containing the permits section of a sealed class element.

public static final HtmlStyles
permitsNote

The class for a note providing information about the permitted subtypes of a sealed class.

public static final HtmlStyles
previewBlock

The class for a block describing the "preview" status of a declaration.

public static final HtmlStyles
previewComment

The class for the details in a block describing the "preview" status of a declaration.

public static final HtmlStyles
previewFeatureList

The class for a ul element in the preview summary page containing information about the preview features in the current release.

public static final HtmlStyles
previewLabel

The class for the "Preview" label in a block describing the "preview" status of a declaration.

public static final HtmlStyles
previewListPage

The class of the body element for the page listing any preview items.

public static final HtmlStyles
previewMark

The class used for a sup element marking an element as preview feature.

public static final HtmlStyles
propertyDetails

The class for the section containing the list of details for all the properties declared in a JavaFX type element.

public static final HtmlStyles
propertySummary

The class for the section element containing a summary of the properties for a type.

public static final HtmlStyles
refList

The class for the list of references to an external specification.

public static final HtmlStyles
resetFilter

The class for the reset button in the sidebar filter input element.

public static final HtmlStyles
restrictedBlock

The class for a block describing the "restricted" status of a declaration.

public static final HtmlStyles
restrictedComment

The class for the details in a block describing the "restricted" status of a declaration.

public static final HtmlStyles
restrictedLabel

The class for the "Restricted" label in a block describing the "restricted" status of a declaration.

public static final HtmlStyles
restrictedListPage

The class of the body element for the page listing restricted methods.

public static final HtmlStyles
restrictedMark

The class used for a sup element marking a method as restricted.

public static final HtmlStyles
returnType

The class of a span containing the return type in the signature of a method element.

public static final HtmlStyles
searchForm

The class for a div element in the search widget containing the search form inputs.

public static final HtmlStyles
searchLinks

The class for a div element in the search widget containing search-related links.

public static final HtmlStyles
searchPage

The class of the body element for the search page.

public static final HtmlStyles
searchTagLink

The class for a link in the static "Index" pages to a custom searchable item, such as defined with an @index tag.

public static final HtmlStyles
searchTagResult

The class for a custom searchable item, such as defined with an @index tag.

public static final HtmlStyles
searchTagsPage

The class of the body element for the search tags page.

public static final HtmlStyles
serializedClassDetails

The class for a section element containing details of the serialized form of an element, on the "Serialized Form" page.

public static final HtmlStyles
serializedFormPage

The class of the body element for the serialized-forms page.

public static final HtmlStyles
serializedPackageContainer

The class of a section element for a package in the serialized form page.

public static final HtmlStyles
servicesSummary

The class for the section element containing a summary of the services provided or used by a module.

public static final HtmlStyles
showSidebar

The class for the button element to show the sidebar.

public static final HtmlStyles
skipNav

The class for a div element containing a link to skip the navigation header.

public static final HtmlStyles
snippet

The class of the pre element presenting a snippet.

public static final HtmlStyles
snippetContainer

The class of the div element containing a snippet element.

public static final HtmlStyles
snippetCopy

The class of the UI element to copy snippet content to the clipboard.

public static final HtmlStyles
sourceContainer

The class of a div element containing source code in the source page.

public static final HtmlStyles
sourceLineNo

The class of a span element containing a line number in the source page.

public static final HtmlStyles
sourcePage

The class of the body element for a page with the source code for a class.

public static final HtmlStyles
subTitle

The class for the element containing the label and name for the module or package that precedes the main title for the declaration of a package or type.

public static final HtmlStyles
summary

The class for the overall section element containing all the different kinds of summary for the parts of the program element declared on this page.

public static final HtmlStyles
summaryList

The class for the list element of all the different kinds of summary for the parts of the program element declared on this page.

public static final HtmlStyles
summaryTable

The class of a div element used to present a summary of the enclosed elements of a program element.

public static final HtmlStyles
systemPropertiesPage

The class of the body element for the system-properties page.

public static final HtmlStyles
tableHeader

The class of an element that is part of a table header.

public static final HtmlStyles
tableTab

The class of a "tab" that indicates an alternate view of the contents of a table.

public static final HtmlStyles
tableTabs

The class of the div element that contains the tabs used to select the contents of the associated table to be displayed.

public static final HtmlStyles
tagList

The class for a list containing the tags of an element.

public static final HtmlStyles
tagListLong

The class for a list containing the tags of an element when some tags have longer labels or contain commas.

public static final HtmlStyles
threeColumnReleaseSummary

The class of a div element whose content should be rendered as a table with three columns where the middle column requires less space as it only contains a release name.

public static final HtmlStyles
threeColumnSummary

The class of a div element whose content should be rendered as a table with three columns.

public static final HtmlStyles
title

The class for the element containing the label and name for the main title on a page for the declaration of a package or type.

public static final HtmlStyles
toc

The class for a nav element containing a table of contents.

public static final HtmlStyles
tocHeader

The class for the div element representing the header of the table of contents.

public static final HtmlStyles
tocList

The class used for list elements in the table of contents.

public static final HtmlStyles
tocSortIsActive

The class used to indicate the state of the lexical sort toggle.

public static final HtmlStyles
tocSortToggle

The class used for lexical order toggle in the table of contents.

public static final HtmlStyles
topNav

The class for the overall div element containing the header element for the page.

public static final HtmlStyles
treePage

The class of the body element for the page for the class hierarchy.

public static final HtmlStyles
twoColumnSummary

The class of a div element whose content should be rendered as a table with two columns.

public static final HtmlStyles
typeNameLabel

The class of a span element containing the type name in a type signature.

public static final HtmlStyles
typeNameLink

The class of an a element for a link to a class or interface.

public static final HtmlStyles
typeParameters

The class of a span containing type parameters in the signature of an element, used when the type parameters should reasonably be displayed inline.

public static final HtmlStyles
typeSignature

The class of an element containing a type signature.

public static final HtmlStyles
verticalSeparator

The class for the separator in the list of pages given at the top of the static "Index" page(s).

Constructor Summary

AccessConstructor and Description
private
private
HtmlStyles(String cssName)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the CSS class name
cssName
()

Implements jdk.javadoc.internal.html.HtmlStyle.cssName.

Returns the CSS class name associated with this style.

public static HtmlStyles
public static HtmlStyles[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf