Interface GomElement
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
GomButton.DropMimeType,GomCatalog,GomEditorProvider,GomEmbeddedXml,GomFilterEntry,GomFormElement,GomIncludeConfiguration,GomIndex,GomIndexSource,GomLangInfo,GomLangInfoProvider,GomLangInfos,GomList<T>,GomProjectEntry,GomSingleProjectEntry,TextGomFormElement
- All Known Implementing Classes:
AbstractGomCombobox,AbstractGomContentReferenceElement,AbstractGomDom,AbstractGomElement,AbstractGomFilterEntry,AbstractGomFormElement,AbstractGomGridSelect,AbstractGomLangInfoProvider,AbstractGomList,AbstractGomProjectList,AbstractGomSelect,AbstractGomTableTemplateElement,AbstractGomTextualFormElement,AbstractGomUid,DatasetDataAccessConfiguration,DefaultGomEntryList,DefaultGomLangInfo,DefaultGomLangInfos,GomActivityEntries,GomButton,GomButton.GomDropMimeType,GomButton.GomDropType,GomButton.GomDropTypes,GomButton.GomParams,GomButtonLangInfo,GomButtonLangInfos,GomCategoryEntry,GomCheckbox,GomCombobox,GomComment,GomContentAreaList,GomContentList,GomContentReferenceEntry,GomContentReferenceList,GomDataset,GomDataset.GomLegacyTableTemplateElement,GomDate,GomDateLangInfo,GomDateLangInfos,GomDom,GomDomTable,GomEmbeddedQuery,GomEmbeddedWordImport,GomExpressionLangInfo,GomExpressionLangInfos,GomFile,GomFilterAllowEntry,GomFilterHideEntry,GomFilterList,GomFormatReferenceList,GomGenericParam,GomGroup,GomImageMap,GomIncludeContent,GomIncludeContent.LabelContentSource,GomIncludeOptions,GomIncludeOptions.EmptyConfiguration,GomInnerText,GomInplaceLinkConfig,GomInvalid,GomLabel,GomLabeledNameEntry,GomLabeledValueEntry,GomLabeledValueLangInfo,GomLabelExpressions,GomLabelExpressions.GomLabelExpression,GomLink,GomLinkEditorList,GomLinkList,GomListSelect,GomMediaModeInfos,GomMediaStoreFolder,GomMediaStoreFolderList,GomMediaStoreLocalProjectEntry,GomMediaStoreProjectList,GomMediaStoreRemoteProjectEntry,GomModule,GomMultipleMediaChooser,GomNamedEntry,GomNumber,GomNumberLangInfo,GomNumberLangInfos,GomObjectChooser,GomPageRef,GomParamImpl,GomPermission,GomPicture,GomQuery,GomRadiobutton,GomReference,GomScriptButtonEntry,GomScriptButtons,GomSectionList,GomSiteOrMediaStoreFolder,GomSiteOrMediaStoreFolderList,GomSiteOrMediaStoreLocalProjectEntry,GomSiteOrMediaStoreProjectList,GomSiteOrMediaStoreRemoteProjectEntry,GomStorableLocalProjectEntry,GomStorableProjectList,GomStorableRemoteProjectEntry,GomStoreFolder,GomStoreFolderList,GomTableTemplateUid,GomTableView,GomTableViews,GomTabList,GomTemplateReferenceEntry,GomTemplateReferenceList,GomText,GomTextarea,GomToggle,GomTypeRestrictedTemplates,GomUidEntry,GomValueLangInfos,GomVariableList
Tag for marking a class to implement a GOM element. Requires
two methods to be implemented being used for keeping track of the
GOM TAG-name an instance was created for.
- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionGet the tag name, the instance was produced for.@Nullable GomIncludeConfigurationGet the configuration, if this is an included element.booleanIndicates, that the element has a representation to be displayed in a form.
A representation usually corresponds to a registered editor component.voidsetGomElementTag(@NotNull String name) Sets the tag name, the instance gets produced for.voidsetIncludeConfiguration(@Nullable GomIncludeConfiguration configuration) Set the configuration for an included element.
-
Method Details
-
setGomElementTag
Sets the tag name, the instance gets produced for.- Parameters:
name- The name of the tag.- Since:
- 4.0
-
getGomElementTag
String getGomElementTag()Get the tag name, the instance was produced for.- Returns:
- The name of the tag.
- Since:
- 4.0
-
getIncludeConfiguration
Get the configuration, if this is an included element.- Returns:
- The configuration for including the element.
- Since:
- 4.0
-
setIncludeConfiguration
Set the configuration for an included element.- Parameters:
configuration- The configuration to set.- Since:
- 4.0
-
hasRepresentation
boolean hasRepresentation()Indicates, that the element has a representation to be displayed in a form.
A representation usually corresponds to a registered editor component.- Returns:
true, if a representation is available.- Since:
- 4.1.10
-