Class GomPageRef
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.GomPageRef
- All Implemented Interfaces:
GomCheckable
,GomElement
,GomFormElement
,GomHideable
,GomLangInfoProvider
,GomProjectProvider
,GomSearchRelevancy
,LineBreakable
,Serializable
@Deprecated(since="5.0")
@NonExtendable
public class GomPageRef
extends AbstractGomFormElement
implements GomProjectProvider
Deprecated.
since 5.0, use FS_REFERENCE instead
GOM element implementation for page references.
- 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 TypeMethodDescriptionboolean
Deprecated.Convenience API forgetMediaStore()
returning a boolean valueprotected String
Deprecated.Return the default tag for a gom element.Deprecated.since 4.0 - no replacementgetHFill()
Deprecated.Indicates, whether to horizontally fill a form by this form element.Deprecated.Indicates if it is allowed to reference mediaDeprecated.Projects to be used as sourcesDeprecated.Determines which kind of references are allowedDeprecated.Describes the sort order for section selection comboboxDeprecated.since 4.2 - usegetProjects()
Deprecated.Get the list of defined constraints.@NotNull PageRefMode
sections()
Deprecated.Convenience API forgetSections()
returning a non-null value.void
setFolders
(String csv) Deprecated.since 4.0 - no replacementvoid
setMediaStore
(YesNo mediaStore) Deprecated.Sets if it is allowed to reference mediavoid
setSections
(PageRefMode sections) Deprecated.Sets which kind of references are allowedvoid
setSortOrder
(SortOrder sortOrder) Deprecated.Sets the sort order for section selection combobox@NotNull SortOrder
Deprecated.Convenience API forgetSortOrder()
returning a non-null value.sources()
Deprecated.Convenience API returning the source names as a list of strings.Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, getDefaultValue, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, validate, 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
Deprecated.The tag of this component- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
GomPageRef
public GomPageRef()Deprecated.
-
-
Method Details
-
getDefaultTag
Deprecated.Description copied from class:AbstractGomElement
Return the default tag for a gom element.- Specified by:
getDefaultTag
in classAbstractGomElement
- Returns:
- The elements default tag.
-
getMediaStore
Deprecated.Indicates if it is allowed to reference media- Since:
- 2.0
-
setMediaStore
Deprecated.Sets if it is allowed to reference media- Since:
- 2.0
-
getSections
Deprecated.Determines which kind of references are allowed- Since:
- 2.0
-
setSections
Deprecated.Sets which kind of references are allowed- Since:
- 2.0
-
getFolders
Deprecated.since 4.0 - no replacementFolder restrictions- Since:
- 2.0
-
setFolders
Deprecated.since 4.0 - no replacementSet folder-restrictions according to a comma-separated list- Parameters:
csv
- the comma-separated list containing the folder-restrictions- Since:
- 2.0
-
getSources
Deprecated.since 4.2 - usegetProjects()
Restrict access to specific folders (including sub-folders)- Since:
- 4.0
-
getProjects
Deprecated.Description copied from interface:GomProjectProvider
Projects to be used as sources- Specified by:
getProjects
in interfaceGomProjectProvider
-
getHFill
Deprecated.Description copied from class:AbstractGomFormElement
Indicates, whether to horizontally fill a form by this form element.- Overrides:
getHFill
in classAbstractGomFormElement
- Returns:
YES
, if set to fill horizontally. Default isno
.
-
getSortOrder
Deprecated.Describes the sort order for section selection combobox- Since:
- 4.0
-
setSortOrder
Deprecated.Sets the sort order for section selection combobox- Since:
- 4.0
-
allowsMedia
public boolean allowsMedia()Deprecated.Convenience API forgetMediaStore()
returning a boolean value- Since:
- 4.0
-
sections
Deprecated.Convenience API forgetSections()
returning a non-null value.- Returns:
- the value of
getSections()
orPageRefMode.PAGE
if unset - Since:
- 4.0
-
sortOrder
Deprecated.Convenience API forgetSortOrder()
returning a non-null value.- Returns:
- the value of
getSortOrder()
orSortOrder.KEEP_ORDER
if unset - Since:
- 4.0
-
sources
Deprecated.Convenience API returning the source names as a list of strings.- Since:
- 4.0
-
projectConstraints
Deprecated.Description copied from interface:GomProjectProvider
Get the list of defined constraints.- Specified by:
projectConstraints
in interfaceGomProjectProvider
- Returns:
- The list of project constraints.
-