Class GomDomTable
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.GomDomTable
- All Implemented Interfaces:
GomCheckable
,GomElement
,GomFormatProvider
,GomFormElement
,GomHideable
,GomLangInfoProvider
,GomLinkEditorProvider
,GomSearchRelevancy
,ImportEnabling
,LineBreakable
,Serializable
GOM implementation of DOM Table
- Since:
- 2.1
- 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 TypeMethodDescriptionIndicates if the editor is allowed to change the number of columnsIndicates if the editor is allowed to merge cellsprotected String
Return the default tag for a gom element.Get the editor state for importing CF_HTML content. requires the FirstSpirit-Office module.Height of table in rowsIndicates if the button for importing from MS Word (R) is enabledGet a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.Indicates if the editor is allowed to change cell propertiesExtends property dialog for the given parameter definitionsIndicates if the editor is allowed to change the number of rowsint
height()
Convenience API forgetHeight()
returning an integer valuevoid
setColumnChange
(YesNo columnchange) Sets if the editor is allowed to change the number of columnsvoid
setCombine
(YesNo combine) Sets if the editor is allowed to merge cellsvoid
setEnableImport
(YesNo enableImport) Enables the button for importing CF_HTML content. requires the FirstSpirit-Office module.void
setHeight
(PositiveInteger height) Sets the height of the table in rowsvoid
Sets if the button for importing from MS Word (R) is enabledvoid
setImportRuleset
(String importRuleset) Defines a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.void
setProperties
(YesNo properties) Sets if the editor is allowed to change cell propertiesvoid
setPropertyConfig
(String propertyconfig) Sets the property config.void
setRowChange
(YesNo rowchange) Sets if the editor is allowed to change the number of rowsboolean
Convenience API forgetColumnChange()
returning a boolean valueboolean
Convenience API forgetCombine()
returning a boolean valueboolean
Show the button for importing CF_HTML content.boolean
Convenience API forAbstractGomDom.getImport()
returning a boolean valueboolean
Convenience API forgetProperties()
returning a boolean valueboolean
Convenience API forgetRowChange()
returning a boolean valueMethods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomDom
formats, getBold, getConvertEntities, getDevelop, getFormats, getItalic, getLinkEditors, getList, getListConfig, getListDefaultConfig, getNoBreak, getRows, getWidth, getWordImport, hasFormats, hasLinkEditors, isImportEnabled, linkEditors, rows, setBold, setDevelop, setItalic, setList, setListConfig, setListDefaultConfig, setRows, setWidth, setWordImport, showsBold, showsDevelop, 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
-
GomDomTable
public GomDomTable()
-
-
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.
-
getColumnChange
Indicates if the editor is allowed to change the number of columns- Since:
- 2.1
-
setColumnChange
Sets if the editor is allowed to change the number of columns- Since:
- 2.1
-
getCombine
Indicates if the editor is allowed to merge cells- Since:
- 2.1
-
setCombine
Sets if the editor is allowed to merge cells- Since:
- 2.1
-
getImport
Description copied from class:AbstractGomDom
Indicates if the button for importing from MS Word (R) is enabled- Overrides:
getImport
in classAbstractGomDom
-
setImport
Description copied from class:AbstractGomDom
Sets if the button for importing from MS Word (R) is enabled- Overrides:
setImport
in classAbstractGomDom
-
getEnableImport
Description copied from class:AbstractGomDom
Get the editor state for importing CF_HTML content. requires the FirstSpirit-Office module.- Overrides:
getEnableImport
in classAbstractGomDom
- Returns:
- YesNo Enable button for importing CF_HTML content.
- Since:
- 4.2
-
setEnableImport
Description copied from class:AbstractGomDom
Enables the button for importing CF_HTML content. requires the FirstSpirit-Office module.- Overrides:
setEnableImport
in classAbstractGomDom
- Parameters:
enableImport
- Enable button for importing CF_HTML content.- Since:
- 4.2
-
getImportRuleset
Description copied from class:AbstractGomDom
Get a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.- Overrides:
getImportRuleset
in classAbstractGomDom
- Returns:
- a comma separated list of the available ruleset.
- Since:
- 4.2
-
setImportRuleset
Description copied from class:AbstractGomDom
Defines a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.- Overrides:
setImportRuleset
in classAbstractGomDom
- Parameters:
importRuleset
- a comma separated list of the available ruleset definitions.- Since:
- 4.2
-
showsImport
public boolean showsImport()Description copied from class:AbstractGomDom
Convenience API forAbstractGomDom.getImport()
returning a boolean value- Overrides:
showsImport
in classAbstractGomDom
-
showsEnableImport
public boolean showsEnableImport()Show the button for importing CF_HTML content.- Overrides:
showsEnableImport
in classAbstractGomDom
- Returns:
true
if enabled, otherwisefalse
- Since:
- 4.2
-
getHeight
Height of table in rows- Since:
- 2.1
-
setHeight
Sets the height of the table in rows- Since:
- 2.1
-
getProperties
Indicates if the editor is allowed to change cell properties- Since:
- 2.1
-
setProperties
Sets if the editor is allowed to change cell properties- Since:
- 2.1
-
getPropertyConfig
Extends property dialog for the given parameter definitions- Since:
- 2.1
-
setPropertyConfig
Sets the property config.- Since:
- 2.1
-
getRowChange
Indicates if the editor is allowed to change the number of rows- Since:
- 2.1
-
setRowChange
Sets if the editor is allowed to change the number of rows- Since:
- 2.1
-
showsRowChange
public boolean showsRowChange()Convenience API forgetRowChange()
returning a boolean value- Since:
- 2.1
-
showsColumnChange
public boolean showsColumnChange()Convenience API forgetColumnChange()
returning a boolean value- Since:
- 2.1
-
showsCombine
public boolean showsCombine()Convenience API forgetCombine()
returning a boolean value- Since:
- 2.1
-
showsProperties
public boolean showsProperties()Convenience API forgetProperties()
returning a boolean value- Since:
- 2.1
-
height
public int height()Convenience API forgetHeight()
returning an integer value- Returns:
- the height of the table as rows or 6 if unset
- Since:
- 4.1.10
-