Crossfire JXClient, Trunk
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode Class Reference
Inheritance diagram for com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode:
Inheritance graph
Collaboration diagram for com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode:
Collaboration graph

Public Member Functions

boolean inhibitSave ()
 
boolean isDefaultChecked ()
 
 PickupOptionNewMode (@NotNull final Pickup pickup, final long option, @NotNull final String tooltipText)
 
void setPickupMode (final long pickupMode)
 
- 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)
 
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.PickupOption
 PickupOption (final @NotNull String tooltipText)
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.settings.options.CheckBoxOption
 CheckBoxOption (@NotNull final String tooltipText)
 
void fireStateChangedEvent ()
 

Private Attributes

final long option
 
final Pickup pickup
 

Detailed Description

A CheckBoxOption that toggles a pickup setting in Pickup#PU_NEW_MODE.

Author
Andreas Kirschbaum

Definition at line 32 of file PickupOptionNewMode.java.

Constructor & Destructor Documentation

◆ PickupOptionNewMode()

com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.PickupOptionNewMode ( @NotNull final Pickup  pickup,
final long  option,
@NotNull final String  tooltipText 
)

Creates a new instance.

Parameters
pickupthe pickup instance for modifying the pickup mode
optionthe affected pickup mode
tooltipTextthe tooltip text to explain this option

Definition at line 51 of file PickupOptionNewMode.java.

References com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.option, com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.pickup, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.tooltipText.

Member Function Documentation

◆ execute()

void com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.execute ( final boolean  checked)
protected

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

Parameters
checkedwhether the checkbox option is checked

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

Definition at line 58 of file PickupOptionNewMode.java.

References com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.checked, com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.option, com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.pickup, and com.realtime.crossfire.jxclient.settings.options.Pickup.setPickupModeNewMode().

Here is the call graph for this function:

◆ inhibitSave()

boolean com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.inhibitSave ( )

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.

Returns
whether the option value should not be saved

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

Definition at line 69 of file PickupOptionNewMode.java.

◆ isDefaultChecked()

boolean com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.isDefaultChecked ( )

Returns the default value of isChecked().

Returns
the default value

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

Definition at line 63 of file PickupOptionNewMode.java.

◆ setPickupMode()

void com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.setPickupMode ( final long  pickupMode)

Notifies this instance that the pickup mode has changed.

Parameters
pickupModethe new pickup mode

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

Definition at line 74 of file PickupOptionNewMode.java.

References com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.option, com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NEW_MODE, and com.realtime.crossfire.jxclient.settings.options.CheckBoxOption.setChecked().

Here is the call graph for this function:

Member Data Documentation

◆ option

final long com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.option
private

◆ pickup

final Pickup com.realtime.crossfire.jxclient.settings.options.PickupOptionNewMode.pickup
private

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