org.ujorm.tools.xml.config

Interface HtmlConfig

All Superinterfaces:

XmlConfig

All Known Implementing Classes:

DefaultHtmlConfig

public interface HtmlConfig
extends XmlConfig

Configuraion of HtmlPage

Method Summary

Modifier and Type	Method and Description
default DefaultHtmlConfig	cloneForAjax() Clone the config for an AJAX processing
String	getContentType() Get a content type where a recommended value is "text/html"
CharSequence[]	getCssLinks() CSS links of a HTML page
ApiInjector	getHeaderInjector()
Optional<CharSequence>	getLanguage() Language of a HTML page
CharSequence	getRawHeaderText() Deprecated. Use method getHeaderInjector()
String	getRootElementName() A name of root element
CharSequence	getTitle() Title is a required element by HTML 5
boolean	isDocumentObjectModel() Build a real model or a plain writer with a recommended value false
boolean	isHtmlHeaderRequest() A request to generate a minimal HTML header
static DefaultHtmlConfig	of(HtmlConfig htmlConfig) Clone config form another
static DefaultHtmlConfig	ofDefault() Create a new default config
static DefaultHtmlConfig	ofElement(String rootElementName, boolean enabled) No HTML header is generated, no Doctype and no new lines
static DefaultHtmlConfig	ofElementName(String rootElementName) No HTML header is generated, no Doctype and no new lines
static DefaultHtmlConfig	ofEmptyElement() Create a configuration for an AJAX response.

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

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

Method Detail

getTitle

@Nonnull
CharSequence getTitle()

Title is a required element by HTML 5

getCssLinks

@Nonnull
CharSequence[] getCssLinks()

CSS links of a HTML page

getLanguage

@Nonnull
Optional<CharSequence> getLanguage()

Language of a HTML page

getContentType

@Nonnull
String getContentType()

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

isDocumentObjectModel

boolean isDocumentObjectModel()

Build a real model or a plain writer with a recommended value false

isHtmlHeaderRequest

boolean isHtmlHeaderRequest()

A request to generate a minimal HTML header

getRawHeaderText

@Deprecated
 @Nullable
CharSequence getRawHeaderText()

Deprecated. Use method getHeaderInjector()

A raw text for HTML header

getHeaderInjector

@Nonnull
ApiInjector getHeaderInjector()

getRootElementName

String getRootElementName()

A name of root element

cloneForAjax

default DefaultHtmlConfig cloneForAjax()

Clone the config for an AJAX processing

ofDefault

@Nonnull
static DefaultHtmlConfig ofDefault()

Create a new default config

Specified by:

ofDefault in interface XmlConfig

Returns:

ofElementName

@Nonnull
static DefaultHtmlConfig ofElementName(@Nullable
                                                String rootElementName)

No HTML header is generated, no Doctype and no new lines

Parameters:

rootElementName - Element name cannot contain special HTML characters. An undefined value ignores the creation of the root element.

Returns:

ofElement

@Nonnull
static DefaultHtmlConfig ofElement(@Nullable
                                            String rootElementName,
                                            boolean enabled)

No HTML header is generated, no Doctype and no new lines

Parameters:

rootElementName - Element name cannot contain special HTML characters.

enabled - Disabled root element ignores the creation of the root element.

Returns:

ofEmptyElement

@Nonnull
static DefaultHtmlConfig ofEmptyElement()

Create a configuration for an AJAX response.

of

static DefaultHtmlConfig of(@Nonnull
                            HtmlConfig htmlConfig)

Clone config form another