org.ujorm.tools.xml.config.impl

Class DefaultHtmlConfig

java.lang.Object

org.ujorm.tools.xml.config.impl.DefaultXmlConfig

org.ujorm.tools.xml.config.impl.DefaultHtmlConfig

All Implemented Interfaces:

HtmlConfig, XmlConfig

public class DefaultHtmlConfig
extends DefaultXmlConfig
implements HtmlConfig

Configuraion of HtmlPage

Author:

Pavel Ponec

Field Summary

Fields inherited from class org.ujorm.tools.xml.config.impl.DefaultXmlConfig

DEFAULT_FIRST_LEVEL, DEFAULT_INTENDATION, DEFAULT_NEW_LINE, doctype, EMPTY, REQUIRED_MSG

Constructor Summary

Constructors

Constructor and Description
DefaultHtmlConfig()
DefaultHtmlConfig(@NotNull HtmlConfig htmlConfig)

Method Summary

Modifier and Type	Method and Description
@NotNull String	getContentType() Get a content type where a recommended value is "text/html"
CharSequence[]	getCssLinks() CSS links of a HTML page
@NotNull CharSequence	getDoctype() A header declaration of the document or a doctype
@NotNull ApiInjector	getHeaderInjector() Return a header injector
@NotNull Optional<CharSequence>	getLanguage() Language of a HTML page
CharSequence	getRawHeaderText() A raw text for HTML header
String	getRootElementName() A name of root element
@NotNull CharSequence	getTitle() Title is a required element by HTML 5
boolean	isDocumentObjectModel() Build a real model or a plain writer, the default value is false
boolean	isHtmlHeaderRequest() A request to generate a minimal HTML header
DefaultHtmlConfig	setContentType(@NotNull String contentType)
DefaultHtmlConfig	setCssLinks(CharSequence... cssLinks)
DefaultHtmlConfig	setDocumentObjectModel(boolean buildDom) Build a real model or a plain writer, the default value is false
void	setDom(boolean buildDom) Deprecated. Use the method setDocumentObjectModel(boolean).
DefaultHtmlConfig	setHeaderInjector(@NotNull ApiInjector headerInjector) Assign a new header injector
DefaultHtmlConfig	setHtmlHeader(boolean htmlHeaderRequest) A request to generate a minimal HTML header
DefaultHtmlConfig	setLanguage(@NotNull CharSequence language)
DefaultHtmlConfig	setRawHedaderCode(@Nullable String rawHeaderText) Deprecated.
DefaultHtmlConfig	setRootElementName(@Nullable String rootElementName) The element name must not be special HTML characters.
DefaultHtmlConfig	setTitle(@NotNull CharSequence title) Title is a required element by HTML 5

Methods inherited from class org.ujorm.tools.xml.config.impl.DefaultXmlConfig

getDefaultValue, getFirstLevel, getFormatter, getCharset, getIndentation, getNewLine, isCacheAllowed, nonnull, setCacheAllowed, setCompressedFormat, setDefaultValue, setDoctype, setFirstLevel, setFormatter, setCharset, setIndentationSpace, setNewLine, setNiceFormat, setNiceFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ujorm.tools.xml.config.HtmlConfig

cloneForAjax, of, ofDefault, ofElement, ofElementName, ofEmptyElement, ofTitle

Methods inherited from interface org.ujorm.tools.xml.config.XmlConfig

getDefaultValue, getFirstLevel, getFormatter, getCharset, getIndentation, getNewLine, isCacheAllowed, ofDoctype

Constructor Detail

DefaultHtmlConfig

public DefaultHtmlConfig()

DefaultHtmlConfig

public DefaultHtmlConfig(@NotNull
                         @NotNull HtmlConfig htmlConfig)

Method Detail

getDoctype

@NotNull
public @NotNull CharSequence getDoctype()

Description copied from class: DefaultXmlConfig

A header declaration of the document or a doctype

Specified by:

getDoctype in interface XmlConfig

Overrides:

getDoctype in class DefaultXmlConfig

getTitle

@NotNull
public @NotNull CharSequence getTitle()

Description copied from interface: HtmlConfig

Title is a required element by HTML 5

Specified by:

getTitle in interface HtmlConfig

getCssLinks

public CharSequence[] getCssLinks()

Description copied from interface: HtmlConfig

CSS links of a HTML page

Specified by:

getCssLinks in interface HtmlConfig

getLanguage

@NotNull
public @NotNull Optional<CharSequence> getLanguage()

Description copied from interface: HtmlConfig

Language of a HTML page

Specified by:

getLanguage in interface HtmlConfig

getContentType

@NotNull
public @NotNull String getContentType()

Description copied from interface: HtmlConfig

Get a content type where a recommended value is "text/html"

Specified by:

getContentType in interface HtmlConfig

isDocumentObjectModel

public boolean isDocumentObjectModel()

Build a real model or a plain writer, the default value is false

Specified by:

isDocumentObjectModel in interface HtmlConfig

isHtmlHeaderRequest

public boolean isHtmlHeaderRequest()

A request to generate a minimal HTML header

Specified by:

isHtmlHeaderRequest in interface HtmlConfig

getRawHeaderText

public CharSequence getRawHeaderText()

A raw text for HTML header

Specified by:

getRawHeaderText in interface HtmlConfig

getHeaderInjector

@NotNull
public @NotNull ApiInjector getHeaderInjector()

Return a header injector

Specified by:

getHeaderInjector in interface HtmlConfig

getRootElementName

public String getRootElementName()

A name of root element

Specified by:

getRootElementName in interface HtmlConfig

setTitle

public DefaultHtmlConfig setTitle(@NotNull
                                  @NotNull CharSequence title)

Title is a required element by HTML 5

setCssLinks

public DefaultHtmlConfig setCssLinks(@NotNull
                                     CharSequence... cssLinks)

setLanguage

public DefaultHtmlConfig setLanguage(@NotNull
                                     @NotNull CharSequence language)

setContentType

public DefaultHtmlConfig setContentType(@NotNull
                                        @NotNull String contentType)

setDom

@Deprecated
public void setDom(boolean buildDom)

Deprecated. Use the method setDocumentObjectModel(boolean).

Build a real model or a plain writer, the default value is false.

setDocumentObjectModel

public DefaultHtmlConfig setDocumentObjectModel(boolean buildDom)

Build a real model or a plain writer, the default value is false

setHtmlHeader

public DefaultHtmlConfig setHtmlHeader(boolean htmlHeaderRequest)

A request to generate a minimal HTML header

setRootElementName

public DefaultHtmlConfig setRootElementName(@Nullable
                                            @Nullable String rootElementName)

The element name must not be special HTML characters. The null value is intended to build a root of AJAX queries.

setRawHedaderCode

@Deprecated
public DefaultHtmlConfig setRawHedaderCode(@Nullable
                                                       @Nullable String rawHeaderText)

Deprecated.

Use the setHeaderInjector(org.ujorm.tools.xml.config.ApiInjector) method rather.

Parameters:

rawHeaderText -

Returns:

setHeaderInjector

public DefaultHtmlConfig setHeaderInjector(@NotNull
                                           @NotNull ApiInjector headerInjector)

Assign a new header injector