de.espirit.firstspirit.module

Interface GadgetContext<E extends GomElement>

All Known Subinterfaces:

SwingGadgetContext<E>

public interface GadgetContext<E extends GomElement>

API for context information that is provided to Gadget implementations on construction.
Important: The context may change during its lifetime, hence, objects retrieved via the context may be altered or replaced. To be sure using the current context, these objects should always be accessed via the context directly.

Since:

4.2.405

Method Summary

Methods

Modifier and Type	Method and Description
SpecialistsBroker	getBroker() Provides access to a specialists broker.
Language	getDisplayLanguage() The display language to be used for displaying the form (labels).
IDProvider	getElement() Delivers the store element the gadget belongs to.
String	getFormUid() Provides the form identifying uid.
E	getGom() Gives the form definition as GOM element.
Language	getPersistencyLanguage() The persistency language of the gadget's value.
Store.Type	getStoreType() Provides the store type the gadget operates in.
boolean	isDefault() Indicates to operate for default value definition.
boolean	isRelease() Indicates to operate in store element release mode.

Method Detail

getGom

@NotNull
E getGom()

Gives the form definition as GOM element.

Returns:

The GOM element.

Since:

4.2.405

getBroker

@NotNull
SpecialistsBroker getBroker()

Provides access to a specialists broker.

The broker provided offers several additional, specialized agents:

• OperationAgent for accessing operations
• ReferenceConstructionAgent for constructing reference containers

Returns:

The broker.

Since:

4.2.405

See Also:

OperationAgent, ReferenceConstructionAgent

getElement

@Nullable
IDProvider getElement()

Delivers the store element the gadget belongs to.

Returns:

The owning store element.

Since:

4.2.413

getStoreType

@NotNull
Store.Type getStoreType()

Provides the store type the gadget operates in.

Returns:

The store type.

Since:

4.2.405

getPersistencyLanguage

@NotNull
Language getPersistencyLanguage()

The persistency language of the gadget's value. This is the language of the tab embedding the component.

Returns:

The persistency language.

Since:

4.2.405

See Also:

getDisplayLanguage()

getDisplayLanguage

@NotNull
Language getDisplayLanguage()

The display language to be used for displaying the form (labels). This is not the language the displayed value stems from, therefore use the persistency language.

Returns:

The display language.

Since:

4.2.405

See Also:

getPersistencyLanguage()

isRelease

boolean isRelease()

Indicates to operate in store element release mode.

Returns:

true, if operating in release mode.

Since:

4.2.405

getFormUid

@NotNull
String getFormUid()

Provides the form identifying uid.

Returns:

The form's uid.

Since:

4.2.405

isDefault

boolean isDefault()

Indicates to operate for default value definition.

Returns:

true, if operating on defaults.

Since:

4.2.405