Package org.graffiti.options

Interface PreferencesInterface

All Known Implementing Classes:
ButtonOverlayView, ChartAttributeComponent, HighDPISupport, IPK_MegaMoveTool, IPKGraffitiView, LabelComponent, MegaMoveTool, RimasTab, ScanForUpdate, SimpleLabelComponent, TabMetaCrop, VantedPreferences
public interface PreferencesInterface
Classes that want to provide settings that will be stored in a settings file and that want to be user-configurable can implement this interface. Detailed usage:
Author:
matthiak

  • Method Summary

    Modifier and Type Method Description
    List<Parameter> getDefaultParameters()
    On first start or on reset there will be no preferences available.
    String getPreferencesAlternativeName()
    return a custom preference category, that this class will reside in.
    void updatePreferences​(Preferences preferences)
    This method will be called, when preferences for this class have changed and the implementing class gets the chance of setting class (static) variables having the values of the parameters.

  • Method Details

    • getDefaultParameters

      List<Parameter> getDefaultParameters()
      On first start or on reset there will be no preferences available. The PreferenceManager will read this list containing the set of settings, that the implementing class thinks can be configured provide default values. All Parameters in this list will also appear in the PreferenceDialog. Entities providing preferences should add parameters to this array.

    • updatePreferences

      void updatePreferences​(Preferences preferences)
      This method will be called, when preferences for this class have changed and the implementing class gets the chance of setting class (static) variables having the values of the parameters. Setting static class variables will help increase speed, when querying the parameters. Direct variable access VS querying the Preferences Object for this class
      Parameters:
      preferences -

    • getPreferencesAlternativeName

      String getPreferencesAlternativeName()
      return a custom preference category, that this class will reside in. If null is returned, this class will be put into a standard category dependent on its Super class
      Returns: