Class GomDom
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
de.espirit.firstspirit.access.store.templatestore.gom.GomDom
- All Implemented Interfaces:
GomCheckable
,GomElement
,GomFormatProvider
,GomFormElement
,GomHideable
,GomLangInfoProvider
,GomLinkEditorProvider
,GomSearchRelevancy
,GomTransferHandling
,ImportEnabling
,LineBreakable
,Serializable
GOM element implementation for DOM.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable
GomCheckable.Context
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
Return the default tag for a gom element.Indicates if the button for importing CF_HTML content is enabledList of the available CF_HTML to DOM import rule sets. an empty definition gets all in the module available rule sets.Maximum number of characters allowed for inputgetTable()
Indicates if the button for creating tables is enabled@Nullable List<TransferType<?>>
getTransferTypes
(SpecialistsBroker broker) Returns a list of supportedTransferType
's, ornull
if transfer is not supported.int
Convenience API forgetMaxCharacters()
returning an integer value.void
setEnableImport
(YesNo enableImport) Sets if the button for importing CF_HTML content is enabledvoid
setImportRuleset
(String importRuleset) Sets the available CF_HTML to DOM import rule setsvoid
setMaxCharacters
(PositiveInteger maxCharacters) Sets the maximum number of characters allowed for inputvoid
Sets if the button for creating tables is enabledboolean
Show the button for importing CF_HTML content.boolean
Convenience API forgetTable()
returning a boolean valueMethods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomDom
formats, getBold, getConvertEntities, getDevelop, getFormats, getImport, getItalic, getLinkEditors, getList, getListConfig, getListDefaultConfig, getNoBreak, getRows, getWidth, getWordImport, hasFormats, hasLinkEditors, isImportEnabled, linkEditors, rows, setBold, setDevelop, setImport, setItalic, setList, setListConfig, setListDefaultConfig, setRows, setWidth, setWordImport, showsBold, showsDevelop, showsImport, showsItalic, showsList, validate, width
Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, verify
Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
-
Field Details
-
TAG
The tag of this component- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
GomDom
public GomDom()
-
-
Method Details
-
getDefaultTag
Description copied from class:AbstractGomElement
Return the default tag for a gom element.- Specified by:
getDefaultTag
in classAbstractGomElement
- Returns:
- The elements default tag.
-
getMaxCharacters
Maximum number of characters allowed for input- Since:
- 3.0
-
setMaxCharacters
Sets the maximum number of characters allowed for input- Since:
- 3.0
-
getTable
Indicates if the button for creating tables is enabled- Since:
- 4.0.120
-
setTable
Sets if the button for creating tables is enabled- Since:
- 4.0.120
-
getEnableImport
Indicates if the button for importing CF_HTML content is enabled- Overrides:
getEnableImport
in classAbstractGomDom
- Returns:
- YesNo Enable button for importing CF_HTML content.
- Since:
- 4.2
-
setEnableImport
Sets if the button for importing CF_HTML content is enabled- Overrides:
setEnableImport
in classAbstractGomDom
- Parameters:
enableImport
- Enable button for importing CF_HTML content.- Since:
- 4.2
-
getImportRuleset
List of the available CF_HTML to DOM import rule sets. an empty definition gets all in the module available rule sets.- Overrides:
getImportRuleset
in classAbstractGomDom
- Returns:
- a comma separated list of the available ruleset.
- Since:
- 4.2
-
setImportRuleset
Sets the available CF_HTML to DOM import rule sets- Overrides:
setImportRuleset
in classAbstractGomDom
- Parameters:
importRuleset
- a comma separated list of the available ruleset definitions.- Since:
- 4.2
-
getTransferTypes
Description copied from interface:GomTransferHandling
Returns a list of supportedTransferType
's, ornull
if transfer is not supported.- Specified by:
getTransferTypes
in interfaceGomTransferHandling
- Parameters:
broker
- Broker for requesting services or providers.- Returns:
- supported transfer types, or
null
.
-
maxCharacters
public int maxCharacters()Convenience API forgetMaxCharacters()
returning an integer value.- Returns:
- the maximum number of characters allowed for input or -1 if unset
- Since:
- 3.0
-
showsTable
public boolean showsTable()Convenience API forgetTable()
returning a boolean value- Since:
- 4.0.120
-
showsEnableImport
public boolean showsEnableImport()Show the button for importing CF_HTML content.- Overrides:
showsEnableImport
in classAbstractGomDom
- Returns:
true
if enabled, otherwisefalse
- Since:
- 4.2
-