Package com.realtime.crossfire.jxclient.settings.options

Class PickupOption

java.lang.Object

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

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

com.realtime.crossfire.jxclient.settings.options.PickupOption

public class PickupOption
extends CheckBoxOption

A CheckBoxOption that toggles a pickup setting.

Constructor Summary

Constructors

Constructor	Description
PickupOption(@NotNull Pickup pickup, long option, @NotNull java.lang.String tooltipText)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	execute(boolean checked)	Executes the action associated with this check box option.
boolean	inhibitSave()	Returns whether the option should not be saved.
boolean	isDefaultChecked()	Returns the default value of CheckBoxOption.isChecked().
void	setPickupMode(long pickupMode)	Notifies this instance that the pickup mode has changed.

Methods inherited from class com.realtime.crossfire.jxclient.settings.options.CheckBoxOption

fireStateChangedEvent, getTooltipText, isChecked, setChecked, toggleChecked

Methods inherited from class com.realtime.crossfire.jxclient.settings.options.Option

addOptionListener, removeOptionListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PickupOption

public PickupOption(@NotNull
                    @NotNull Pickup pickup,
                    long option,
                    @NotNull
                    @NotNull java.lang.String tooltipText)

Creates a new instance.

Parameters:

pickup - the pickup instance for modifying the pickup mode

option - the affected pickup mode

tooltipText - the tooltip text to explain this option

Method Detail

execute

protected void execute(boolean checked)

Description copied from class: CheckBoxOption

Executes the action associated with this check box option. Must be implemented in sub-classes.

Specified by:

execute in class CheckBoxOption

Parameters:

checked - whether the check box option is checked

isDefaultChecked

public boolean isDefaultChecked()

Description copied from class: CheckBoxOption

Returns the default value of CheckBoxOption.isChecked().

Specified by:

isDefaultChecked in class CheckBoxOption

Returns:

the default value

inhibitSave

public boolean inhibitSave()

Description copied from class: Option

Returns whether the option should not be saved. This function can be overridden for options that are otherwise saved, or for options that should not be saved at all.

Overrides:

inhibitSave in class Option

Returns:

whether the option value should not be saved

setPickupMode

public void setPickupMode(long pickupMode)

Notifies this instance that the pickup mode has changed.

Parameters:

pickupMode - the new pickup mode