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

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

getAnchorText, getHtmlWriter, getLabelParameter, getUriAnchorText, isAddBeanTypeProperties, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLinksInStrings, isHtmlMode, isLookForLabelParameters, isUri, serializeAnything, serializeAnything

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

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

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

getMaxIndent, getQuoteChar, isWriterSerializer, serialize, serializeToString

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

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

Methods inherited from class org.apache.juneau.BeanTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getStack, isDetectRecursions, isIgnoreRecursions, 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, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, 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

asMap

public ObjectMap asMap()

Description copied from class: Session

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

Overrides:

asMap in class HtmlSerializerSession

Returns:

A new map containing the properties defined on this context.

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 Exception

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:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

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

getStyle

public 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

public final Set<String> getStylesheet()

Configuration property: Stylesheet import URLs.

Returns:

The link to the stylesheet of the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_stylesheet

getScript

public final Set<String> getScript()

Configuration property: Javascript code.

Returns:

Arbitrary Javascript to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_script

getNavlinks

public final String[] getNavlinks()

Configuration property: Page navigation links.

Returns:

Navigation links to add to the HTML page.

See Also:

HtmlDocSerializer.HTMLDOC_navlinks

getHead

public 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

public 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

public 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

getAside

public 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

public 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

getNoResultsMessage

public 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

public 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

getTemplate

public final HtmlDocTemplate getTemplate()

Configuration property: HTML document template.

Returns:

The template to use for serializing the page.

See Also:

HtmlDocSerializer.HTMLDOC_template

isNoWrap

@Deprecated
public final boolean isNoWrap()

Deprecated. No replacement.