org.apache.juneau.rest

Class HtmlDocBuilder

java.lang.Object

org.apache.juneau.rest.HtmlDocBuilder

public class HtmlDocBuilder
extends Object

Programmatic interface for setting properties used by the HtmlDoc serializer.

Basically just a convenience wrapper around the servlet or method level properties for setting properties defined by the HtmlDocSerializer class.

This class is instantiated through the following methods:

• RestContextBuilder.getHtmlDocBuilder() - Set values programmatically during servlet initialization.
• RestResponse.getHtmlDocBuilder() - Set values programmatically during a REST request.

See Also:

• Overview > juneau-rest-server > @HtmlDoc

Method Summary

Modifier and Type	Method and Description
HtmlDocBuilder	aside(Object... value) Sets the HTML aside section contents.
HtmlDocBuilder	footer(Object... value) Sets the HTML footer section contents.
HtmlDocBuilder	head(Object... value) Sets the HTML head section contents.
HtmlDocBuilder	header(Object... value) Sets the HTML header section contents.
HtmlDocBuilder	nav(Object... value) Sets the HTML nav section contents.
HtmlDocBuilder	navlinks(Object... value) Sets the links in the HTML nav section.
HtmlDocBuilder	noResultsMessage(Object value) Specifies the text to display when serializing an empty array or collection.
HtmlDocBuilder	nowrap(boolean value) Shorthand method for forcing the rendered HTML content to be no-wrap.
HtmlDocBuilder	script(Object... value) Sets the HTML script section contents.
HtmlDocBuilder	style(Object... value) Sets the HTML CSS style section contents.
HtmlDocBuilder	stylesheet(Object... value) Sets the CSS URL in the HTML CSS style section.
HtmlDocBuilder	template(Class<? extends HtmlDocTemplate> value) Specifies the template class to use for rendering the HTML page.
HtmlDocBuilder	template(HtmlDocTemplate value) Specifies the template class to use for rendering the HTML page.

Methods inherited from class java.lang.Object

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

Method Detail

header

public HtmlDocBuilder header(Object... value)

Sets the HTML header section contents.

The page header normally contains the title and description, but this value can be used to override the contents to be whatever you want.

Notes:

• The format of this value is HTML.
• When a value is specified, the navlinks(Object...) value will be ignored.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.header() annotation.

Parameters:

value - The HTML header section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

navlinks

public HtmlDocBuilder navlinks(Object... value)

Sets the links in the HTML nav section.

The page links are positioned immediately under the title and text.

Notes:

• The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are relative (to the servlet) or absolute URLs.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• Supports URI resolution (e.g. "servlet:/...", "request:/...").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.navlinks() annotation.

Parameters:

value - The HTML nav section links links.

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

nav

public HtmlDocBuilder nav(Object... value)

Sets the HTML nav section contents.

The nav section of the page contains the links.

Notes:

• The format of this value is HTML.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• When a value is specified, the navlinks(Object[]) value will be ignored.
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.nav() annotation.

Parameters:

value - The HTML nav section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

aside

public HtmlDocBuilder aside(Object... value)

Sets the HTML aside section contents.

The aside section typically floats on the right side of the page.

Notes:

• The format of this value is HTML.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.aside() annotation.

Parameters:

value - The HTML aside section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

footer

public HtmlDocBuilder footer(Object... value)

Sets the HTML footer section contents.

The footer section typically floats on the bottom of the page.

Notes:

• The format of this value is HTML.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.footer() annotation.

Parameters:

value - The HTML footer section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

style

public HtmlDocBuilder style(Object... value)

Sets the HTML CSS style section contents.

Notes:

• The format of this value is CSS.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.style() annotation.

Parameters:

value - The HTML CSS style section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

stylesheet

public HtmlDocBuilder stylesheet(Object... value)

Sets the CSS URL in the HTML CSS style section.

Specifies the URL to the stylesheet to add as a link in the style tag in the header.

Notes:

• The format of this value is a comma-delimited list of URLs.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• This is the programmatic equivalent to the @HtmlDoc.stylesheet() annotation.

Parameters:

value - The CSS URL in the HTML CSS style section. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

script

public HtmlDocBuilder script(Object... value)

Sets the HTML script section contents.

Notes:

• The format of this value is Javascript.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.script() annotation.

Parameters:

value - The HTML script section contents. Object will be converted to a string using Object.toString().

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

head

public HtmlDocBuilder head(Object... value)

Sets the HTML head section contents.

Notes:

• The format of this value is HTML.
• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• A value of "INHERIT" means copy the values from the parent.
• A value of "NONE" can be used to force no value.
• This is the programmatic equivalent to the @HtmlDoc.head() annotation.

Parameters:

value - The HTML head section contents.

• Tip: Use StringMessage to generate value with delayed serialization so as not to waste string concatenation cycles on non-HTML views.

Returns:

This object (for method chaining).

nowrap

public HtmlDocBuilder nowrap(boolean value)

Shorthand method for forcing the rendered HTML content to be no-wrap.

Notes:

• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• This is the programmatic equivalent to the @HtmlDoc.nowrap() annotation.

Parameters:

value - The new nowrap setting.

Returns:

This object (for method chaining).

noResultsMessage

public HtmlDocBuilder noResultsMessage(Object value)

Specifies the text to display when serializing an empty array or collection.

Notes:

• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• This is the programmatic equivalent to the @HtmlDoc.noResultsMessage() annotation.

Parameters:

value - The text to display when serializing an empty array or collection.

Returns:

This object (for method chaining).

template

public HtmlDocBuilder template(Class<? extends HtmlDocTemplate> value)

Specifies the template class to use for rendering the HTML page.

By default, uses HtmlDocTemplateBasic to render the contents, although you can provide your own custom renderer or subclasses from the basic class to have full control over how the page is rendered.

Notes:

• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• This is the programmatic equivalent to the @HtmlDoc.template() annotation.

Parameters:

value - The HTML page template to use to render the HTML page.

Returns:

This object (for method chaining).

template

public HtmlDocBuilder template(HtmlDocTemplate value)

Specifies the template class to use for rendering the HTML page.

By default, uses HtmlDocTemplateBasic to render the contents, although you can provide your own custom renderer or subclasses from the basic class to have full control over how the page is rendered.

Notes:

• Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
• This is the programmatic equivalent to the @HtmlDoc.template() annotation.

Parameters:

value - The HTML page template to use to render the HTML page.

Returns:

This object (for method chaining).