com.realtime.crossfire.jxclient.shortcuts

Class Shortcuts

java.lang.Object

com.realtime.crossfire.jxclient.shortcuts.Shortcuts

All Implemented Interfaces:

java.lang.Iterable<Shortcut>

public class Shortcuts
extends java.lang.Object
implements java.lang.Iterable<Shortcut>

Manages a list of Shortcuts.

Constructor Summary

Constructors

Constructor and Description
Shortcuts(@NotNull SpellsManager spellsManager) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addShortcutsListener(@NotNull ShortcutsListener listener) Adds a ShortcutsListener.
void	clearShortcuts() Clears all defined shortcuts.
@Nullable java.nio.file.Path	getFile() Returns the backing file.
@Nullable Shortcut	getShortcut(@NotNull ShortcutSlot shortcutSlot) Returns a shortcut.
@NotNull java.util.Iterator<Shortcut>	iterator()
void	removeShortcutsListener(@NotNull ShortcutsListener listener) Removes a ShortcutsListener.
void	setFile(@Nullable java.nio.file.Path file) Sets the backing file.
void	setShortcutString(@NotNull ShortcutSlot shortcutSlot, @NotNull java.lang.String command, boolean saveChanges) Sets a slot.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Shortcuts

public Shortcuts(@NotNull
                 @NotNull SpellsManager spellsManager)

Creates a new instance.

Parameters:

spellsManager - the instance to watch

Method Detail

clearShortcuts

public void clearShortcuts()

Clears all defined shortcuts.

getShortcut

@Nullable
public @Nullable Shortcut getShortcut(@NotNull
                                                @NotNull ShortcutSlot shortcutSlot)

Returns a shortcut.

Parameters:

shortcutSlot - the shortcut slot

Returns:

the shortcut or null if the shortcut is unset

setShortcutString

public void setShortcutString(@NotNull
                              @NotNull ShortcutSlot shortcutSlot,
                              @NotNull
                              @NotNull java.lang.String command,
                              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

addShortcutsListener

public void addShortcutsListener(@NotNull
                                 @NotNull ShortcutsListener listener)

Adds a ShortcutsListener.

Parameters:

listener - the listener to add

removeShortcutsListener

public void removeShortcutsListener(@NotNull
                                    @NotNull ShortcutsListener listener)

Removes a ShortcutsListener.

Parameters:

listener - the listener to remove

getFile

@Nullable
public @Nullable java.nio.file.Path getFile()

Returns the backing file.

Returns:

the backing file or null if unknown

setFile

public void setFile(@Nullable
                    @Nullable java.nio.file.Path file)

Sets the backing file.

Parameters:

file - the backing file or null if unknown

iterator

@NotNull
public @NotNull java.util.Iterator<Shortcut> iterator()

Specified by:

iterator in interface java.lang.Iterable<Shortcut>