Class AbstractValueHoldingSwingGadget<T,F extends GomFormElement>
java.lang.Object
de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget<T,F>
- All Implemented Interfaces:
Gadget
,Aspectable
,Editable
,Labelable
,ValueHolder<T>
,SwingComponentProvider
,SwingGadget
@Experimental
public abstract class AbstractValueHoldingSwingGadget<T,F extends GomFormElement>
extends Object
implements SwingGadget, ValueHolder<T>, Editable
Abstract implementation providing basic functionalities supporting
value holding
SwingGadget
s. Subclass-API:
-
addAspect(AspectType,Object)
- register an aspect for a the specified type that will be returned bygetAspect(AspectType)
. The type for the value holding aspect will be added on instance creation. -
notifyValueChange(GadgetIdentifier)
- propagate a value change event to given host. -
ValueHolder.getValue()
&ValueHolder.setValue(Object)
- remain to be implemented. -
Labelable.getLabel()
&Editable.setEditable(boolean)
- remain to be implemented.
- Since:
- 4.2.405
-
Field Summary
Fields inherited from interface de.espirit.firstspirit.ui.gadgets.aspects.ValueHolder
TYPE
-
Constructor Summary
ConstructorDescriptionConstructor adding the core aspects. -
Method Summary
Modifier and TypeMethodDescriptionfinal <A> void
addAspect
(@NotNull AspectType<A> type, A aspect) Add an aspect supported by thisAspectable
.final <A> A
getAspect
(@NotNull AspectType<A> type) Request an aspect from the aspectable.final SpecialistsBroker
Access the broker providing access to specialists on application knowledge.The context container for this gadget.final String
Convenience method returning the description of the form.final @NotNull Language
Convenience method to get the language to be used for displaying values.final F
getForm()
Convenience method to access the form definition for this gadget.final GadgetIdentifier
Provides the basic gadget identifier related to the form element of this gadget.final String
getLabel()
Convenience implementation returning the display label for this gadget.final de.espirit.firstspirit.agency.LocalizationAgent
Convenience method to get the agent providing localization functionalities.final @NotNull NotificationHost
Access the notification host responsibly for this value holder.final OperationAgent
Convenience method to get the agent providing operations.final Language
Convenience method to get the language to be used for accessing values.final UIAgent
Convenience method to get the agent providing access to UI settings related operations.The requested view mode for this gadget.final boolean
Convenience method indicating the gadget to operate in store element release mode.final void
notifyStateChange
(GadgetIdentifier identifier) Notify about the value state having changed.final void
notifyValueChange
(GadgetIdentifier identifier) Notify about the value having changed.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.ui.gadgets.aspects.Editable
setEditable
Methods inherited from interface de.espirit.firstspirit.ui.gadgets.swing.SwingComponentProvider
getComponent
Methods inherited from interface de.espirit.firstspirit.ui.gadgets.aspects.ValueHolder
getValue, isEmpty, setValue
-
Constructor Details
-
AbstractValueHoldingSwingGadget
Constructor adding the core aspects.- Parameters:
context
- The context for this swing gadget.- Since:
- 4.2.405
-
-
Method Details
-
getContext
The context container for this gadget.- Returns:
- The context container for this gadget.
- Since:
- 5.2.900
-
getViewMode
The requested view mode for this gadget. Shortcut forgetContext()
.getViewMode()
.- Returns:
- The requested view mode for this gadget.
- Since:
- 5.2.900
-
getLabel
Convenience implementation returning the display label for this gadget. -
getDescription
Convenience method returning the description of the form.- Returns:
- The form's description.
- Since:
- 4.2.405
-
getAspect
Request an aspect from the aspectable.- Specified by:
getAspect
in interfaceAspectable
- Type Parameters:
A
- The type of the returned instance.- Parameters:
type
- The aspect requested.- Returns:
- The aspect instance or
null
, if the aspect is not supported. - Since:
- 4.2.405
-
addAspect
Add an aspect supported by thisAspectable
.- Type Parameters:
A
- The type of the aspect.- Parameters:
type
- The aspect type.aspect
- The aspect implementation.- Since:
- 4.2.405
-
getForm
Convenience method to access the form definition for this gadget.- Returns:
- This gadget's form definition.
- Since:
- 4.2.405
-
getGadgetId
Provides the basic gadget identifier related to the form element of this gadget.- Returns:
- The basic gadget identifier.
- Since:
- 4.2.405
-
getNotificationHost
Access the notification host responsibly for this value holder. The host will be set during the initialization phase following the instantiation of this value holder.- Returns:
- The notification host.
- Since:
- 4.2.405
-
notifyValueChange
Notify about the value having changed.- Parameters:
identifier
- The identifier of this gadget and the specific Swing component.- Since:
- 4.2.405
-
notifyStateChange
Notify about the value state having changed.- Parameters:
identifier
- The identifier of this gadget and the specific Swing component.- Since:
- 5.2.25
-
getDisplayLanguage
Convenience method to get the language to be used for displaying values.- Returns:
- The display language.
- Since:
- 4.2.405
-
getPersistencyLanguage
Convenience method to get the language to be used for accessing values.- Returns:
- The persistency language.
- Since:
- 4.2.405
-
isRelease
public final boolean isRelease()Convenience method indicating the gadget to operate in store element release mode.- Returns:
true
, if release mode should be used.- Since:
- 4.2.405
-
getBroker
Access the broker providing access to specialists on application knowledge.- Returns:
- The specialists broker.
- Since:
- 4.2.405
-
getLocalizationAgent
public final de.espirit.firstspirit.agency.LocalizationAgent getLocalizationAgent()Convenience method to get the agent providing localization functionalities.- Returns:
- The localization agent.
- Since:
- 4.2.405
-
getOperationAgent
Convenience method to get the agent providing operations.- Returns:
- The operation agent.
- Since:
- 4.2.405
-
getUiAgent
Convenience method to get the agent providing access to UI settings related operations.- Returns:
- The UI agent.
- Since:
- 4.2.405
-