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 StringReturn 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, ornullif transfer is not supported.intConvenience API forgetMaxCharacters()returning an integer value.voidsetEnableImport(YesNo enableImport) Sets if the button for importing CF_HTML content is enabledvoidsetImportRuleset(String importRuleset) Sets the available CF_HTML to DOM import rule setsvoidsetMaxCharacters(PositiveInteger maxCharacters) Sets the maximum number of characters allowed for inputvoidSets if the button for creating tables is enabledbooleanShow the button for importing CF_HTML content.booleanConvenience 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, widthMethods 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, verifyMethods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfigurationMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:AbstractGomElementReturn the default tag for a gom element.- Specified by:
getDefaultTagin 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:
getEnableImportin 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:
setEnableImportin 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:
getImportRulesetin 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:
setImportRulesetin classAbstractGomDom- Parameters:
importRuleset- a comma separated list of the available ruleset definitions.- Since:
- 4.2
-
getTransferTypes
Description copied from interface:GomTransferHandlingReturns a list of supportedTransferType's, ornullif transfer is not supported.- Specified by:
getTransferTypesin 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:
showsEnableImportin classAbstractGomDom- Returns:
trueif enabled, otherwisefalse- Since:
- 4.2
-