Inheritance diagram for com.realtime.crossfire.jxclient.shortcuts.Shortcuts:

Collaboration diagram for com.realtime.crossfire.jxclient.shortcuts.Shortcuts:

Public Member Functions
void	addShortcutsListener (@NotNull final ShortcutsListener listener)

void	clearShortcuts ()

Path	getFile ()

Shortcut	getShortcut (@NotNull final ShortcutSlot shortcutSlot)

Iterator< Shortcut >	iterator ()

void	removeShortcutsListener (@NotNull final ShortcutsListener listener)

void	setFile (@Nullable final Path file)

void	setShortcutString (@NotNull final ShortcutSlot shortcutSlot, @NotNull final String command, final boolean saveChanges)

	Shortcuts (@NotNull final SpellsManager spellsManager)

Private Attributes
Path	file

final EventListenerList2< ShortcutsListener >	listeners = new EventListenerList2<>()

final Map< ShortcutSlot, Shortcut >	shortcuts = new EnumMap<>(ShortcutSlot.class)

final SpellsManager	spellsManager

final SpellsManagerListener	spellsManagerListener

Detailed Description

Manages a list of Shortcuts.

Author: Andreas Kirschbaum

Definition at line 43 of file Shortcuts.java.

Constructor & Destructor Documentation

◆ Shortcuts()

com.realtime.crossfire.jxclient.shortcuts.Shortcuts.Shortcuts ( @NotNull final SpellsManager spellsManager )

Creates a new instance.

Parameters

spellsManager the instance to watch

Definition at line 103 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts, com.realtime.crossfire.jxclient.shortcuts.Shortcuts.spellsManager, and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.spellsManagerListener.

Member Function Documentation

◆ addShortcutsListener()

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.addShortcutsListener ( @NotNull final ShortcutsListener listener )

Adds a ShortcutsListener.

Parameters

listener the listener to add

Definition at line 180 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.listeners.

◆ clearShortcuts()

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.clearShortcuts ( )

Clears all defined shortcuts.

Definition at line 114 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcut.dispose(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.listeners, and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts.

Here is the call graph for this function:

◆ getFile()

Path com.realtime.crossfire.jxclient.shortcuts.Shortcuts.getFile ( )

Returns the backing file.

Returns: the backing file or
null

if unknown

Definition at line 197 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.file.

◆ getShortcut()

Shortcut com.realtime.crossfire.jxclient.shortcuts.Shortcuts.getShortcut ( @NotNull final ShortcutSlot shortcutSlot )

Returns a shortcut.

Parameters

shortcutSlot the shortcut slot

Returns: the shortcut or
null

if the shortcut is unset

Definition at line 133 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts.

Referenced by com.realtime.crossfire.jxclient.commands.ShortcutCommand.listSlots().

Here is the caller graph for this function:

◆ iterator()

Iterator<Shortcut> com.realtime.crossfire.jxclient.shortcuts.Shortcuts.iterator ( )

Definition at line 211 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts.

◆ removeShortcutsListener()

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.removeShortcutsListener ( @NotNull final ShortcutsListener listener )

Removes a ShortcutsListener.

Parameters

listener the listener to remove

Definition at line 188 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.listeners.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemShortcut.dispose().

Here is the caller graph for this function:

◆ setFile()

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setFile ( @Nullable final Path file )

Sets the backing file.

Parameters

file	the backing file or null if unknown

Definition at line 205 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcuts.file.

◆ setShortcutString()

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcutString	(	@NotNull final ShortcutSlot	shortcutSlot,
		@NotNull final String	command,
		final boolean	saveChanges
	)

Sets a slot.

Parameters

shortcutSlot	the shortcut slot to update
command	the new command to set or an empty string to clear the slot
saveChanges	whether to save the change to the save file

Definition at line 143 of file Shortcuts.java.

References com.realtime.crossfire.jxclient.shortcuts.Shortcut.dispose(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.file, com.realtime.crossfire.jxclient.spells.SpellsManager.getSpell(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.listeners, com.realtime.crossfire.jxclient.window.ShortcutsLoader.saveShortcuts(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts, and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.spellsManager.

Referenced by com.realtime.crossfire.jxclient.commands.ShortcutCommand.deleteSlot(), and com.realtime.crossfire.jxclient.commands.ShortcutCommand.updateSlot().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ file

Path com.realtime.crossfire.jxclient.shortcuts.Shortcuts.file

private

The backing file.

Definition at line 56 of file Shortcuts.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.Shortcuts.getFile(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setFile(), and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcutString().

◆ listeners

final EventListenerList2<ShortcutsListener> com.realtime.crossfire.jxclient.shortcuts.Shortcuts.listeners = new EventListenerList2<>()

private

The listeners to be notified.

Definition at line 62 of file Shortcuts.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.Shortcuts.addShortcutsListener(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.clearShortcuts(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.removeShortcutsListener(), and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcutString().

◆ shortcuts

final Map<ShortcutSlot, Shortcut> com.realtime.crossfire.jxclient.shortcuts.Shortcuts.shortcuts = new EnumMap<>(ShortcutSlot.class)

private

The shortcuts. Maps shortcut slot to Shortcut. Unset entries are set to

null

.

Definition at line 50 of file Shortcuts.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.Shortcuts.clearShortcuts(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.getShortcut(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.iterator(), com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcutString(), and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.Shortcuts().

◆ spellsManager

final SpellsManager com.realtime.crossfire.jxclient.shortcuts.Shortcuts.spellsManager

private

The SpellsManager instance to watch.

Definition at line 68 of file Shortcuts.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcutString(), and com.realtime.crossfire.jxclient.shortcuts.Shortcuts.Shortcuts().

◆ spellsManagerListener

final SpellsManagerListener com.realtime.crossfire.jxclient.shortcuts.Shortcuts.spellsManagerListener

private

Initial value:

= new SpellsManagerListener() {
 
        @Override
        public void spellAdded(final int index) {
            for (final Entry<ShortcutSlot, Shortcut> e : shortcuts.entrySet()) {
                final Shortcut shortcut = e.getValue();
                if (shortcut != null) {
                    setShortcutString(e.getKey(), shortcut.getCommand(), false);
                }
            }
        }
 
        @Override
        public void spellRemoved(final int index) {
            for (final Entry<ShortcutSlot, Shortcut> e : shortcuts.entrySet()) {
                final Shortcut shortcut = e.getValue();
                if (shortcut != null) {
                    setShortcutString(e.getKey(), shortcut.getCommand(), false);
                }
            }
        }
 
    }

The SpellsManagerListener used to detect spell changes.

Definition at line 75 of file Shortcuts.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.Shortcuts.Shortcuts().

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/shortcuts/Shortcuts.java

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Shortcuts()

Member Function Documentation

◆ addShortcutsListener()

◆ clearShortcuts()

◆ getFile()

◆ getShortcut()

◆ iterator()

◆ removeShortcutsListener()

◆ setFile()

◆ setShortcutString()

Member Data Documentation

◆ file

◆ listeners

◆ shortcuts

◆ spellsManager

◆ spellsManagerListener