Module com.aoapps.html

Package com.aoapps.html

Class Document

java.lang.Object

com.aoapps.html.any.AnyDocument<Document>

com.aoapps.html.Document

All Implemented Interfaces:

Encode, Text, Whitespace, AnyCOLGROUP_content<Document,Document>, AnyContent<Document,Document>, AnyDATALIST_content<Document,Document>, AnyDIV_content<Document,Document>, AnyDL_content<Document,Document>, AnyEmbeddedContent<Document,Document>, AnyFlowContent<Document,Document>, AnyHeadingContent<Document,Document>, AnyHTML_content<Document,Document>, AnyInteractiveContent<Document,Document>, AnyListContent<Document,Document>, AnyMetadataContent<Document,Document>, AnyOBJECT_content<Document,Document>, AnyOPTGROUP_content<Document,Document>, AnyPalpableContent<Document,Document>, AnyPhrasingContent<Document,Document>, AnyScriptSupportingContent<Document,Document>, AnySectioningContent<Document,Document>, AnySELECT_content<Document,Document>, AnyTABLE_content<Document,Document>, AnyTextContent<Document,Document>, AnyTR_content<Document,Document>, AnyUnion_COLGROUP_ScriptSupporting<Document,Document>, AnyUnion_DATALIST_OPTGROUP<Document,Document>, AnyUnion_DIV_DL<Document,Document>, AnyUnion_DL_Palpable<Document,Document>, AnyUnion_Embedded_Interactive<Document,Document>, AnyUnion_Embedded_Palpable_Phrasing<Document,Document>, AnyUnion_Interactive_Phrasing<Document,Document>, AnyUnion_Metadata_Phrasing<Document,Document>, AnyUnion_Palpable_Phrasing<Document,Document>, AnyUnion_TBODY_THEAD_TFOOT<Document,Document>, Content<Document,Document>, DocumentWriter, AnyContent<Document>, COLGROUP_content<Document>, Content<Document>, DATALIST_content<Document>, DIV_content<Document>, DL_content<Document>, EmbeddedContent<Document>, FlowContent<Document>, HeadingContent<Document>, HTML_content<Document>, InteractiveContent<Document>, ListContent<Document>, MetadataContent<Document>, OBJECT_content<Document>, OPTGROUP_content<Document>, PalpableContent<Document>, PhrasingContent<Document>, ScriptSupportingContent<Document>, SectioningContent<Document>, SELECT_content<Document>, TABLE_content<Document>, TextContent<Document>, TR_content<Document>, Union_COLGROUP_ScriptSupporting<Document>, Union_DATALIST_OPTGROUP<Document>, Union_DIV_DL<Document>, Union_DL_Palpable<Document>, Union_Embedded_Interactive<Document>, Union_Embedded_Palpable_Phrasing<Document>, Union_Interactive_Phrasing<Document>, Union_Metadata_Phrasing<Document>, Union_Palpable_Phrasing<Document>, Union_TBODY_THEAD_TFOOT<Document>

public final class Document
extends AnyDocument<Document>
implements AnyContent<Document>

Fluent Java DSL for high-performance HTML generation.

This class implements all content interfaces and supports all element types.

See also HtmlFlow.

Author:

AO Industries, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.aoapps.html.any.AnyUnion_Interactive_Phrasing

AnyUnion_Interactive_Phrasing.InputFactory<D extends AnyDocument<D>,__ extends AnyUnion_Interactive_Phrasing<D,__>>

Nested classes/interfaces inherited from interface com.aoapps.html.Union_Interactive_Phrasing

Union_Interactive_Phrasing.InputFactory<__ extends Union_Interactive_Phrasing<__>>

Field Summary

Fields inherited from class com.aoapps.html.any.AnyDocument

ENCODING, encodingContext

Fields inherited from interface com.aoapps.encoding.Text

NBSP

Fields inherited from interface com.aoapps.encoding.Whitespace

INDENT_SPACES, NL, SPACE

Constructor Summary

Constructors

Constructor	Description
Document(ChainWriter out)	Unwraps the given chain writer.
Document(EncodingContext encodingContext, Writer out)
Document(Serialization serialization, Doctype doctype, Charset characterEncoding, Writer out)
Document(Writer out)

Method Summary

Methods inherited from class com.aoapps.html.any.AnyDocument

autoIndent, autoIndent, autoNl, autoNli, autoNli, clearAtnl, decDepth, doctype, encode, encode, encode, encode, encode, encode, encode, encode, encode, getAtnl, getAutonli, getDepth, getDocument, getIndent, getRawUnsafe, getRawUnsafe, incDepth, indent, indent, nbsp, nbsp, nl, nli, nli, setAtnl, setAtnl, setAutonli, setDepth, setIndent, setOut, sp, sp, text, text, text, text, text, text, text, text, text, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, xmlDeclaration

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aoapps.html.any.AnyContent

figcaption, html__, html__, html__any, legend, rp, rt, source, summary, tr__, tr__, tr__any, track

