org.apache.juneau.html.HtmlDocSerializer

All Implemented Interfaces:: AnnotationProvider, HtmlMetaProvider, XmlMetaProvider

Direct Known Subclasses:: HtmlSchemaDocSerializer

public class HtmlDocSerializer extends HtmlStrippedDocSerializer

Serializes POJOs to HTTP responses as HTML documents.

Media types

Handles Accept types: text/html

Produces Content-Type types: text/html

Description

Same as HtmlSerializer, except wraps the response in <html>, <head>, and <body> tags so that it can be rendered in a browser.

Configurable properties are typically specified via @HtmlDocConfig.

Example:

@Rest( messages="nls/AddressBookResource", title="$L{title}", description="$L{description}" ) @HtmlDocConfig( navlinks={ "api: servlet:/api", "doc: doc" } ) public class AddressBookResource extends BasicRestServlet {

The $L{...} variable represent localized strings pulled from the resource bundle identified by the messages annotation.
These variables are replaced at runtime based on the HTTP request locale.
Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.

Notes:

This class is thread safe and reusable.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

HtmlDocSerializer.Builder

Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.html.HtmlSerializer
HtmlSerializer.Sq, HtmlSerializer.SqReadable

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer
XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer
Serializer.Null
Field Summary

Fields

Modifier and Type

Field

Description

static final HtmlDocSerializer

DEFAULT

Default serializer, all default settings.

Fields inherited from class org.apache.juneau.html.HtmlSerializer
DEFAULT_SQ, DEFAULT_SQ_READABLE

Fields inherited from class org.apache.juneau.xml.XmlSerializer
DEFAULT_JUNEAU_NAMESPACE, DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, DEFAULT_XS_NAMESPACE

Fields inherited from class org.apache.juneau.Context
CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider
DISABLE_ANNOTATION_CACHING
Constructor Summary

Constructors

Constructor

Description

HtmlDocSerializer(HtmlDocSerializer.Builder builder)

Constructor.
Method Summary

Modifier and Type

Method

Description

HtmlDocSerializer.Builder

copy()

Creates a builder from this context object.

static HtmlDocSerializer.Builder

create()

Creates a new builder for this object.

HtmlDocSerializerSession.Builder

createSession()

Create a session builder based on the properties defined on this context.

protected final HtmlDocSerializer

forEachWidget(Consumer<HtmlWidget> action)

Performs an action on all widgets defined on this serializer.

protected final String[]

getAside()

Aside section contents.

protected final AsideFloat

getAsideFloat()

Float side section contents.

protected final String[]

getFooter()

Footer section contents.

protected final String[]

getHead()

Additional head section content.

protected final String[]

getHeader()

Header section contents.

protected final String[]

getNav()

Nav section contents.

protected final String[]

getNavlinks()

Page navigation links.

protected final String

getNoResultsMessage()

No-results message.

HtmlSerializer

getSchemaSerializer()

Returns the schema serializer.

protected final String[]

getScript()

Javascript code.

HtmlDocSerializerSession

getSession()

Returns a session to use for this context.

protected final String[]

getStyle()

CSS style code.

protected final String[]

getStylesheet()

Stylesheet import URLs.

protected final HtmlDocTemplate

getTemplate()

HTML document template.

protected final HtmlWidgetMap

getWidgets()

HTML widgets.

protected final boolean

isNowrap()

Prevent word wrap on page.

protected JsonMap

properties()

Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.html.HtmlSerializer
getHtmlBeanPropertyMeta, getHtmlClassMeta, getLabelParameter, getUriAnchorText, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLabelParameters, isDetectLinksInStrings

Methods inherited from class org.apache.juneau.xml.XmlSerializer
getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces

Methods inherited from class org.apache.juneau.serializer.WriterSerializer
getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, serialize, toString

Methods inherited from class org.apache.juneau.serializer.Serializer
createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext
getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable
getBeanContext

Methods inherited from class org.apache.juneau.Context
createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.AnnotationProvider
firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details
- DEFAULT
  
  public static final HtmlDocSerializer DEFAULT
  
  Default serializer, all default settings.
Constructor Details
- HtmlDocSerializer
  
  public HtmlDocSerializer(HtmlDocSerializer.Builder builder)
  
  Constructor.
  
  Parameters:
  
  builder - The builder for this object.
Method Details
- create
  
  public static HtmlDocSerializer.Builder create()
  
  Creates a new builder for this object.
  
  Returns:
  
  A new builder.
- copy
  
  public HtmlDocSerializer.Builder copy()
  
  Description copied from class: Context
  
  Creates a builder from this context object.
  Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
  
  Overrides:
  
  copy in class HtmlStrippedDocSerializer
  
  Returns:
  
  A new Builder object.
- createSession
  
  public HtmlDocSerializerSession.Builder createSession()
  
  Description copied from class: Context
  
  Create a session builder based on the properties defined on this context.
  Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.
  
  Overrides:
  
  createSession in class HtmlStrippedDocSerializer
  
  Returns:
  
  A new session builder.
- getSession
  
