Package jaxx.runtime.swing.config.model

Class CallBacksManager

java.lang.Object
jaxx.runtime.swing.config.model.CallBacksManager
public class CallBacksManager
extends java.lang.Object
CallBack manager.
Since:
2.5.11
Author:
Tony Chemit - chemit@codelutin.com

  • Field Details

    • callbacks

      protected java.util.List<CallBackEntry> callbacks
      lists of registred callback.

    • finalizer

      protected CallBackFinalizer finalizer
      optional callbacks finalizer

  • Constructor Details

    • CallBacksManager

      public CallBacksManager()

  • Method Details

    • getFinalizer

      public CallBackFinalizer getFinalizer()
      Obtain the finalizer to use.
      Returns:
      the finalizer (can be null).
      See Also:
      CallBackFinalizer

    • setFinalizer

      public void setFinalizer​(CallBackFinalizer finalizer)
      Sets the finalizer.
      Parameters:
      finalizer - the new finalizer
      See Also:
      CallBackFinalizer

    • registerCallBack

      public void registerCallBack​(java.lang.String name, java.lang.String description, javax.swing.Icon icon, java.lang.Runnable action)
      Registers a new callback. Note: the order of registred callback is used to determine the higher priority of callback to launch if required.
      Parameters:
      name - the unique name of a callback
      description - the i18n key to describe the action
      icon - icon of callBack (used in ui)
      action - the action of the callback

    • registerOption

      public void registerOption​(java.lang.String name, OptionModel option)
      Registers a option into a known callback.
      Parameters:
      name - the name of the callback
      option - the option to register for the given callback

    • getCallBacksForSaved

      public CallBackMap getCallBacksForSaved​(ConfigUIModel model)
      Scan a model and grab per callBack the options saved.
      Parameters:
      model - the model to scan
      Returns:
      the dictionnary of options for each callback to launch

    • getCallBacksForSaved

      public CallBackMap getCallBacksForSaved​(CategoryModel category)
      Scan a category and grab per callBack the options saved.
      Parameters:
      category - the category to scan
      Returns:
      the dictionnary of options for each callBack to launch

    • getCallBacks

      public CallBackMap getCallBacks​(ConfigUIModel model, boolean saved, boolean modified)
      Scan a model and grab per callBack the options.
      Parameters:
      model - the model to scan
      modified - true to include modified options
      saved - true to include saved options
      Returns:
      the dictionnary of options for each callback to launch

    • getCallBacks

      public CallBackMap getCallBacks​(CategoryModel category, boolean saved, boolean modified)
      Scan a category and grab per callBack the options.
      Parameters:
      category - the category to scan
      modified - true to include modified options
      saved - true to include saved options
      Returns:
      the dictionnary of options for each callBack to launch

    • getCallBack

      protected CallBackEntry getCallBack​(OptionModel option)
      Get the first callBack for a given option.
      Parameters:
      option - the option
      Returns:
      the first callBack (so the most important) on which the given option is attacjed. (can be null)

    • getCallBack

      protected CallBackEntry getCallBack​(java.lang.String name)
      Obtain a registred callBack from his name.
      Parameters:
      name - the name of the searched callBack
      Returns:
      the callBack for the given name (or null if not found).