com.realtime.crossfire.jxclient.settings.options.CheckBoxOption Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.settings.options.CheckBoxOption:

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

Public Member Functions
String	getTooltipText ()
boolean	isChecked ()
abstract boolean	isDefaultChecked ()
void	setChecked (final boolean checked)
void	toggleChecked ()
Public Member Functions inherited from com.realtime.crossfire.jxclient.settings.options.Option
void	addOptionListener (@NotNull final OptionListener listener)
boolean	inhibitSave ()
void	removeOptionListener (@NotNull final OptionListener listener)

Protected Member Functions
	CheckBoxOption (@NotNull final String tooltipText)
abstract void	execute (final boolean checked)
void	fireStateChangedEvent ()

Private Attributes
boolean	checked
final String	tooltipText

Detailed Description

The base class for all check box options. It manages the checked/unchecked state and notifies listeners about changes.

Author

Andreas Kirschbaum

Definition at line 32 of file CheckBoxOption.java.

Constructor & Destructor Documentation

CheckBoxOption()

com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.CheckBoxOption ( @NotNull final String  tooltipText )

protected

Creates a new instance.

Parameters

tooltipText

the tooltip text to explain this option

Definition at line 49 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.tooltipText.

Member Function Documentation

execute()

abstract void com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.execute ( final boolean  checked )

abstractprotected

Executes the action associated with this check box option. Must be implemented in subclasses.

Parameters

checked

whether the checkbox option is checked

Reimplemented in com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption, com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode, com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode, com.realtime.crossfire.jxclient.gui.gui.TranslucentDialogsCheckBoxOption, com.realtime.crossfire.jxclient.gui.log.ShowSentCommandsCheckBoxOption, com.realtime.crossfire.jxclient.gui.log.ShowTimestampMessagesCheckBoxOption, com.realtime.crossfire.jxclient.sound.SoundEffectsCheckBoxOption, and com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.

Referenced by com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.fireStateChangedEvent().

Here is the caller graph for this function:

fireStateChangedEvent()

void com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.fireStateChangedEvent ( )

protected

Notifies all listeners that the state has changed.

Reimplemented from com.realtime.crossfire.jxclient.settings.options.Option.

Definition at line 89 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.execute().

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions(), and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked().

Here is the call graph for this function:

Here is the caller graph for this function:

getTooltipText()

String com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.getTooltipText

(

)

Returns the tooltip text to explain this option.

Returns

the tooltip text

Definition at line 105 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.tooltipText.

Referenced by com.realtime.crossfire.jxclient.gui.misc.GUICheckBox.getTooltip().

Here is the caller graph for this function:

isChecked()

boolean com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.isChecked

(

)

Returns the current state.

Returns

the current state

Definition at line 57 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions(), com.realtime.crossfire.jxclient.gui.misc.GUICheckBox.paintComponent(), and com.realtime.crossfire.jxclient.settings.options.OptionManager.saveOptions().

Here is the caller graph for this function:

isDefaultChecked()

abstract boolean com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.isDefaultChecked ( )

abstract

Returns the default value of isChecked().

Returns

the default value

Reimplemented in com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption, com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode, com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode, com.realtime.crossfire.jxclient.gui.gui.TranslucentDialogsCheckBoxOption, com.realtime.crossfire.jxclient.gui.log.ShowSentCommandsCheckBoxOption, com.realtime.crossfire.jxclient.gui.log.ShowTimestampMessagesCheckBoxOption, com.realtime.crossfire.jxclient.sound.SoundEffectsCheckBoxOption, and com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.

Referenced by com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions().

Here is the caller graph for this function:

setChecked()

void com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked

(

final boolean

checked

)

Sets the current state.

Parameters

checked

the new state

Definition at line 65 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.fireStateChangedEvent().

Referenced by com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute(), com.realtime.crossfire.jxclient.commands.SetCommand.execute(), com.realtime.crossfire.jxclient.settings.options.OptionManager.loadOptions(), com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.setPickupMode(), com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.setPickupMode(), and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.toggleChecked().

Here is the call graph for this function:

Here is the caller graph for this function:

toggleChecked()

void com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.toggleChecked

(

)

Toggles the checked state.

Definition at line 77 of file CheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked().

Referenced by com.realtime.crossfire.jxclient.gui.misc.GUICheckBox.mouseClicked().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

checked

boolean com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked

private

The current state.

Definition at line 43 of file CheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.sound.SoundEffectsCheckBoxOption.execute(), com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.execute(), com.realtime.crossfire.jxclient.gui.gui.TranslucentDialogsCheckBoxOption.execute(), com.realtime.crossfire.jxclient.gui.log.ShowTimestampMessagesCheckBoxOption.execute(), com.realtime.crossfire.jxclient.gui.log.ShowSentCommandsCheckBoxOption.execute(), com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.execute(), com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.execute(), com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.execute(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.fireStateChangedEvent(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.isChecked(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked(), and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.toggleChecked().

tooltipText

final String com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.tooltipText

private

The tooltip text to explain this option.

Definition at line 38 of file CheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.CheckBoxOption(), com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.CommandCheckBoxOption(), com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.getTooltipText(), com.realtime.crossfire.jxclient.settings.options.PickupOption.PickupOption(), com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.PickupOptionNewMode(), and com.realtime.crossfire.jxclient.settings.options.PickupOptionOldMode.PickupOptionOldMode().

---

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

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