com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption:

Collaboration diagram for com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption:

Public Member Functions
boolean	isDefaultChecked ()
	SoundMusicCheckBoxOption (@NotNull final SoundManager soundManager)
Public Member Functions inherited from com.realtime.crossfire.jxclient.settings.options.CheckBoxOption
String	getTooltipText ()
boolean	isChecked ()
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
void	execute (final boolean checked)
Protected Member Functions inherited from com.realtime.crossfire.jxclient.settings.options.CheckBoxOption
	CheckBoxOption (@NotNull final String tooltipText)
void	fireStateChangedEvent ()

Private Attributes
final SoundManager	soundManager

Detailed Description

A CheckBoxOption that enables/disables background music.

Author

Andreas Kirschbaum

Definition at line 32 of file SoundMusicCheckBoxOption.java.

Constructor & Destructor Documentation

SoundMusicCheckBoxOption()

com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.SoundMusicCheckBoxOption

(

@NotNull final SoundManager

soundManager

)

Creates a new instance.

Parameters

soundManager

the sound manager instance to affect

Definition at line 44 of file SoundMusicCheckBoxOption.java.

References com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.soundManager.

Member Function Documentation

execute()

void com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.execute ( final boolean  checked )

protected

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

Parameters

checked

whether the checkbox option is checked

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

Definition at line 50 of file SoundMusicCheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, com.realtime.crossfire.jxclient.sound.SoundManager.setMusicEnabled(), and com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.soundManager.

Here is the call graph for this function:

isDefaultChecked()

boolean com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.isDefaultChecked

(

)

Returns the default value of isChecked().

Returns

the default value

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

Definition at line 55 of file SoundMusicCheckBoxOption.java.

Member Data Documentation

soundManager

final SoundManager com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.soundManager

private

The SoundManager instance to affect.

Definition at line 38 of file SoundMusicCheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.execute(), and com.realtime.crossfire.jxclient.sound.SoundMusicCheckBoxOption.SoundMusicCheckBoxOption().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/sound/SoundMusicCheckBoxOption.java