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

public Class BodyContents

extends Content
Class Inheritance
Imports
java.io.IOException, .Writer, java.util.ArrayList, .List, .Objects, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree, .Text
Content for the <body> element. The content is a <div> element that contains a header that is always visible, main content that can be scrolled if necessary, and optional side and footer contents that are only rendered if available.

Field Summary

Modifier and TypeField and Description
private Content
footer

private Content
header

private final List<Content>
mainContents

private Content
side

Constructor Summary

AccessConstructor and Description
public
BodyContents()

Method Summary

Modifier and TypeMethod and Description
public BodyContents
addMainContent(Content content)

public boolean

Returns:

false
isEmpty()

Implements abstract jdk.javadoc.internal.html.Content.isEmpty.

Returns true if the content is empty.

public BodyContents
setFooter(Content footer)

public BodyContents
setHeader(Content header)

public BodyContents
setSideContent(Content side)

private Content

Returns:

the HTML
toContent()

Returns the HTML for the contents of the BODY element.

public boolean
write(Writer out, String newline, boolean atNewline)

Implements abstract jdk.javadoc.internal.html.Content.write.

Writes content to a writer, using a given newline sequence, which should be either \n or the platform line separator.

Inherited from jdk.javadoc.internal.html.Content:
addaddaddAllcharCountisDiscardableisPhrasingContentstripTagstoString

Field Detail

mainContentsback to summary
private final List<Content> mainContents
sideback to summary
private Content side

Constructor Detail

BodyContentsback to summary
public BodyContents()

Method Detail

addMainContentback to summary
public BodyContents addMainContent(Content content)
isEmptyback to summary
public boolean isEmpty()

Implements abstract jdk.javadoc.internal.html.Content.isEmpty.

Doc from jdk.javadoc.internal.html.Content.isEmpty.

Returns true if the content is empty.

Implementation Specification

This implementation always returns false.

Returns:boolean

false

Annotations
@Override
setFooterback to summary
public BodyContents setFooter(Content footer)
setHeaderback to summary
public BodyContents setHeader(Content header)
setSideContentback to summary
public BodyContents setSideContent(Content side)
toContentback to summary
private Content toContent()

Returns the HTML for the contents of the BODY element.

Returns:Content

the HTML

writeback to summary
public boolean write(Writer out, String newline, boolean atNewline) throws IOException

Implements abstract jdk.javadoc.internal.html.Content.write.

Doc from jdk.javadoc.internal.html.Content.write.

Writes content to a writer, using a given newline sequence, which should be either \n or the platform line separator.

Annotations
@Override
Exceptions
IOException:
if an error occurs while writing the output