Package de.espirit.firstspirit.ui.gadgets.swing

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

Subclass-API:

Since:
4.2.405

  • Constructor Details

    • AbstractValueHoldingSwingGadget

      public AbstractValueHoldingSwingGadget(SwingGadgetContext<F> context)
      Constructor adding the core aspects.
      Parameters:
      context - The context for this swing gadget.
      Since:
      4.2.405

  • Method Details

    • getContext

      public SwingGadgetContext<F> getContext()
      The context container for this gadget.
      Returns:
      The context container for this gadget.
      Since:
      5.2.900

    • getViewMode

      public SwingFormViewMode getViewMode()
      The requested view mode for this gadget. Shortcut for getContext().getViewMode().
      Returns:
      The requested view mode for this gadget.
      Since:
      5.2.900

    • getLabel

      public final String getLabel()
      Convenience implementation returning the display label for this gadget.
      Specified by:
      getLabel in interface Labelable
      Returns:
      The language dependent display label.
      Since:
      4.2.405

    • getDescription

      public final String getDescription()
      Convenience method returning the description of the form.
      Returns:
      The form's description.
      Since:
      4.2.405

    • getAspect

      public final <A> A getAspect(@NotNull @NotNull AspectType<A> type)
      Request an aspect from the aspectable.
      Specified by:
      getAspect in interface Aspectable
      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

      public final <A> void addAspect(@NotNull @NotNull AspectType<A> type, @NotNull A aspect)
      Add an aspect supported by this Aspectable.
      Type Parameters:
      A - The type of the aspect.
      Parameters:
      type - The aspect type.
      aspect - The aspect implementation.
      Since:
      4.2.405

    • getForm

      public final F getForm()
      Convenience method to access the form definition for this gadget.
      Returns:
      This gadget's form definition.
      Since:
      4.2.405

    • getGadgetId

      public final GadgetIdentifier getGadgetId()
      Provides the basic gadget identifier related to the form element of this gadget.
      Returns:
      The basic gadget identifier.
      Since:
      4.2.405

    • getNotificationHost

      @NotNull public final @NotNull NotificationHost 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

      public final void notifyValueChange(GadgetIdentifier identifier)
      Notify about the value having changed.
      Parameters:
      identifier - The identifier of this gadget and the specific Swing component.
      Since:
      4.2.405

    • notifyStateChange

      public final void notifyStateChange(GadgetIdentifier identifier)
      Notify about the value state having changed.
      Parameters:
      identifier - The identifier of this gadget and the specific Swing component.
      Since:
      5.2.25

    • getDisplayLanguage

      @NotNull public final @NotNull Language getDisplayLanguage()
      Convenience method to get the language to be used for displaying values.
      Returns:
      The display language.
      Since:
      4.2.405

    • getPersistencyLanguage

      public final Language 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

      public final SpecialistsBroker 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

      public final OperationAgent getOperationAgent()
      Convenience method to get the agent providing operations.
      Returns:
      The operation agent.
      Since:
      4.2.405

    • getUiAgent

      public final UIAgent getUiAgent()
      Convenience method to get the agent providing access to UI settings related operations.
      Returns:
      The UI agent.
      Since:
      4.2.405