Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.settings.options.OptionManager Class Reference

Crossfire JXClient, Trunk

Collaboration diagram for com.realtime.crossfire.jxclient.settings.options.OptionManager:

Collaboration graph

Classes
class	Entry

Public Member Functions
void	addOption (@NotNull final String optionName, @NotNull final String documentation, @NotNull final Option option) throws OptionException

CheckBoxOption	getCheckBoxOption (@NotNull final String optionName) throws OptionException

Map< String, Entry >	getOptions ()

void	loadOptions ()

	OptionManager (@NotNull final Settings settings)

void	removeOption (@NotNull final String optionName)

void	saveOptions ()

Private Attributes
final Map< String, Entry >	options = new HashMap<>()

final Settings	settings

Detailed Description

Maintains a set of named options.

Author: Andreas Kirschbaum

Definition at line 36 of file OptionManager.java.

Constructor & Destructor Documentation

◆ OptionManager()

com.realtime.crossfire.jxclient.settings.options.OptionManager.OptionManager ( @NotNull final Settings settings )

Creates a new instance.

Parameters

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.

Member Function Documentation

◆ addOption()

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.

Parameters

optionName	the option name to add
documentation	the documentation string for the settings
option	the option to add

Exceptions

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:

◆ getCheckBoxOption()

CheckBoxOption com.realtime.crossfire.jxclient.settings.options.OptionManager.getCheckBoxOption ( @NotNull final String optionName ) throws OptionException

Returns a checkbox option.

Parameters

optionName the option name to look up

Returns: the option

Exceptions

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:

◆ getOptions()

Map<String, Entry> com.realtime.crossfire.jxclient.settings.options.OptionManager.getOptions ( )

Returns all defined option names.

Returns: the 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:

◆ loadOptions()

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.options.CheckBoxOption.fireStateChangedEvent(), com.realtime.crossfire.jxclient.settings.Settings.getBoolean(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.isChecked(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.isDefaultChecked(), com.realtime.crossfire.jxclient.settings.options.OptionManager.options, com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked(), 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:

◆ removeOption()

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.

Parameters

optionName the option name to remove

Definition at line 77 of file OptionManager.java.

References com.realtime.crossfire.jxclient.settings.options.OptionManager.options.

◆ saveOptions()

void com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions ( )

Saves all options' states to the backing settings instance.

Definition at line 131 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.CheckBoxOption.isChecked(), 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:

Member Data Documentation

◆ options

final Map<String, Entry> com.realtime.crossfire.jxclient.settings.options.OptionManager.options = new HashMap<>()

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().

◆ settings

final Settings com.realtime.crossfire.jxclient.settings.options.OptionManager.settings

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().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/settings/options/OptionManager.java