  public HtmlDocSerializerSession getSession()
  
  Description copied from class: Context
  
  Returns a session to use for this context.
  Note that subclasses may opt to return a reusable non-modifiable session.
  
  Overrides:
  
  getSession in class HtmlStrippedDocSerializer
  
  Returns:
  
  A new session object.
- getSchemaSerializer
  
  public HtmlSerializer getSchemaSerializer()
  
  Description copied from class: HtmlSerializer
  
  Returns the schema serializer.
  
  Overrides:
  
  getSchemaSerializer in class HtmlSerializer
  
  Returns:
  
  The schema serializer.
- getAside
  
  protected final String[] getAside()
  
  Aside section contents.
  Returns:
  
  The overridden contents of the aside section on the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.aside(String...)
- getAsideFloat
  
  protected final AsideFloat getAsideFloat()
  
  Float side section contents.
  Returns:
  
  How to float the aside contents on the page.
  
  See Also:
  
  HtmlDocSerializer.Builder.asideFloat(AsideFloat)
- getFooter
  
  protected final String[] getFooter()
  
  Footer section contents.
  Returns:
  
  The overridden contents of the footer section on the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.footer(String...)
- getHead
  
  protected final String[] getHead()
  
  Additional head section content.
  Returns:
  
  HTML content to add to the head section of the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.head(String...)
- getHeader
  
  protected final String[] getHeader()
  
  Header section contents.
  Returns:
  
  The overridden contents of the header section on the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.header(String...)
- getNav
  
  protected final String[] getNav()
  
  Nav section contents.
  Returns:
  
  The overridden contents of the nav section on the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.nav(String...)
- getNavlinks
  
  protected final String[] getNavlinks()
  
  Page navigation links.
  Returns:
  
  Navigation links to add to the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.navlinks(String...)
- getNoResultsMessage
  
  protected final String getNoResultsMessage()
  
  No-results message.
  Returns:
  
  The message used when serializing an empty array or empty list.
  
  See Also:
  
  HtmlDocSerializer.Builder.noResultsMessage(String)
- isNowrap
  
  protected final boolean isNowrap()
  
  Prevent word wrap on page.
  Returns:
  
  true if "* {white-space:nowrap}" shoudl be added to the CSS instructions on the page to prevent word wrapping.
  
  See Also:
  
  HtmlDocSerializer.Builder.nowrap()
- getScript
  
  protected final String[] getScript()
  
  Javascript code.
  Returns:
  
  Arbitrary Javascript to add to the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.script(String...)
- getStyle
  
  protected final String[] getStyle()
  
  CSS style code.
  Returns:
  
  The CSS instructions to add to the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.style(String...)
- getStylesheet
  
  protected final String[] getStylesheet()
  
  Stylesheet import URLs.
  Returns:
  
  The link to the stylesheet of the HTML page.
  
  See Also:
  
  HtmlDocSerializer.Builder.stylesheet(String...)
- getTemplate
  
  protected final HtmlDocTemplate getTemplate()
  
  HTML document template.
  Returns:
  
  The template to use for serializing the page.
  
  See Also:
  
  HtmlDocSerializer.Builder.template(Class)
- getWidgets
  
  protected final HtmlWidgetMap getWidgets()
  
  HTML widgets.
  Returns:
  
  Widgets defined on this serializers.
  
  See Also:
  
  HtmlDocSerializer.Builder.widgets(Class...)
- forEachWidget
  
  protected final HtmlDocSerializer forEachWidget(Consumer<HtmlWidget> action)
  
  Performs an action on all widgets defined on this serializer.
  
  Parameters:
  
  action - The action to perform.
  
  Returns:
  
  This object.
- properties
  
  protected JsonMap properties()
  
  Description copied from class: Context
  
  Returns the properties on this bean as a map for debugging.
  
  Overrides:
  
  properties in class HtmlSerializer
  
  Returns:
  
  The properties on this bean as a map for debugging.

Class HtmlDocSerializer

Media types

Description

Example:

Notes:

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.html.HtmlSerializer

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Field Summary

Fields inherited from class org.apache.juneau.html.HtmlSerializer

Fields inherited from class org.apache.juneau.xml.XmlSerializer

Fields inherited from class org.apache.juneau.Context

Fields inherited from interface org.apache.juneau.AnnotationProvider

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.html.HtmlSerializer

Methods inherited from class org.apache.juneau.xml.XmlSerializer

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

Methods inherited from class org.apache.juneau.serializer.Serializer

Methods inherited from class org.apache.juneau.BeanTraverseContext

Methods inherited from class org.apache.juneau.BeanContextable

Methods inherited from class org.apache.juneau.Context

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.juneau.AnnotationProvider

Field Details

DEFAULT

Constructor Details

HtmlDocSerializer

Method Details

create

copy

createSession

getSession

getSchemaSerializer

getAside

getAsideFloat

getFooter

getHead

getHeader

getNav

getNavlinks

getNoResultsMessage

isNowrap

getScript

getStyle

getStylesheet

getTemplate

getWidgets

forEachWidget

properties