Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomLink

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.GomLink

All Implemented Interfaces:

GomCheckable, GomElement, GomFormElement, GomHideable, GomLangInfoProvider, GomLinkEditorProvider, GomSearchRelevancy, LineBreakable, Serializable

Direct Known Subclasses:

GomLinkList

@NonExtendable
public class GomLink
extends AbstractGomFormElement
implements GomLinkEditorProvider

GOM element implementation for links.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomLink()

Method Summary

Modifier and Type	Method	Description
String	getAllowedEditors()	Deprecated. since 4.0 - no replacement
GomInplaceLinkConfig	getCms_Link_Config()	Deprecated. since 4.0 - no replacement
protected String	getDefaultTag()	Return the default tag for a gom element.
Collection<GomInplaceLinkConfig>	getLinkConfigs()	Deprecated. since 4.0 - no replacement
GomLinkEditorList	getLinkEditors()	List of valid link editors
LinkMode	getMode()	The display mode
YesNo	getNoBreak()	Indicates, whether the next form element should follow in the same line as this one.
YesNo	getShowSnippet()	Deprecated. since 5.0 - no replacement
@NotNull Set<String>	linkEditors()	Return a set of link editor names.
@NotNull LinkMode	mode()	Return the mode for the link to be displayed.
void	setAllowedEditors(String csv)	Deprecated. since 4.0 - no replacement
void	setCms_Link_Config(GomInplaceLinkConfig config)	Deprecated. since 4.0 - no replacement
void	setMode(LinkMode mode)	Sets the display mode
void	setShowSnippet(YesNo showSnippet)	Deprecated. since 5.0 - no replacement
void	validate(GomCheckable.Context context)	Validates the form element's state with respect to the given context.

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, 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

public static final String TAG

The tag of this component

Since:

4.0

See Also:

• Constant Field Values

Constructor Details

GomLink

public GomLink()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getLinkEditors

public GomLinkEditorList getLinkEditors()

Description copied from interface: GomLinkEditorProvider

List of valid link editors

Specified by:

getLinkEditors in interface GomLinkEditorProvider

getNoBreak

public YesNo getNoBreak()

Description copied from class: AbstractGomFormElement

Indicates, whether the next form element should follow in the same line as this one.

Overrides:

getNoBreak in class AbstractGomFormElement

Returns:

YES, to make the next form element follow. Defaults to YesNo.NO.

getMode

public LinkMode getMode()

The display mode

Since:

5.0.100

setMode

public void setMode(LinkMode mode)

Sets the display mode

Since:

5.0.100

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Description copied from class: AbstractGomFormElement

Validates the form element's state with respect to the given context. This generic stub does not check anything.

Specified by:

validate in interface GomCheckable

Overrides:

validate in class AbstractGomFormElement

Parameters:

context - The context to validate for, must not be null.

Throws:

GomValidationError - if any requirement is violated.

linkEditors

@NotNull
public @NotNull Set<String> linkEditors()

Return a set of link editor names.

Specified by:

linkEditors in interface GomLinkEditorProvider

Returns:

The set of names.

Since:

2.0

mode

@NotNull
public @NotNull LinkMode mode()

Return the mode for the link to be displayed.

Returns:

The display mode.

Since:

5.0

getShowSnippet

@Deprecated(since="5.0")
public YesNo getShowSnippet()

Deprecated.

since 5.0 - no replacement

Indicates if the component shows related snippet

Since:

5.0

setShowSnippet

@Deprecated(since="5.0")
public void setShowSnippet(YesNo showSnippet)

Deprecated.

since 5.0 - no replacement

Sets if the component shows related snippet

Since:

5.0

getAllowedEditors

@Deprecated(since="4.0")
public String getAllowedEditors()

Deprecated.

since 4.0 - no replacement

Allowed editors

Since:

2.0

setAllowedEditors

@Deprecated(since="4.0")
public void setAllowedEditors(String csv)

Deprecated.

since 4.0 - no replacement

Sets allowed editors

Since:

2.0

getCms_Link_Config

@Deprecated(since="4.0")
public GomInplaceLinkConfig getCms_Link_Config()

Deprecated.

since 4.0 - no replacement

Dummy getter. Use getLinkConfigs() instead.

Returns:

null

Since:

2.0

getLinkConfigs

@Deprecated(since="4.0")
public Collection<GomInplaceLinkConfig> getLinkConfigs()

Deprecated.

since 4.0 - no replacement

Get a list of inplace link configurations.

Returns:

The list or null.

Since:

2.0

setCms_Link_Config

@Deprecated(since="4.0")
public void setCms_Link_Config(GomInplaceLinkConfig config)

Deprecated.

since 4.0 - no replacement

Sets the list of inplace link configurations.

Since:

2.0