org.apache.juneau.html

Class HtmlDocSerializerSession

java.lang.Object

org.apache.juneau.Session

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.

This class is NOT thread safe. It is meant to be discarded after one-time use.

Nested Class Summary

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 and Description
protected	HtmlDocSerializerSession(HtmlDocSerializer ctx, SerializerSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
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 output stream or writer.
protected String[]	getAside() Configuration property: Aside section contents.
protected String[]	getFooter() Configuration property: Footer section contents.
protected String[]	getHead() Configuration property: Additional head section content.
protected String[]	getHeader() Configuration property: Header section contents.
protected String[]	getNav() Configuration property: Nav section contents.
protected String[]	getNavlinks() Configuration property: Page navigation links.
String[]	getNavLinks() Returns the HtmlDocSerializer.HTMLDOC_navlinks setting value in this context.
protected String	getNoResultsMessage() Configuration property: No-results message.
protected Set<String>	getScript() Configuration property: Javascript code.
protected Set<String>	getStyle() Configuration property: CSS style code.
protected Set<String>	getStylesheet() Configuration property: Stylesheet import URLs.
protected HtmlDocTemplate	getTemplate() Configuration property: HTML document template.
protected Collection<HtmlWidget>	getWidgets() Configuration property: Page navigation links.
protected boolean	isNowrap() Configuration property: Prevent word wrap on page.
void	parentSerialize(Object out, Object o) Calls the parent doSerialize(SerializerPipe, Object) method which invokes just the HTML serializer.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

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

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

findNsfMappings, getDefaultNamespace, getNamespaces, getXmlWriter, getXsNamespace, isAddNamespaceUrisToRoot, isAutoDetectNamespaces, isEnableNamespaces

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

createPipe, getMaxIndent, getQuoteChar, isUseWhitespace, isWriterSerializer, serialize, serializeToString

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

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

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlDocSerializerSession

protected HtmlDocSerializerSession(HtmlDocSerializer ctx,
                                   SerializerSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime arguments.

Method Detail

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 (for method chaining).

getNavLinks

public final String[] getNavLinks()

Returns the HtmlDocSerializer.HTMLDOC_navlinks setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_navlinks 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 output stream or writer.

This method should NOT close the context 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()

Configuration property: Aside section contents.

Returns:

The overridden contents of the aside section on the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_aside

getFooter

protected final String[] getFooter()

Configuration property: Footer section contents.

Returns:

The overridden contents of the footer section on the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_footer

getHead

protected final String[] getHead()

Configuration property: Additional head section content.

Returns:

HTML content to add to the head section of the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_head

getHeader

protected final String[] getHeader()

Configuration property: Header section contents.

Returns:

The overridden contents of the header section on the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_header

getNav

protected final String[] getNav()

Configuration property: Nav section contents.

Returns:

The overridden contents of the nav section on the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_nav

getNavlinks

protected final String[] getNavlinks()

Configuration property: Page navigation links.

Returns:

Navigation links to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_navlinks

getNoResultsMessage

protected final String getNoResultsMessage()

Configuration property: No-results message.

Returns:

The message used when serializing an empty array or empty list.

See Also:

HtmlDocSerializer.HTMLDOC_noResultsMessage

isNowrap

protected final boolean isNowrap()

Configuration property: 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.HTMLDOC_nowrap

getScript

protected final Set<String> getScript()

Configuration property: Javascript code.

Returns:

Arbitrary Javascript to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_script

getStyle

protected final Set<String> getStyle()

Configuration property: CSS style code.

Returns:

The CSS instructions to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_style

getStylesheet

protected final Set<String> getStylesheet()

Configuration property: Stylesheet import URLs.

Returns:

The link to the stylesheet of the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_stylesheet

getTemplate

protected final HtmlDocTemplate getTemplate()

Configuration property: HTML document template.

Returns:

The template to use for serializing the page.

See Also:

HtmlDocSerializer.HTMLDOC_template

getWidgets

protected final Collection<HtmlWidget> getWidgets()

Configuration property: Page navigation links.

Returns:

Navigation links to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_navlinks

toMap

public ObjectMap toMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class HtmlStrippedDocSerializerSession

Returns:

A new map containing the properties defined on this context.