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.
|
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 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. |
getAnchorText, getHtmlWriter, getLabelParameter, getUriAnchorText, 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
protected final Set<String> getStyle()
HtmlDocSerializer.HTMLDOC_style
protected final Set<String> getStylesheet()
HtmlDocSerializer.HTMLDOC_stylesheet
protected final Set<String> getScript()
HtmlDocSerializer.HTMLDOC_script
protected final String[] getNavlinks()
HtmlDocSerializer.HTMLDOC_navlinks
protected final String[] getHead()
HtmlDocSerializer.HTMLDOC_head
protected final String[] getHeader()
HtmlDocSerializer.HTMLDOC_header
protected final String[] getNav()
HtmlDocSerializer.HTMLDOC_nav
protected final String[] getAside()
HtmlDocSerializer.HTMLDOC_aside
protected final String[] getFooter()
HtmlDocSerializer.HTMLDOC_footer
protected final String getNoResultsMessage()
HtmlDocSerializer.HTMLDOC_noResultsMessage
protected final boolean isNowrap()
HtmlDocSerializer.HTMLDOC_nowrap
protected final HtmlDocTemplate getTemplate()
HtmlDocSerializer.HTMLDOC_template
Copyright © 2018 Apache. All rights reserved.