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

Class GomScriptButtonEntry

java.lang.Object

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

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

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

All Implemented Interfaces:

GomCheckable, GomElement, GomLangInfoProvider, Serializable

@NonExtendable
public class GomScriptButtonEntry
extends AbstractGomLangInfoProvider

Entry implementation for defining script-based buttons.

Since:

4.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
GomScriptButtonEntry()

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Return the default tag for a gom element.
GomButtonLangInfos	getLangInfos()	Provides the language information.
@Nullable String	script(String lang)	Convenience API returning the script for a specific language
void	verify()	Verify the element to be fulfill its syntactic constraints.

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

description, getLabel, label, setLabel, validate

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

clone, 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

GomScriptButtonEntry

public GomScriptButtonEntry()

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.

getLangInfos

public GomButtonLangInfos getLangInfos()

Description copied from class: AbstractGomLangInfoProvider

Provides the language information.

Specified by:

getLangInfos in interface GomLangInfoProvider

Overrides:

getLangInfos in class AbstractGomLangInfoProvider

Returns:

The language information container.

script

@Nullable
public @Nullable String script(String lang)

Convenience API returning the script for a specific language

Parameters:

lang - the language for which the script should be returned

Returns:

the script, may be null if unavailable

Since:

4.0

verify

public void verify()
            throws IllegalStateException

Description copied from interface: GomCheckable

Verify the element to be fulfill its syntactic constraints.

Throws:

IllegalStateException - If the element is not correctly set up.