blob: e39a1ef825f3fff23dc68617e9a5e8a7d027a659 [file] [log] [blame]
<!--
/***************************************************************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
***************************************************************************************************************************/
-->
HTML Serializers
<p>
The {@link oaj.html.HtmlSerializer} class is used to serialize POJOs into HTML.
</p>
<p>
The {@link oaj.html.HtmlDocSerializer} class is the same, but wraps the serialized POJO
inside a document template consisting of header, nav, aside, and footer sections.
</p>
<p>
The HTML serializers provides the following settings:
</p>
<ul class='javatree'>
<li class='link'>{@doc juneau-marshall.ConfigurableProperties.Common Common Properties}
<li class='link'>{@doc juneau-marshall.ConfigurableProperties.CommonSerializer Common Serializer Properties}
<li class='jc'>{@link oaj.html.HtmlSerializer}
<ul>
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_addBeanTypes HTML_addBeanTypes}
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_addKeyValueTableHeaders HTML_addKeyValueTableHeaders}
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_detectLabelParameters HTML_detectLabelParameters}
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_detectLinksInStrings HTML_detectLinksInStrings}
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_labelParameter HTML_labelParameter}
<li class='jf'>{@link oaj.html.HtmlSerializer#HTML_uriAnchorText HTML_uriAnchorText}
</ul>
<li class='jc'>{@link oaj.html.HtmlDocSerializer}
<ul>
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_aside HTMLDOC_aside}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_footer HTMLDOC_footer}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_head HTMLDOC_head}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_header HTMLDOC_header}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_nav HTMLDOC_nav}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_navlinks HTMLDOC_navlinks}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_noResultsMessage HTMLDOC_noResultsMessage}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_nowrap HTMLDOC_nowrap}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_script HTMLDOC_script}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_style HTMLDOC_style}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_stylesheet HTMLDOC_stylesheet}
<li class='jf'>{@link oaj.html.HtmlDocSerializer#HTMLDOC_template HTMLDOC_template}
</ul>
</ul>
<p>
The following pre-configured serializers are provided for convenience:
</p>
<ul class='javatree'>
<li class='jc'>{@link oaj.html.HtmlSerializer}
<ul>
<li class='jf'>{@link oaj.html.HtmlSerializer#DEFAULT }
<li class='jf'>{@link oaj.html.HtmlSerializer#DEFAULT_SQ }
<li class='jf'>{@link oaj.html.HtmlSerializer#DEFAULT_SQ_READABLE }
</ul>
<li class='jc'>{@link oaj.html.HtmlDocSerializer}
<ul>
<li class='jf'>{@link oaj.html.HtmlDocSerializer#DEFAULT }
</ul>
</ul>