Uses of Annotation Interface
de.espirit.common.GomDoc
Packages that use GomDoc
Package
Description
-
Uses of GomDoc in de.espirit.common.util
Classes in de.espirit.common.util with annotations of type GomDocModifier and TypeClassDescriptionenumEnum providing values to determine the order to be used for sorting. -
Uses of GomDoc in de.espirit.firstspirit.access.store.templatestore.gom
Classes in de.espirit.firstspirit.access.store.templatestore.gom with annotations of type GomDocModifier and TypeClassDescriptionenumMode definitions for entity conversion.enumSwitch for dataset representation style.enumSwitch for setting the dataset selection mode.classPreset mode for datesenumSwitch for setting the date mode of a form.enumSwitch for setting the display mode of a formclassGOM representation of a buttonstatic enumDefines the style of a buttonstatic enumPredefined drop typesclassclassGuiXML element implementation for checkbox.classA GOM element for combo-boxes.classGOM comment definition.classDeprecated.classDeprecated.since 5.0, useGomIndexinsteadclassEntry for identifier lists.classChoose objects from a content store viewclassImplementation of a Gui XML date element.classGOM element implementation for DOM.classGOM implementation of DOM TableclassImplementation of an embedding GOM element for ORMapper Query objectsclassGOM embeddee implementation for word import XML.classDeprecated.since 5.0, use FS_REFERENCE insteadinterfaceDefine filter entries like <ALLOW type='picture'/> <HIDE type='picture'/> to allow or hide(deny) the selection of the specified element filter type.static enumAllow or hide the defined entry.static enumAllowed element selection types.classGOM list implementation for format templates.classOld style parameter definition for link configurations.classGOM implementation for groups.classGOM implementation for image maps.classDeprecated.since 4.2.414 useGomIncludeOptionsinsteadstatic classDeprecated.Content-based source definition for providing a language-dependent labelstatic enumDeprecated.Supported include typesclassGOM definition for inclusion.static final classEmpty configuration.classDefault implementation for a GOM label element.classLanguage info providing named elementclassEntry for defining labeled language information.classDefinitions for providing a language-dependent expressions for producing labelsstatic classSource definition for providing a language-dependent labelinterfaceRoot definition for GOM elements providing specific information of primitive types (attribute-gained data).classGOM element implementation for links.classDeprecated.since 5.0, useGomCataloginsteadclassA GuiXML element implementation for list-based selection.classFolder element for simple folder restrictionsclassEntry describing the local project.classEntry defining a remote project restricted to mediastore useclassDefault GOM module implementation.classMultipleMediaChooser editorclassAn entry for GOM lists with simple, named entries.classGOM implementation for numbers.classDeprecated.since 5.0, use FS_DATASET insteadclassDeprecated.since 5.0, use FS_REFERENCE insteadclassGOM element implementation for permission definitions.classDeprecated.since 5.0, use FS_REFERENCE insteadclassGuiXML element implementation for grid-based selection.classGeneric editor for references based on Uid and UidTypeclassEntry implementation for defining script-based buttons.classGOM element implementation for section lists.classDeprecated.since 5.2.241303 - no replacementclassFolder element for store-based folder restrictionsclassView table view definition parameterized with a name and foreign key attribute nameclassDeprecated.since 5.0, useGomIndexinsteadclassEntry for identifier lists.classGOM implementation for text.classGuiXML implementation for text areas.classField to toggle between on and off stateenumModes for scrolling a group (if necessary)enumTypes for inclusion of value ranges in option editors.final classDefines an extended preset mode for initial value providing editors.enumSwitch for link display mode definition.enumType of mediaenumNumber typesenumSwitch defining the kind of possible referencesclassInterface representing the general gom preset modes.enumEnumeration of options defining a relevancy level.enumSwitch defining the kind of possible section referencesclassDefinition of a table template reference.enumModes for tabulators.enumDisplay mode for text fieldsenumDisplay type for toggle fieldenumOptions for how to treat associations wrt. indexing.enumBoolean enum type for properly named attribute values to switch some option.Methods in de.espirit.firstspirit.access.store.templatestore.gom with annotations of type GomDocModifier and TypeMethodDescription@NotNull GomActivityEntriesGomPermission.getActivities()Activities definitionsAbstractGomContentReferenceElement.getAllowChoose()Indicates if it is allowed to choose existing data entriesGomDataset.getAllowChoose()Indicates if it is allowed to choose existing data entries.GomDataset.getAllowDelete()Indicates if it is allowed to delete entries.GomObjectChooser.getAllowDelete()Deprecated.Indicate if it is allowed to delete entries@Nullable StringGomImageMap.getAllowedEditors()Deprecated.since 4.0 - no replacementGomLink.getAllowedEditors()Deprecated.since 4.0 - no replacementAbstractGomContentReferenceElement.getAllowEdit()Indicates if it is allowed to edit data entriesGomContentList.getAllowEdit()Deprecated.Indicates if it is allowed to edit entriesGomDataset.getAllowEdit()Indicates if it is allowed to edit entries.AbstractGomFormElement.getAllowEmpty()Indicates, whether the form element allows to stay empty.GomFormElement.getAllowEmpty()Indicates, whether leaving the form empty is allowed.GomFile.getAllowFolder()Deprecated.Indicates if folders are allowed as selectionGomMediaModeInfos.getAllowFolders()Indicates whether folders may be selected with media search dialogGomDate.getAllowInput()Indicates if this component allows manual inputGomFile.getAllowLanguageDependentUpload()Deprecated.Indicates if it is allowed to upload language-dependent mediaGomReference.getAllowLanguageDependentUpload()Deprecated.since 5.0 - no replacementAbstractGomContentReferenceElement.getAllowNew()Indicates if it is allowed to create new data entriesGomContentList.getAllowNew()Deprecated.Indicates if it is allowed to add new entriesGomDataset.getAllowNew()Indicates if it is allowed to add new entries.GomTabList.getAllowNew()Deprecated.GomButton.getAlwaysEnabled()Indicates if the button is always enabled or is the form enabled state usedGomMediaStoreRemoteProjectEntry.getAutoReleaseAfterUpload()Indicates if uploaded media is released automaticallyGomSiteOrMediaStoreRemoteProjectEntry.getAutoReleaseAfterUpload()Deprecated.Indicates if an automatic release should be performed after uploading the mediaGomStorableRemoteProjectEntry.getAutoReleaseAfterUpload()Indicates if uploaded media is released automaticallyGomFile.getAutoReleaseRemote()Deprecated.since 4.2.17 - no replacementGomPermission.getAutoSave()Switch to turn auto save on or offAbstractGomDom.getBold()Indicates if the button for setting bold text is enabledGomLabel.getBold()Bold display mode of label@NotNull GomScriptButtonsGomPermission.getButtons()Script button definitionsGomButton.GomDropMimeType.getClassname()Transferable classGomLink.getCms_Link_Config()Deprecated.since 4.0 - no replacementGomInplaceLinkConfig.getCms_Param()Deprecated.since 4.0 - no replacementGomDomTable.getColumnChange()Indicates if the editor is allowed to change the number of columnsGomTextarea.getColumns()Number of columnsGomDomTable.getCombine()Indicates if the editor is allowed to merge cellsAbstractGomFormElement.getConvertEntities()Provides the mode for entity conversions.@NotNull IntegerGomMultipleMediaChooser.getCountPerPage()Count of media rendered on one page (0 = all media on one page)@Nullable StringGomGenericParam.getDefault()Designate the param to act as defaultGomObjectChooser.getDelete()Deprecated.Since 4.2.16.GomTabList.getDelete()Deprecated.Indicates if deleting entries to delete all depending database entries following foreign key relations is enabledGomLangInfo.getDescription()Get the description.AbstractGomDom.getDevelop()Indicates if debug mode using Java-Console for output is enabledGomContentAreaList.getDisplay()Deprecated.since 4.0 - no replacement@NotNull GomButton.GomDropTypesGomButton.getDropTypes()Allowed drop typesGomCombobox.getEditable()Indicates whether the value may be manually editedGomText.getEditable()Indicates if editing is allowedAbstractGomDom.getEnableImport()Get the editor state for importing CF_HTML content. requires the FirstSpirit-Office module.GomDom.getEnableImport()Indicates if the button for importing CF_HTML content is enabledGomDomTable.getEnableImport()AbstractGomSelect.getEntries()GomExpressionLangInfo.getExpression()Expression to be used for producing labels.@NotNull GomFilterListGomReference.getFilter()Project filters for allowed reference types available for selection (selection dialog)GomFile.getFolders()Deprecated.since 4.0 - no replacementGomPageRef.getFolders()Deprecated.since 4.0 - no replacementGomDateLangInfo.getFormat()The format to be used to display datesGomNumberLangInfo.getFormat()Format to be used to display numbersAbstractGomDom.getFormats()GomFormatProvider.getFormats()List of applicable format templatesAbstractGomGridSelect.getGridHeight()Returns the number of options per columnAbstractGomGridSelect.getGridWidth()Returns the number of options per rowGomPermission.getGroup()The permission groupGomDataset.getHeight()Component height in pixels.GomDomTable.getHeight()Height of table in rowsGomGroup.getHeight()Defines the height of the group in Pixels.AbstractGomFormElement.getHFill()Indicates, whether to horizontally fill a form by this form element.GomPageRef.getHFill()Deprecated.AbstractGomFormElement.getHidden()Indicates, whether this form element is visible in the form.GomFormElement.getHidden()Indicates, whether the component will be hidden or shown.@Nullable StringGomGenericParam.getHidden()Designate the param to be hiddenGomToggle.getHideLabel()Defines whether to hide the component's labelGomTextarea.getHtmlMode()Deprecated.since 5.0.35 - no replacement@Nullable StringGomButton.getIcon()Icon, either 'info', 'question', or 'media:[uid]'GomLabeledValueLangInfo.getIgnore()Indicates the value to be ignored for this languageGomDate.getIgnoreFaults()Deprecated.since 4.2.213 - no replacementGomPicture.getImagePreview()Deprecated.Indicates if a thumbnail is shownGomReference.getImagePreview()Indicates if a thumbnail is shownAbstractGomDom.getImport()Deprecated.since 4.1.10 - no replacementGomDomTable.getImport()AbstractGomDom.getImportRuleset()Get a comma separated list of available ruleset definitions. requires the FirstSpirit-Office module.GomDom.getImportRuleset()List of the available CF_HTML to DOM import rule sets. an empty definition gets all in the module available rule sets.GomDomTable.getImportRuleset()GomContentList.getIndexAttribute()Deprecated.Index attribute to persist ordering of entities in a database relationAbstractGomTableTemplateElement.getIndexTreatment()Provides the treatment option for following associations.GomDataset.getIndexTreatment()Provides the treatment option for following associations.GomIndexTreatment.getIndexTreatment()Provides the option defining how to treat following associations.AbstractGomDom.getItalic()Indicates if the button for setting italic text is enabledGomLabel.getItalic()Italic display mode of labelGomIncludeContent.getKey()Deprecated.Optional key providing the entry identifying valueGomTableView.getKey()The foreign key attribute nameAbstractGomFormElement.getLabel()Deprecated.since 4.0.17 originally replaced by LangInfos-Tag, now for hiding in GOM and enable attribute to tag conversion.AbstractGomLangInfoProvider.getLabel()Deprecated.since 4.0.17 originally replaced by LangInfos-Tag, now for hiding in GOM and enable attribute to tag conversion.GomGenericParam.getLabel()The label to be usedGomLangInfo.getLabel()Get the label.GomIncludeOptions.getLabels()Language-dependent expressions for producing labels@NotNull StringGomIncludeContent.LabelContentSource.getLang()@NotNull StringGomLabelExpressions.GomLabelExpression.getLang()GomLangInfo.getLang()Get the language the information is defined for.AbstractGomFormElement.getLangInfos()Provides language dependent information on this form element, like a label and description for multiple languages.GomLangInfoProvider.getLangInfos()Get the container of language information stored for this element.GomPicture.getLean()Deprecated.Defines the form fields to be shownGomDataset.getLegacytemplate()Legacy - reference to table template for conversion from CMS_INPUT_OBJECTCHOOSERAbstractGomCombobox.getLength()Returns the width of the combobox as number of letters@Nullable PositiveIntegerAbstractGomTextualFormElement.getLength()Width of the input form fieldGomDateLangInfo.getLength()The length to be used for inputAbstractGomDom.getLinkEditors()GomImageMap.getLinkEditors()List of link editors valid for this elementGomLinkEditorProvider.getLinkEditors()List of valid link editorsAbstractGomDom.getList()Indicates if the button for creating lists is enabledAbstractGomDom.getListConfig()List configuration dialog definitionAbstractGomDom.getListDefaultConfig()List variable definitionsGomNumber.getMax()Maximum value of the numberGomDom.getMaxCharacters()Maximum number of characters allowed for inputGomContentAreaList.getMaxEntries()Deprecated.Maximum number of sectionsGomContentList.getMaxEntries()Deprecated.Returns the maximum number of selected entriesGomLinkList.getMaxEntries()Deprecated.Maximum number of link entries@Nullable PositiveIntegerAbstractGomTextualFormElement.getMaxInputLength()Maximum number of characters allowed for inputGomMediaModeInfos.getMediaEditor()The actual media editor nameGomContentList.getMediaMode()Deprecated.Media mode information for content listGomPageRef.getMediaStore()Deprecated.Indicates if it is allowed to reference mediaGomMultipleMediaChooser.getMediaTypes()Allowed media typesGomNumber.getMin()Minimum value of the number@Nullable DatasetModeGomDataset.getMode()The dataset representation mode (SiteArchitect only setting)GomDate.getMode()The date/time mode for handling valuesGomLink.getMode()The display modeGomCategoryEntry.getName()The remote project category nameGomContentReferenceEntry.getName()The actual reference nameGomFormElement.getName()Get the name identifying the editor's value.GomGenericParam.getName()Name of the parameterGomGroup.getName()GomInplaceLinkConfig.getName()Name of the configurationGomLabel.getName()GomLabeledNameEntry.getName()The entry's nameGomMediaStoreFolder.getName()The allowed upload folder to set for the defined store nameGomMediaStoreLocalProjectEntry.getName()GomMediaStoreRemoteProjectEntry.getName()GomNamedEntry.getName()Returns the name of this entry.GomParamImpl.getName()Name of parameterGomQuery.getName()Uid of the queryGomSiteOrMediaStoreLocalProjectEntry.getName()Deprecated.The fixed name of the local projectGomSiteOrMediaStoreRemoteProjectEntry.getName()Deprecated.GomStorableLocalProjectEntry.getName()GomStorableRemoteProjectEntry.getName()GomStoreFolder.getName()The allowed upload folder to set for the defined store nameGomTableView.getName()The view's nameGomTemplateReferenceEntry.getName()The actual reference nameAbstractGomFormElement.getNoBreak()Indicates, whether the next form element should follow in the same line as this one.@NotNull DefaultGomLangInfosGomToggle.getOff()Language-dependent information for off state@NotNull DefaultGomLangInfosGomToggle.getOn()Language-dependent information for on state@Nullable GomButtonScriptReferenceGomButton.getOnClick()GomPermission.getOnClick()Name of validation script to be executed on click@Nullable GomButtonScriptReferenceGomButton.getOnDrop()GomPermission.getOnLoad()Name of validation script to be executed on loadGomPermission.getOnSave()Name of validation script to be executed on save@NotNull GomButton.GomParamsGomButton.getParams()Parameters for the executableGomText.getPassword()Mode for displaying the form field contentAbstractGomFormElement.getPreset()Provides the mode for handling preset value for this form element.GomDate.getPreset()GomFormElement.getPreset()Get the mode to be applied for fallback values.GomPermission.getPriority()Permission priorityGomFile.getProjects()Deprecated.GomPageRef.getProjects()Deprecated.GomProjectProvider.getProjects()Projects to be used as sources@NotNull GomStorableProjectListGomReference.getProjects()GomDomTable.getProperties()Indicates if the editor is allowed to change cell propertiesGomDomTable.getPropertyConfig()Extends property dialog for the given parameter definitionsGomContentList.getQuery()Deprecated.A query that determines the contentGomFile.getRemote()Deprecated.since 4.2.5 - no replacementGomFile.getRemoteOnly()Deprecated.since 4.2.5 - no replacementGomFile.getRemoteUploadFolder()Deprecated.since 4.2.5 - no replacement@Nullable StringGomImageMap.getResolution()UID of the resolution that should be usedGomDomTable.getRowChange()Indicates if the editor is allowed to change the number of rowsAbstractGomDom.getRows()Height of the form input field in number of rowsGomContentAreaList.getRows()Deprecated.Height of form element area in rowsGomContentList.getRows()Deprecated.Height of the form are in number of table rowsGomTextarea.getRows()Number of rowsGomButtonLangInfo.getScript()Language dependent script settingGomGroup.getScrollable()Determines whether the group is scrollableAbstractGomFormElement.getSearchRelevancy()Provides the relevancy level of this GOM element's value wrt. indexing.GomSearchRelevancy.getSearchRelevancy()Provides the relevancy level of this GOM element's value wrt. searching.GomPageRef.getSections()Deprecated.Determines which kind of references are allowedGomReference.getSections()Project filters for allowed reference types available for selection (selection dialog)GomDataset.getSelectorMode()The dataset selector mode.GomLink.getShowSnippet()Deprecated.since 5.0 - no replacementGomImageMap.getSimpleMode()Indicates if the functional range is limitedGomCombobox.getSingleLine()Indicates if the component is single-line instead of being framedGomDate.getSingleLine()Indicates if the component is single-line instead of being framedGomText.getSingleLine()Indicates if the component is single-line instead of being framedGomToggle.getSingleLine()Indicates if the component is single-line instead of being framedGomLabel.getSize()Size for displaying the labelAbstractGomSelect.getSortOrder()Returns the order in which display options are displayedGomPageRef.getSortOrder()Deprecated.Describes the sort order for section selection comboboxGomTabList.getSortOrder()Deprecated.Display tabs in the specified order@NotNull GomStoreFolderListGomCategoryEntry.getSources()Restrict access to specific folders (including sub-folders and store roots)GomContentAreaList.getSources()Deprecated.Section templates to choose fromGomDataset.getSources()Content nodes to choose from.GomFile.getSources()Deprecated.since 4.2 - useGomFile.getProjects()GomMediaStoreLocalProjectEntry.getSources()Restrict access to specific mediastore folders (including sub-folders)GomMediaStoreRemoteProjectEntry.getSources()Restrict access to specific folders (including sub-folders)GomPageRef.getSources()Deprecated.since 4.2 - useGomPageRef.getProjects()GomSiteOrMediaStoreLocalProjectEntry.getSources()Deprecated.Restrict access to specific folders (including sub-folders and store roots)GomSiteOrMediaStoreRemoteProjectEntry.getSources()Deprecated.Restrict access to specific folders (including sub-folders and store roots)GomStorableLocalProjectEntry.getSources()Restrict access to specific folders (including sub-folders and store roots)GomStorableRemoteProjectEntry.getSources()Restrict access to specific folders (including sub-folders and store roots)GomMediaStoreFolder.getStore()Deprecated.since 4.2.20 - UseStore.Type#MEDIASTORE#getName()GomSiteOrMediaStoreFolder.getStore()Deprecated.GomStoreFolder.getStore()The store name@Nullable GomButton.ButtonStyleGomButton.getStyle()Button style, default is 'button'GomTabList.getTabAttribute()Deprecated.Table attribute assigned to be used as tab labelAbstractGomTableTemplateElement.getTable()GomDom.getTable()Indicates if the button for creating tables is enabledGomIncludeContent.getTable()Deprecated.Reference to the table templateGomTableTemplateProvider.getTable()Reference to the table templateGomContentList.getTableView()Deprecated.Related table viewGomContentList.getTableViewFK()Deprecated.Foreign key for related table viewGomContentList.getTableViews()Deprecated.Relations to viewsGomGroup.getTabs()The tab rendering modeAbstractGomContentReferenceElement.getTemplateRef()Deprecated.since 4.0 - no replacementGomContentAreaList.getTemplates()Deprecated.since 4.0 - no replacement@NotNull StringGomIncludeContent.LabelContentSource.getText()GomInnerText.getText()Returns the inner text.@NotNull StringGomLabelExpressions.GomLabelExpression.getText()GomButton.GomDropMimeType.getType()mime type, e.g.GomFilterAllowEntry.getType()GomFilterHideEntry.getType()GomIncludeContent.getType()Deprecated.Type for content inclusionGomIncludeOptions.getType()Type of inclusion@Nullable NumberTypeGomNumber.getType()Number type.GomToggle.getType()Display type for states@NotNull StringAbstractGomUid.getUid()Provides the universal identifier of this entry.GomFile.getUpload()Deprecated.Indicates if it is allowed to upload media.GomImageMap.getUpload()Indicates if uploading of media is allowed.GomPicture.getUpload()Deprecated.GomReference.getUpload()Indicates if uploading of data is allowedGomFile.getUploadFolder()Deprecated.since 4.2.5 - no replacementGomMediaStoreLocalProjectEntry.getUploadFolder()GomMediaStoreRemoteProjectEntry.getUploadFolder()GomPicture.getUploadFolder()Deprecated.GomSiteOrMediaStoreLocalProjectEntry.getUploadFolder()Deprecated.Defines a root folder to be used for uploadsGomSiteOrMediaStoreRemoteProjectEntry.getUploadFolder()Deprecated.GomStorableLocalProjectEntry.getUploadFolder()GomStorableRemoteProjectEntry.getUploadFolder()AbstractGomFormElement.getUseLanguages()Indicates, whether to have separate values in different languages.GomContentAreaList.getUseLanguages()Deprecated.GomPermission.getUseLanguages()Deprecated.GomButton.GomDropType.getValue()Predefined drop typeGomGenericParam.getValue()The value bound to the paramGomLabeledValueEntry.getValue()Provides the entry's value.GomContentAreaList.getVariables()Deprecated.Variables from inserted sections to be displayed in the listAbstractGomDom.getWidth()Width of the form field area in pixelsGomContentList.getWidth()Deprecated.Width of the content list form area in pixelsAbstractGomDom.getWordImport()Deprecated.since 4.1.10 - no replacementbooleanPreset.isCopy()Indicates this preset mode to be the copy setting.booleanDatePreset.isCreated()Preset once with creation datebooleanInitialPreset.isCreated()Indicates to request an initial value at creation stage, if no value is set at the time of setting up the value.booleanPreset.isDefault()Indicates this preset mode to be the default one.booleanDatePreset.isModified()Set each time when modifiedvoidSets the name of the parameter -
Uses of GomDoc in de.espirit.firstspirit.access.store.templatestore.gom.lists
Classes in de.espirit.firstspirit.access.store.templatestore.gom.lists with annotations of type GomDocModifier and TypeClassDescriptionfinal classTemplate restriction definition container for list components.static enumTypes of templates.final classAn entry providing a UID.enumView mode for list components.Methods in de.espirit.firstspirit.access.store.templatestore.gom.lists with annotations of type GomDocModifier and TypeMethodDescriptionGomTypeRestrictedTemplates.getType()Provides the type of templates allowed. -
Uses of GomDoc in de.espirit.firstspirit.common.number
Classes in de.espirit.firstspirit.common.number with annotations of type GomDocModifier and TypeClassDescriptionclassInteger type replacement for positive numbers. -
Uses of GomDoc in de.espirit.firstspirit.common.text
Classes in de.espirit.firstspirit.common.text with annotations of type GomDocModifier and TypeClassDescriptionfinal classString type replacement for class names.final classString type replacement for designators.final classString type replacement for language abbreviations.classString implementation for reference names. -
Uses of GomDoc in de.espirit.firstspirit.content.access
Classes in de.espirit.firstspirit.content.access with annotations of type GomDocModifier and TypeClassDescriptionclassGOM configuration object for dataset data access.Methods in de.espirit.firstspirit.content.access with annotations of type GomDocModifier and TypeMethodDescription@NotNull GomQueryDatasetDataAccessConfiguration.getQuery()Returns the query to be used for entry selection.@NotNull GomTableTemplateUidDatasetDataAccessConfiguration.getTemplate()Returns the universal identifier of the editing template -
Uses of GomDoc in de.espirit.firstspirit.service.permission
Classes in de.espirit.firstspirit.service.permission with annotations of type GomDoc
GomCataloginstead