Package jmri

Interface UserPreferencesManager

All Known Implementing Classes:
JmriUserPreferencesManager

public interface UserPreferencesManager
Interface for the User Preferences Manager.

The User Message Preference Manager keeps track of the options that a user has selected in messages where they have selected "Remember this setting for next time"

See Also:
JmriUserPreferencesManager
  • Field Details

  • Method Details

    • setLoading

      void setLoading()
    • finishLoading

    • getSimplePreferenceState

      boolean getSimplePreferenceState​(String name)
      Enquire as to the state of a user preference.

      Preferences that have not been set will be considered to be false.

      The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - the name of the preference
      Returns:
      the state or false if never set
    • setSimplePreferenceState

      void setSimplePreferenceState​(String name, boolean state)
      This is used to remember the last selected state of a checkBox and thus allow that checkBox to be set to a true state when it is next initialized. This can also be used anywhere else that a simple yes/no, true/false type preference needs to be stored.

      It should not be used for remembering if a user wants to suppress a message as there is no means in the GUI for the user to reset the flag. setPreferenceState() should be used in this instance The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - A unique name to identify the state being stored
      state - simple boolean
    • getCheckboxPreferenceState

      boolean getCheckboxPreferenceState​(String name, boolean defaultState)
      Enquire as to the state of a user preference.

      Preferences that have not been set will be considered to be defaultState.

      The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - the name of the preference
      defaultState - the default state if not set
      Returns:
      the state or defaultState if never set
    • setCheckboxPreferenceState

      void setCheckboxPreferenceState​(String name, boolean state)
      This is used to remember the last selected state of a checkBox and thus allow that checkBox to be set to a true state when it is next initialized. This can also be used anywhere else that a simple yes/no, true/false type preference needs to be stored.

      It should not be used for remembering if a user wants to suppress a message as there is no means in the GUI for the user to reset the flag. setPreferenceState() should be used in this instance The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - A unique name to identify the state being stored
      state - simple boolean
    • getSimplePreferenceStateList

      Returns an ArrayList of the check box states set as true.
      Returns:
      list of simple preferences names
    • setPreferenceState

      void setPreferenceState​(String strClass, String item, boolean state)
      Used to save the state of checkboxes which can suppress messages from being displayed. This method should be used by the initiating code in conjunction with the preferenceItemDetails. Here the items are stored against a specific class and access to change them is made available via the GUI, in the preference manager.

      The strClass parameter does not have to be the exact class name of the initiating code, but can be one where the information is related and therefore can be grouped together with.

      Both the strClass and item although free form, should make up a unique reference.

      Parameters:
      strClass - The class that this preference should be stored or grouped with.
      item - The specific item that is to be stored
      state - Boolean state of the item.
    • getPreferenceState

      boolean getPreferenceState​(String strClass, String item)
      Returns the state of a given item registered against a specific class or item.
      Parameters:
      strClass - name of the class for this preference
      item - name of the item for which the state is being retrieved
      Returns:
      the state or false if not set
    • setPreferenceItemDetails

      void setPreferenceItemDetails​(String strClass, String item, String description)
      Register details about a particular preference, so that it can be displayed in the GUI and provide a meaning full description when presented to the user.
      Parameters:
      strClass - A string form of the class that the preference is stored or grouped with
      item - The specific item that is being stored
      description - A meaningful description of the item that the user will understand
    • getPreferenceList

      Returns a list of preferences that are registered against a specific class.
      Parameters:
      strClass - the class name
      Returns:
      the list of preference names
    • getPreferenceItemName

      String getPreferenceItemName​(String strClass, int n)
      Returns the itemName of the n preference in the given class
      Parameters:
      strClass - the name of the class
      n - the position in an array
      Returns:
      the name of the preference or null if non-existent
    • getPreferenceItemDescription

      Returns the description of the given item preference in the given class
      Parameters:
      strClass - the name of the class
      item - the name of the item
      Returns:
      the description of the preference
    • getSessionPreferenceState

      Enquire as to the state of a user preference for the current session.

      Preferences that have not been set will be considered to be false.

      The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - the name of the preference
      Returns:
      the state or false if not set
    • setSessionPreferenceState

      void setSessionPreferenceState​(String name, boolean state)
      Used to suppress messages for the current session, the information is not stored, can not be changed via the GUI.

      This can be used to help prevent over loading the user with repetitive error messages such as turnout not found while loading a panel file due to a connection failing. The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class.

      Parameters:
      name - A unique identifier for preference.
      state - suppression state of the item.
    • resetChangeMade

    • showInfoMessage

      void showInfoMessage​(String title, String message, String classString, String item)
      Show an info message ("don't forget ...") with a given dialog title and user message. Use a given preference name to determine whether to show it in the future. The combination of the classString and item parameters should form a unique value.
      Parameters:
      title - message Box title
      message - message to be displayed
      classString - name of the calling class
      item - name of the specific item this is used for
    • showErrorMessage

      void showErrorMessage​(String title, String message, String classString, String item, boolean sessionOnly, boolean alwaysRemember)
      Show an error message ("don't forget ...") with a given dialog title and user message. Use a given preference name to determine whether to show it in the future. added flag to indicate that the message should be suppressed JMRI session only. The classString and item parameters should form a unique value
      Parameters:
      title - Message Box title
      message - Message to be displayed
      classString - String value of the calling class
      item - String value of the specific item this is used for
      sessionOnly - Means this message will be suppressed in this JMRI session and not be remembered
      alwaysRemember - Means that the suppression of the message will be saved
    • showInfoMessage

      void showInfoMessage​(String title, String message, String classString, String item, boolean sessionOnly, boolean alwaysRemember)
      Show an info message ("don't forget ...") with a given dialog title and user message. Use a given preference name to determine whether to show it in the future. added flag to indicate that the message should be suppressed JMRI session only. The classString and item parameters should form a unique value
      Parameters:
      title - Message Box title
      message - Message to be displayed
      classString - String value of the calling class
      item - String value of the specific item this is used for
      sessionOnly - Means this message will be suppressed in this JMRI session and not be remembered
      alwaysRemember - Means that the suppression of the message will be saved
    • showWarningMessage

      void showWarningMessage​(String title, String message, String classString, String item, boolean sessionOnly, boolean alwaysRemember)
      Show a warning message ("don't forget ...") with a given dialog title and user message. Use a given preference name to determine whether to show it in the future. added flag to indicate that the message should be suppressed JMRI session only. The classString and item parameters should form a unique value
      Parameters:
      title - Message Box title
      message - Message to be displayed
      classString - String value of the calling class
      item - String value of the specific item this is used for
      sessionOnly - Means this message will be suppressed in this JMRI session and not be remembered
      alwaysRemember - Means that the suppression of the message will be saved
    • getComboBoxLastSelection

      The last selected value in a given combo box.
      Parameters:
      comboBoxName - the combo box name
      Returns:
      the selected value
    • setComboBoxLastSelection

      void setComboBoxLastSelection​(String comboBoxName, String lastValue)
      Set the last selected value in a given combo box.

      The name is free-form, but to avoid ambiguity it should start with the package name (package.Class) for the primary using class, followed by an identifier for the combo box.

      Parameters:
      comboBoxName - the combo box name
      lastValue - the selected value
    • getScreen

    • isSaveAllowed

      boolean isSaveAllowed()
      Check if saving preferences is allowed.
      Returns:
      true if saving is allowed; false otherwise
    • setSaveAllowed

      void setSaveAllowed​(boolean saveAllowed)
      Set if saving preferences is allowed. When setting true, preferences will be saved immediately if needed.

      Note only set false if a number of preferences will be set together to avoid excessive disk I/O while setting preferences.

      Note remember to allow saving as soon as blocking saving is no longer needed.

      Parameters:
      saveAllowed - true to allow saving; false to block saving
    • removePropertyChangeListener

    • addPropertyChangeListener

    • getClassDescription

      Get the description of a class/group registered with the preferences.
      Parameters:
      strClass - the class name
      Returns:
      the description
    • getPreferencesClasses

      Get the list of the classes registered with the preference manager.
      Returns:
      the list of class names
    • setClassDescription

      void setClassDescription​(String strClass)
      Given that we know the class as a string, we will try and attempt to gather details about the preferences that has been added, so that we can make better sense of the details in the preferences window.

      This looks for specific methods within the class called "getClassDescription" and "setMessagePreferenceDetails". If found it will invoke the methods, this will then trigger the class to send details about its preferences back to this code.

      Parameters:
      strClass - description to use for the class
    • setMessageItemDetails

      void setMessageItemDetails​(String strClass, String item, String description, HashMap<Integer,​String> options, int defaultOption)
      Add descriptive details about a specific message box, so that if it needs to be reset in the preferences, then it is easily identifiable. displayed to the user in the preferences GUI.
      Parameters:
      strClass - String value of the calling class/group
      item - String value of the specific item this is used for.
      description - A meaningful description that can be used in a label to describe the item
      options - A map of the integer value of the option against a meaningful description.
      defaultOption - The default option for the given item.
    • getChoiceOptions

      Returns a map of the value against description of the different items in a given class. This information can then be used to build a Combo box.
      Parameters:
      strClass - Class or group of the given item
      item - the item which we wish to return the details about.
      Returns:
      map of choices
    • getMultipleChoiceSize

      int getMultipleChoiceSize​(String strClass)
      Get the number of Multiple Choice items registered with a given class.
      Parameters:
      strClass - the class name
      Returns:
      number of items
    • getMultipleChoiceList

      Get a list of all the multiple choice items registered with a given class.
      Parameters:
      strClass - the class name
      Returns:
      list of item names
    • getChoiceName

      String getChoiceName​(String strClass, int n)
      Get the nth item name in a given class.
      Parameters:
      strClass - the class name
      n - the position
      Returns:
      the item name
    • getChoiceDescription

      Get the a meaningful description of a given item in a given class or group.
      Parameters:
      strClass - the class name
      item - the item name
      Returns:
      the item description
    • getMultipleChoiceOption

      int getMultipleChoiceOption​(String strClass, String item)
      Get the current value of a given item in a given class.
      Parameters:
      strClass - the class name
      item - the item name
      Returns:
      the value
    • getMultipleChoiceDefaultOption

      int getMultipleChoiceDefaultOption​(String strClass, String choice)
      Returns the default value of a given item in a given class
      Parameters:
      strClass - the class name
      choice - the item name
      Returns:
      the default value
    • setMultipleChoiceOption

      void setMultipleChoiceOption​(String strClass, String choice, String value)
      Sets the value of a given item in a given class, by its string description.
      Parameters:
      strClass - the class name
      choice - the item name
      value - the item value description
    • setMultipleChoiceOption

      void setMultipleChoiceOption​(String strClass, String choice, int value)
      Sets the value of a given item in a given class, by its integer value.
      Parameters:
      strClass - the class name
      choice - the item name
      value - the item value
    • getPreferencesSize

      int getPreferencesSize​(String strClass)
      Get the combined size of both types of items registered.
      Parameters:
      strClass - the class name
      Returns:
      number of registered preferences
    • setWindowLocation

      void setWindowLocation​(String strClass, Point location)
      Saves the last location of a given component on the screen.

      The jmri.util.JmriJFrame, will automatically use the class name of the frame if the class name returned is equal to jmri.util.JmriJFrame, the location is not stored

      Parameters:
      strClass - This is a unique identifier for window location being saved
      location - The x,y location of the window given in a Point
    • setWindowSize

      void setWindowSize​(String strClass, Dimension dim)
      Saves the last size of a given component on the screen

      The jmri.util.JmriJFrame, will automatically use the class name of the frame if the class name returned is equal to jmri.util.JmriJFrame, the size is not stored

      Parameters:
      strClass - This is a unique identifier for window size being saved
      dim - The width, height size of the window given in a Dimension
    • getWindowLocation

      Get the x,y location of a given Window.
      Parameters:
      strClass - the class name
      Returns:
      the location
    • getWindowSize

      Returns the width, height size of a given Window
      Parameters:
      strClass - the class name
      Returns:
      the size
    • getWindowList

    • hasProperties

      boolean hasProperties​(String strClass)
      Check if there are properties for the given class
      Parameters:
      strClass - class to check
      Returns:
      true if properties for strClass are maintained; false otherwise
    • getSaveWindowSize

      boolean getSaveWindowSize​(String strClass)
    • getSaveWindowLocation

      boolean getSaveWindowLocation​(String strClass)
    • setSaveWindowSize

      void setSaveWindowSize​(String strClass, boolean b)
      Set if window sizes should be saved for a given class. Method has no effect if strClass is null or equals jmri.util.JmriJFrame.
      Parameters:
      strClass - name of the class
      b - true if window sizes should be saved; false otherwise
    • setSaveWindowLocation

      void setSaveWindowLocation​(String strClass, boolean b)
      Set if window locations should be saved for a given class. Method has no effect if strClass is null or equals jmri.util.JmriJFrame.
      Parameters:
      strClass - name of the class
      b - true if window locations should be saved; false otherwise
    • setProperty

      void setProperty​(String strClass, String key, Object value)
      Attach a key/value pair to the given class, which can be retrieved later. These are not bound properties as yet, and don't throw events on modification. Key must not be null.
      Parameters:
      strClass - class to use
      key - Prior to 4.3.5, this could be an Object.
      value - value to use
    • getProperty

      Object getProperty​(String strClass, String key)
      Retrieve the value associated with a key in a given class If no value has been set for that key, returns null.
      Parameters:
      strClass - class to use
      key - item to retrieve
      Returns:
      stored value
    • getPropertyKeys

      Retrieve the complete current set of keys for a given class.
      Parameters:
      strClass - class to use
      Returns:
      complete set of keys