Methods inherited from interface com.aoapps.html.AnyContent

html, html__, html_c, tr, tr__, tr_c

Methods inherited from interface com.aoapps.html.any.AnyEmbeddedContent

picture

Methods inherited from interface com.aoapps.html.any.AnyFlowContent

dialog, hr__

Methods inherited from interface com.aoapps.html.any.AnyHeadingContent

h, h__, h__, h__, h__, h_c, h1__, h1__, h1__, h1__any, h2__, h2__, h2__, h2__any, h3__, h3__, h3__, h3__any, h4__, h4__, h4__, h4__any, h5__, h5__, h5__, h5__any, h6__, h6__, h6__, h6__any, hgroup

Methods inherited from interface com.aoapps.html.any.AnyHTML_content

body__, body__, body__any, head__, head__, head__any

Methods inherited from interface com.aoapps.html.any.AnyInteractiveContent

details, menu__, menu__, menu__any

Methods inherited from interface com.aoapps.html.any.AnyListContent

li__, li__, li__, li__any

Methods inherited from interface com.aoapps.html.any.AnyMetadataContent

base__, title__, title__, title__any

Methods inherited from interface com.aoapps.html.any.AnyOBJECT_content

param__

Methods inherited from interface com.aoapps.html.any.AnyPalpableContent

address__, address__, address__, address__any, blockquote__, blockquote__, blockquote__, blockquote__any, dl__, dl__, dl__any, fieldset, figure, footer__, footer__, footer__, footer__any, form__, form__, form__, form__any, header__, header__, header__, header__any, main__, main__, main__, main__any, ol__, ol__, ol__any, p__, p__, p__, p__any, pre__, pre__, pre__, pre__any, table__, table__, table__any, ul__, ul__, ul__any

Methods inherited from interface com.aoapps.html.any.AnyPhrasingContent

br__, datalist__, datalist__, datalist__, datalist__any, del__, del__, del__, slot, wbr__

Methods inherited from interface com.aoapps.html.any.AnySectioningContent

article__, article__, article__, article__any, aside__, aside__, aside__, aside__any, nav__, nav__, nav__, nav__any, section__, section__, section__, section__any

Methods inherited from interface com.aoapps.html.any.AnySELECT_content

optgroup__, optgroup__, optgroup__any

Methods inherited from interface com.aoapps.html.any.AnyTABLE_content

caption__, caption__, caption__, caption__any, colgroup__, colgroup__, colgroup__any, tbody__, tbody__, tbody__any, tfoot__, tfoot__, tfoot__any, thead__, thead__, thead__any

Methods inherited from interface com.aoapps.html.any.AnyTextContent

decDepth, encode, encode, encode, encode, encode, encode, encode, encode, encode, incDepth, indent, indent, nbsp, nbsp, nl, nli, nli, setDepth, setIndent, sp, sp, text, text, text, text, text, text, text, text, text

Methods inherited from interface com.aoapps.html.any.AnyTR_content

td__, td__, td__, td__any, th__, th__, th__, th__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_COLGROUP_ScriptSupporting

template

Methods inherited from interface com.aoapps.html.any.AnyUnion_DATALIST_OPTGROUP

option__, option__, option__, option__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_DIV_DL

dd__, dd__, dd__, dd__any, dt__, dt__, dt__, dt__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_DL_Palpable

div__, div__, div__, div__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_Embedded_Interactive

audio, embed, iframe, object__, object__, object__any, video

Methods inherited from interface com.aoapps.html.any.AnyUnion_Embedded_Palpable_Phrasing

canvas

Methods inherited from interface com.aoapps.html.any.AnyUnion_Interactive_Phrasing

a__, a__, a__, a__, button, label__, label__, label__, label__any, select__, select__, select__any, textarea__, textarea__, textarea__, textarea__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_Metadata_Phrasing

noscript

Methods inherited from interface com.aoapps.html.any.AnyUnion_Palpable_Phrasing

abbr__, abbr__, abbr__, abbr__any, b__, b__, b__, b__any, bdi__, bdi__, bdi__, bdi__any, bdo__, bdo__, bdo__, bdo__any, cite__, cite__, cite__, cite__any, code__, code__, code__, code__any, data__, data__, data__, data__any, dfn__, dfn__, dfn__, dfn__any, em__, em__, em__, em__any, i__, i__, i__, i__any, ins__, ins__, ins__, ins__, kbd__, kbd__, kbd__, kbd__any, map__, map__, map__, map__, mark__, mark__, mark__, mark__any, meter__, meter__, meter__, meter__any, output__, output__, output__, output__any, progress__, progress__, progress__, progress__any, q__, q__, q__, q__any, ruby, s__, s__, s__, s__any, samp__, samp__, samp__, samp__any, small__, small__, small__, small__any, span__, span__, span__, span__any, strong__, strong__, strong__, strong__any, sub__, sub__, sub__, sub__any, sup__, sup__, sup__, sup__any, time, u__, u__, u__, u__any, var__, var__, var__, var__any

Methods inherited from interface com.aoapps.html.COLGROUP_content

col

Methods inherited from interface com.aoapps.html.any.Content

autoIndent, autoIndent, autoNl, autoNli, autoNli, clearAtnl, getAtnl, getAutonli, getDepth, getDocument, getIndent, getRawUnsafe, getRawUnsafe, setAtnl, setAtnl, setAutonli, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe

Methods inherited from interface com.aoapps.html.FlowContent

hr

Methods inherited from interface com.aoapps.html.HeadingContent

h1, h1__, h1_c, h2, h2__, h2_c, h3, h3__, h3_c, h4, h4__, h4_c, h5, h5__, h5_c, h6, h6__, h6_c

Methods inherited from interface com.aoapps.html.HTML_content

body, body__, body_c, head, head__, head_c

Methods inherited from interface com.aoapps.html.InteractiveContent

menu, menu__, menu_c

Methods inherited from interface com.aoapps.html.ListContent

li, li__, li_c

Methods inherited from interface com.aoapps.html.MetadataContent

base, style, style, style, style, style, title, title__, title_c

Methods inherited from interface com.aoapps.html.OBJECT_content

param

Methods inherited from interface com.aoapps.html.PalpableContent

address, address__, address_c, blockquote, blockquote__, blockquote_c, dl, dl__, dl_c, footer, footer__, footer_c, form, form, form, form__, form_c, header, header__, header_c, main, main__, main_c, ol, ol__, ol_c, p, p__, p_c, pre, pre__, pre_c, table, table__, table_c, ul, ul__, ul_c

Methods inherited from interface com.aoapps.html.PhrasingContent

area, area, area, area, area, area, area, area, area, br, datalist, datalist__, datalist_c, del, del_c, wbr

Methods inherited from interface com.aoapps.html.ScriptSupportingContent

script, script, script, script, script

Methods inherited from interface com.aoapps.html.SectioningContent

article, article__, article_c, aside, aside__, aside_c, nav, nav__, nav_c, section, section__, section_c

Methods inherited from interface com.aoapps.html.SELECT_content

optgroup, optgroup__, optgroup_c

Methods inherited from interface com.aoapps.html.TABLE_content

caption, caption__, caption_c, colgroup, colgroup__, colgroup_c, tbody, tbody__, tbody_c, tfoot, tfoot__, tfoot_c, thead, thead__, thead_c

Methods inherited from interface com.aoapps.html.TR_content

td, td__, td_c, th, th__, th_c

Methods inherited from interface com.aoapps.html.Union_DATALIST_OPTGROUP

option, option__, option_c

Methods inherited from interface com.aoapps.html.Union_DIV_DL

dd, dd__, dd_c, dt, dt__, dt_c

Methods inherited from interface com.aoapps.html.Union_DL_Palpable

div, div__, div_c

Methods inherited from interface com.aoapps.html.Union_Embedded_Interactive

img, img, img, object, object__, object_c

Methods inherited from interface com.aoapps.html.Union_Interactive_Phrasing

a, a, a, a_c, input, label, label__, label_c, select, select__, select_c, textarea, textarea__, textarea_c

Methods inherited from interface com.aoapps.html.Union_Metadata_Phrasing

link, link, meta

Methods inherited from interface com.aoapps.html.Union_Palpable_Phrasing

abbr, abbr__, abbr_c, b, b__, b_c, bdi, bdi__, bdi_c, bdo, bdo, bdo, bdo, bdo, bdo__, bdo_c, cite, cite__, cite_c, code, code__, code_c, data, data, data, data__, data_c, dfn, dfn__, dfn_c, em, em__, em_c, i, i__, i_c, ins, ins_c, kbd, kbd__, kbd_c, map, map, map, map_c, mark, mark__, mark_c, meter, meter__, meter_c, output, output__, output_c, progress, progress__, progress_c, q, q__, q_c, s, s__, s_c, samp, samp__, samp_c, small, small__, small_c, span, span__, span_c, strong, strong__, strong_c, sub, sub__, sub_c, sup, sup__, sup_c, u, u__, u_c, var, var__, var_c

Constructor Details

Document

public Document(EncodingContext encodingContext,
 Writer out)

Parameters:

out - May be null, but must be set to a non-null value again before any additional writes. Not doing so may result in IllegalStateException.

Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

See Also:

• AnyDocument.setOut(java.io.Writer)

Document

public Document(Serialization serialization,
 Doctype doctype,
 Charset characterEncoding,
 Writer out)

Parameters:

out - May be null, but must be set to a non-null value again before any additional writes. Not doing so may result in IllegalStateException.

Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

See Also:

• AnyDocument.setOut(java.io.Writer)

Document

public Document(Writer out)

Parameters:

out - May be null, but must be set to a non-null value again before any additional writes. Not doing so may result in IllegalStateException.

Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

See Also:

• AnyDocument.setOut(java.io.Writer)
• EncodingContext.DEFAULT

Document

public Document(ChainWriter out)

Unwraps the given chain writer.

Parameters:

out - After being unwrapped, will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.