Package org.apache.juneau.html

Class HtmlDocSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.xml.XmlSerializerSession

org.apache.juneau.html.HtmlSerializerSession

org.apache.juneau.html.HtmlStrippedDocSerializerSession

org.apache.juneau.html.HtmlDocSerializerSession

Direct Known Subclasses:

HtmlSchemaDocSerializerSession

public class HtmlDocSerializerSession
extends HtmlStrippedDocSerializerSession

Context object that lives for the duration of a single serialization of HtmlSerializer and its subclasses.

See Serializer for details.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• HTML Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HtmlDocSerializerSession.Builder	Builder class.

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

XmlSerializerSession.ContentResult

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HtmlDocSerializerSession(HtmlDocSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HtmlDocSerializerSession.Builder	create(HtmlDocSerializer ctx)	Creates a new builder for this object.
protected VarResolverSession	createDefaultVarResolverSession()	Adds a session object to the VarResolverSession in this session.
protected void	doSerialize(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected final HtmlDocSerializerSession	forEachWidget(Consumer<HtmlWidget> action)	Performs an action on all widgets defined in his session.
protected final String[]	getAside()	Aside section contents.
protected final AsideFloat	getAsideFloat()	Aside section contents float.
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.
final String[]	getNavLinks()	Returns the HtmlDocSerializer.Builder.navlinks(String...) setting value in this context.
protected final String	getNoResultsMessage()	No-results message.
protected final String[]	getScript()	Javascript code.
protected final String[]	getStyle()	CSS style code.
protected final String[]	getStylesheet()	Stylesheet import URLs.
protected final HtmlDocTemplate	getTemplate()	HTML document template.
protected final boolean	isNowrap()	Prevent word wrap on page.
protected final boolean	isResolveBodyVars()	Resolve $ variables in serialized POJO.
void	parentSerialize(Object out, Object o)	Calls the parent doSerialize(SerializerPipe, Object) method which invokes just the HTML serializer.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.

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

create

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

create, getAnchorText, getHtmlBeanPropertyMeta, getHtmlClassMeta, getHtmlWriter, getLabelParameter, getUriAnchorText, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLabelParameters, isDetectLinksInStrings, isHtmlMode, isUri, serializeAnything, serializeAnything

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

create, findNsfMappings, getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, getXmlWriter, isAddJsonTags, isAddNamespaceUrisToRoot, isAutoDetectNamespaces, isEnableNamespaces

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

create, createPipe, getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, serialize, serializeToString

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

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, sort, swap, toList, toString, trim

Methods inherited from class org.apache.juneau.BeanTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlDocSerializerSession

protected HtmlDocSerializerSession(HtmlDocSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlDocSerializerSession.Builder create(HtmlDocSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

createDefaultVarResolverSession

protected VarResolverSession createDefaultVarResolverSession()

Description copied from class: SerializerSession

Adds a session object to the VarResolverSession in this session.

Overrides:

createDefaultVarResolverSession in class SerializerSession

Returns:

This object.

getNavLinks

public final String[] getNavLinks()

Returns the HtmlDocSerializer.Builder.navlinks(String...) setting value in this context.

Returns:

The HtmlDocSerializer.Builder.navlinks(String...) setting value in this context. null if not specified. Never an empty map.

doSerialize

protected void doSerialize(SerializerPipe out,
 Object o)
                    throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doSerialize(SerializerSession,SerializerPipe,Object).

Overrides:

doSerialize in class HtmlStrippedDocSerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

parentSerialize

public void parentSerialize(Object out,
 Object o)
                     throws Exception

Calls the parent doSerialize(SerializerPipe, Object) method which invokes just the HTML serializer.

Parameters:

out - Where to send the output from the serializer.

o - The object being serialized.

Throws:

Exception - Error occurred during serialization.

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()

Aside section contents float.

Returns:

The location of where to place the aside section.

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}" should be added to the CSS instructions on the page to prevent word wrapping.

See Also:

• HtmlDocSerializer.Builder.nowrap()

isResolveBodyVars

protected final boolean isResolveBodyVars()

Resolve $ variables in serialized POJO.

Returns:

true if $ variables in serialized POJO should be resolved.

See Also:

• HtmlDocSerializer.Builder.resolveBodyVars()

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)

forEachWidget

protected final HtmlDocSerializerSession forEachWidget(Consumer<HtmlWidget> action)

Performs an action on all widgets defined in his session.

Parameters:

action - The action to perform.

Returns:

This object.

See Also:

• HtmlDocSerializer.Builder.widgets(Class...)

properties

protected JsonMap properties()

Description copied from class: ContextSession

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

Overrides:

properties in class WriterSerializerSession

Returns:

The properties on this bean as a map for debugging.