Package de.espirit.firstspirit.access.store.templatestore.gom

Class AbstractGomDom

java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomDom
All Implemented Interfaces:
GomCheckable, GomElement, GomFormatProvider, GomFormElement, GomHideable, GomLangInfoProvider, GomLinkEditorProvider, GomSearchRelevancy, ImportEnabling, LineBreakable, Serializable
Direct Known Subclasses:
GomDom, GomDomTable
@NonExtendable public abstract class AbstractGomDom extends AbstractGomFormElement implements GomLinkEditorProvider, GomFormatProvider, ImportEnabling
Abstract base implementation for DOM
Since:
4.1.10
See Also:

  • Constructor Details

    • AbstractGomDom

      public AbstractGomDom()

  • Method Details

    • getBold

      public YesNo getBold()
      Indicates if the button for setting bold text is enabled
      Since:
      2.0

    • setBold

      public void setBold(YesNo bold)
      Enables or disables the button for setting bold text
      Since:
      2.0

    • getImport

      @Deprecated(since="4.1.10") public YesNo getImport()
      Deprecated.
      since 4.1.10 - no replacement
      Indicates if the button for importing from MS Word (R) is enabled
      Since:
      2.1

    • setImport

      @Deprecated(since="4.1.10") public void setImport(YesNo import1)
      Deprecated.
      since 4.1.10 - no replacement
      Sets if the button for importing from MS Word (R) is enabled
      Since:
      2.1

    • getEnableImport

      public YesNo getEnableImport()
      Get the editor state for importing CF_HTML content. requires the FirstSpirit-Office module.
      Returns:
      YesNo Enable button for importing CF_HTML content.
      Since:
      4.2

    • setEnableImport

      public void setEnableImport(YesNo enableImport)
      Enables the button for importing CF_HTML content. requires the FirstSpirit-Office module.
      Parameters:
      enableImport - Enable button for importing CF_HTML content.
      Since:
      4.2

    • getImportRuleset

      public String getImportRuleset()
      Get a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.
      Returns:
      a comma separated list of the available ruleset.
      Since:
      4.2

    • setImportRuleset

      public void setImportRuleset(String importRuleset)
      Defines a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.
      Parameters:
      importRuleset - a comma separated list of the available ruleset definitions.
      Since:
      4.2

    • getDevelop

      public YesNo getDevelop()
      Indicates if debug mode using Java-Console for output is enabled
      Since:
      2.1

    • setDevelop

      public void setDevelop(YesNo develop)
      Sets if debug mode using Java-Console for output is enabled
      Since:
      2.0

    • getItalic

      public YesNo getItalic()
      Indicates if the button for setting italic text is enabled
      Since:
      2.0

    • setItalic

      public void setItalic(YesNo italic)
      Enables or disables the button for setting italic text
      Since:
      2.0

    • getList

      public YesNo getList()
      Indicates if the button for creating lists is enabled
      Since:
      2.3

    • setList

      public void setList(YesNo list)
      Enables or disables the button for creating lists
      Since:
      2.3

    • getRows

      public PositiveInteger getRows()
      Height of the form input field in number of rows
      Since:
      2.0

    • setRows

      public void setRows(PositiveInteger rows)
      Sets the height of the form input field in number of rows
      Since:
      2.0

    • getWidth

      public PositiveInteger getWidth()
      Width of the form field area in pixels
      Since:
      2.0

    • setWidth

      public void setWidth(PositiveInteger width)
      Sets the width of the form field area in pixels
      Since:
      2.0

    • getWordImport

      @Deprecated(since="4.1.10") public GomEmbeddedWordImport getWordImport()
      Deprecated.
      since 4.1.10 - no replacement
      Embedded word import definition
      Since:
      4.0

    • setWordImport

      @Deprecated(since="4.1.10") public void setWordImport(GomEmbeddedWordImport wordImport)
      Deprecated.
      since 4.1.10 - no replacement
      Sets the embedded word import definition
      Since:
      4.0

    • getFormats

      public GomFormatReferenceList getFormats()
      Description copied from interface: GomFormatProvider
      List of applicable format templates
      Specified by:
      getFormats in interface GomFormatProvider

    • hasFormats

      public boolean hasFormats()
      Indicates if any format templates are defined.
      Since:
      4.1.10

    • getLinkEditors

      public GomLinkEditorList getLinkEditors()
      Description copied from interface: GomLinkEditorProvider
      List of valid link editors
      Specified by:
      getLinkEditors in interface GomLinkEditorProvider

    • hasLinkEditors

      public boolean hasLinkEditors()
      Indicates if any link editors are defined.
      Since:
      4.1.10

    • getListConfig

      public String getListConfig()
      List configuration dialog definition
      Since:
      2.3

    • setListConfig

      public void setListConfig(String linkConfig)
      Sets the list configuration dialog definition
      Since:
      4.1.10

    • getListDefaultConfig

      public String getListDefaultConfig()
      List variable definitions
      Since:
      2.3

    • setListDefaultConfig

      public void setListDefaultConfig(String linkDefaultConfig)
      Sets the list variable definitions
      Since:
      4.1.10

    • getNoBreak

      public YesNo getNoBreak()
      Description copied from class: AbstractGomFormElement
      Indicates, whether the next form element should follow in the same line as this one.
      Overrides:
      getNoBreak in class AbstractGomFormElement
      Returns:
      YES, to make the next form element follow. Defaults to YesNo.NO.

    • getConvertEntities

      public ConvertEntity getConvertEntities()
      Description copied from class: AbstractGomFormElement
      Provides the mode for entity conversions.
      Overrides:
      getConvertEntities in class AbstractGomFormElement
      Returns:
      The entity conversion mode. Default is none.

    • showsBold

      public boolean showsBold()
      Convenience API for getBold() returning a boolean value
      Since:
      4.1.10

    • showsItalic

      public boolean showsItalic()
      Convenience API for getItalic() returning a boolean value
      Since:
      4.1.10

    • showsList

      public boolean showsList()
      Convenience API for getList() returning a boolean value
      Since:
      4.1.10

    • showsImport

      @Deprecated(since="4.1.10") public boolean showsImport()
      Deprecated.
      since 4.1.10 - no replacement
      Convenience API for getImport() returning a boolean value
      Since:
      4.1.10

    • showsEnableImport

      public boolean showsEnableImport()
      Show the button for importing CF_HTML content.
      Returns:
      true if enabled, otherwise false
      Since:
      4.2

    • isImportEnabled

      public boolean isImportEnabled()
      Description copied from interface: ImportEnabling
      Indicates if importing CF_HTML content is enabled
      Specified by:
      isImportEnabled in interface ImportEnabling

    • showsDevelop

      public boolean showsDevelop()
      Convenience API for getDevelop() returning a boolean value
      Since:
      4.1.10

    • rows

      public int rows()
      Convenience API for getRows() returning an integer value
      Since:
      4.1.10

    • width

      public int width()
      Convenience API for getWidth() returning an integer value
      Since:
      4.1.10

    • formats

      public List<String> formats()
      Description copied from interface: GomFormatProvider
      List of names of applicable format templates
      Specified by:
      formats in interface GomFormatProvider

    • linkEditors

      @NotNull public @NotNull Set<String> linkEditors()
      Return a set of link editor names.
      Specified by:
      linkEditors in interface GomLinkEditorProvider
      Returns:
      The set of names.

    • validate

      public void validate(GomCheckable.Context context) throws GomValidationError
      Description copied from class: AbstractGomFormElement
      Validates the form element's state with respect to the given context. This generic stub does not check anything.
      Specified by:
      validate in interface GomCheckable
      Overrides:
      validate in class AbstractGomFormElement
      Parameters:
      context - The context to validate for.
      Throws:
      GomValidationError - if any requirement is violated.