com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption:

Public Member Functions
	CommandCheckBoxOption (final boolean defaultChecked, @NotNull final CommandList commandOn, @NotNull final CommandList commandOff, @NotNull final String tooltipText)
boolean	isDefaultChecked ()
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 CommandList	commandOff
final CommandList	commandOn
final boolean	defaultChecked

Detailed Description

A CheckBoxOption that executes CommandLists when checked/unchecked.

Author

Andreas Kirschbaum

Definition at line 34 of file CommandCheckBoxOption.java.

Constructor & Destructor Documentation

CommandCheckBoxOption()

com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.CommandCheckBoxOption	(	final boolean	defaultChecked,
		@NotNull final CommandList	commandOn,
		@NotNull final CommandList	commandOff,
		@NotNull final String	tooltipText
	)

Creates a new instance.

Parameters

defaultChecked	the default value
commandOn	the command list to execute when checked
commandOff	the command list to execute when unchecked
tooltipText	the tooltip text to explain this option

Definition at line 60 of file CommandCheckBoxOption.java.

References com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOff, com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOn, com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.defaultChecked, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.tooltipText.

Member Function Documentation

execute()

void com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.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 68 of file CommandCheckBoxOption.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOff, com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOn, and com.realtime.crossfire.jxclient.gui.commandlist.CommandList.execute().

Here is the call graph for this function:

isDefaultChecked()

boolean com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.isDefaultChecked

(

)

Returns the default value of isChecked().

Returns

the default value

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

Definition at line 77 of file CommandCheckBoxOption.java.

References com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.defaultChecked.

Member Data Documentation

commandOff

final CommandList com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOff

private

The command list to execute when unchecked.

Definition at line 51 of file CommandCheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.CommandCheckBoxOption(), and com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.execute().

commandOn

final CommandList com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.commandOn

private

The command list to execute when checked.

Definition at line 45 of file CommandCheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.CommandCheckBoxOption(), and com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.execute().

defaultChecked

final boolean com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.defaultChecked

private

The default value.

Definition at line 39 of file CommandCheckBoxOption.java.

Referenced by com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.CommandCheckBoxOption(), and com.realtime.crossfire.jxclient.gui.commands.CommandCheckBoxOption.isDefaultChecked().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/commands/CommandCheckBoxOption.java