 |
Crossfire JXClient, Trunk
|
|
Crossfire JXClient, Trunk
|
Maintains a set of named options. More...
Collaboration diagram for com.realtime.crossfire.jxclient.settings.options.OptionManager:Classes | |
| class | Entry |
| Pair of Option and corresponding documentation string. More... | |
Public Member Functions | |
| void | addOption (@NotNull final String optionName, @NotNull final String documentation, @NotNull final Option option) throws OptionException |
| Adds a new option. More... | |
| CheckBoxOption | getCheckBoxOption (@NotNull final String optionName) throws OptionException |
| Returns a checkbox option. More... | |
| Map< String, Entry > | getOptions () |
| Returns all defined option names. More... | |
| void | loadOptions () |
| Loads all options' states from the backing settings instance. More... | |
| OptionManager (@NotNull final Settings settings) | |
| Creates a new instance. More... | |
| void | removeOption (@NotNull final String optionName) |
| Removes an option by name. More... | |
| void | saveOptions () |
| Saves all options' states to the backing settings instance. More... | |
Private Attributes | |
| final Map< String, Entry > | options = new HashMap<>() |
| Maps option name to option instance. More... | |
| final Settings | settings |
| The settings instance for loading/saving option values. More... | |
Maintains a set of named options.
Definition at line 36 of file OptionManager.java.
| com.realtime.crossfire.jxclient.settings.options.OptionManager.OptionManager | ( | @NotNull final Settings | settings | ) |
Creates a new instance.
| settings | the settings instance for loading/saving option values |
Definition at line 54 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.settings.
| void com.realtime.crossfire.jxclient.settings.options.OptionManager.addOption | ( | @NotNull final String | optionName, |
| @NotNull final String | documentation, | ||
| @NotNull final Option | option | ||
| ) | throws OptionException |
Adds a new option.
| optionName | the option name to add |
| documentation | the documentation string for the settings |
| option | the option to add |
| OptionException | if the option name is not unique |
Definition at line 65 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.options.
Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.addOption(), and com.realtime.crossfire.jxclient.main.JXClient.JXClient().
Here is the caller graph for this function:| CheckBoxOption com.realtime.crossfire.jxclient.settings.options.OptionManager.getCheckBoxOption | ( | @NotNull final String | optionName | ) | throws OptionException |
Returns a checkbox option.
| optionName | the option name to look up |
| OptionException | if the option name does not exist |
Definition at line 97 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getOption(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.options.
Referenced by com.realtime.crossfire.jxclient.commands.SetCommand.execute().
Here is the call graph for this function: Here is the caller graph for this function:| Map<String, Entry> com.realtime.crossfire.jxclient.settings.options.OptionManager.getOptions | ( | ) |
Returns all defined option names.
Definition at line 86 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.options.
Referenced by com.realtime.crossfire.jxclient.commands.SetCommand.getHelp().
Here is the caller graph for this function:| void com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions | ( | ) |
Loads all options' states from the backing settings instance.
Definition at line 109 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.Settings.getBoolean(), com.realtime.crossfire.jxclient.settings.options.OptionManager.options, and com.realtime.crossfire.jxclient.settings.options.OptionManager.settings.
Referenced by com.realtime.crossfire.jxclient.main.JXCWindow.JXCWindow().
Here is the call graph for this function: Here is the caller graph for this function:| void com.realtime.crossfire.jxclient.settings.options.OptionManager.removeOption | ( | @NotNull final String | optionName | ) |
Removes an option by name.
Does nothing if the option does not exist.
| optionName | the option name to remove |
Definition at line 77 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.options.
| void com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions | ( | ) |
Saves all options' states to the backing settings instance.
Definition at line 130 of file OptionManager.java.
References com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getDocumentation(), com.realtime.crossfire.jxclient.settings.options.OptionManager.Entry.getOption(), com.realtime.crossfire.jxclient.settings.options.Option.inhibitSave(), com.realtime.crossfire.jxclient.settings.options.OptionManager.options, com.realtime.crossfire.jxclient.settings.Settings.putBoolean(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.settings.
Referenced by com.realtime.crossfire.jxclient.main.JXCWindow.term().
Here is the call graph for this function: Here is the caller graph for this function:
|
private |
Maps option name to option instance.
Definition at line 42 of file OptionManager.java.
Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.addOption(), com.realtime.crossfire.jxclient.settings.options.OptionManager.getCheckBoxOption(), com.realtime.crossfire.jxclient.settings.options.OptionManager.getOptions(), com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions(), com.realtime.crossfire.jxclient.settings.options.OptionManager.removeOption(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions().
|
private |
The settings instance for loading/saving option values.
Definition at line 48 of file OptionManager.java.
Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions(), com.realtime.crossfire.jxclient.settings.options.OptionManager.OptionManager(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions().
1.8.17 
