Package org.ujorm.tools.xml.config

Interface HtmlConfig

All Superinterfaces:
XmlConfig
All Known Implementing Classes:
DefaultHtmlConfig
public interface HtmlConfig extends XmlConfig
Configuraion of HtmlPage
Author:
Pavel Ponec

  • Method Details

    • getTitle

      @NotNull @NotNull CharSequence getTitle()
      Title is a required element by HTML 5

    • getCssLinks

      @NotNull @NotNull CharSequence[] getCssLinks()
      CSS links of a HTML page

    • getLanguage

      @NotNull @NotNull Optional<CharSequence> getLanguage()
      Language of a HTML page

    • getContentType

      @NotNull @NotNull 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 @Nullable CharSequence getRawHeaderText()
      Deprecated.
      Use method getHeaderInjector()
      A raw text for HTML header

    • getHeaderInjector

      @NotNull @NotNull ApiInjector getHeaderInjector()

    • getRootElementName

      @NotNull @NotNull String getRootElementName()
      A name of root element

    • getUnpairElements

      @NotNull @NotNull Set<String> getUnpairElements()

    • pairElement

      default boolean pairElement(@NotNull @NotNull ApiElement element)
      Description copied from interface: XmlConfig
      The pair element for termination is required.
      Specified by:
      pairElement in interface XmlConfig

    • cloneForAjax

      default DefaultHtmlConfig cloneForAjax()
      Clone the config for an AJAX processing

    • ofDefault

      @NotNull static @NotNull DefaultHtmlConfig ofDefault()
      Create a new default config
      Returns:

    • ofElementName

      @NotNull static @NotNull DefaultHtmlConfig ofElementName(@Nullable @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

      @NotNull static @NotNull DefaultHtmlConfig ofElement(@Nullable @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

      @NotNull static @NotNull DefaultHtmlConfig ofEmptyElement()
      Create a configuration for an AJAX response.

    • of

      static DefaultHtmlConfig of(@NotNull @NotNull HtmlConfig htmlConfig)
      Clone config form another

    • ofTitle

      static DefaultHtmlConfig ofTitle(@NotNull @NotNull String title)
      Create a new configuration with a nice format by an HTML title.
      Parameters:
      title - If the title is null then create an EMPTY element.