public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession
HtmlSerializer
and its subclasses.
See Serializer
for details.
This class is NOT thread safe. It is meant to be discarded after one-time use.
XmlSerializerSession.ContentResult
indent
Modifier | Constructor and Description |
---|---|
protected |
HtmlDocSerializerSession(HtmlDocSerializer ctx,
SerializerSessionArgs args)
Create a new session using properties specified in the context.
|
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. |
getAnchorText, getHtmlWriter, getLabelParameter, getUriAnchorText, isAddBeanTypeProperties, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLinksInStrings, isHtmlMode, isLookForLabelParameters, isUri, serializeAnything, serializeAnything
findNsfMappings, getDefaultNamespace, getNamespaces, getXmlWriter, getXsNamespace, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces
getMaxIndent, getQuoteChar, isWriterSerializer, serialize, serializeToString
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
getInitialDepth, getLastLocation, getMaxDepth, getStack, isDetectRecursions, isIgnoreRecursions, pop, push, setCurrentClass, setCurrentProperty, willRecurse
_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
addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString
protected HtmlDocSerializerSession(HtmlDocSerializer ctx, SerializerSessionArgs args)
ctx
- The context creating this session object.
The context contains all the configuration settings for this object.args
- Runtime arguments.public ObjectMap asMap()
Session
asMap
in class HtmlSerializerSession
public final String[] getNavLinks()
HtmlDocSerializer.HTMLDOC_navlinks
setting value in this context.HtmlDocSerializer.HTMLDOC_navlinks
setting value in this context.
protected void doSerialize(SerializerPipe out, Object o) throws Exception
SerializerSession
This method should NOT close the context object.
doSerialize
in class HtmlStrippedDocSerializerSession
out
- Where to send the output from the serializer.o
- The object to serialize.Exception
- If thrown from underlying stream, or if the input contains a syntax error or is malformed.public void parentSerialize(Object out, Object o) throws Exception
doSerialize(SerializerPipe, Object)
method which invokes just the HTML serializer.out
- Where to send the output from the serializer.o
- The object being serialized.Exception
public final Set<String> getStyle()
HtmlDocSerializer.HTMLDOC_style
public final Set<String> getStylesheet()
HtmlDocSerializer.HTMLDOC_stylesheet
public final Set<String> getScript()
HtmlDocSerializer.HTMLDOC_script
public final String[] getNavlinks()
HtmlDocSerializer.HTMLDOC_navlinks
public final String[] getHead()
HtmlDocSerializer.HTMLDOC_head
public final String[] getHeader()
HtmlDocSerializer.HTMLDOC_header
public final String[] getNav()
HtmlDocSerializer.HTMLDOC_nav
public final String[] getAside()
HtmlDocSerializer.HTMLDOC_aside
public final String[] getFooter()
HtmlDocSerializer.HTMLDOC_footer
public final String getNoResultsMessage()
HtmlDocSerializer.HTMLDOC_noResultsMessage
public final boolean isNowrap()
HtmlDocSerializer.HTMLDOC_nowrap
public final HtmlDocTemplate getTemplate()
HtmlDocSerializer.HTMLDOC_template
@Deprecated public final boolean isNoWrap()
Copyright © 2018 Apache. All rights reserved.