Package 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	Description
Shortcuts(@NotNull CommandQueue commandQueue, @NotNull SpellsManager spellsManager)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addShortcutsListener(@NotNull ShortcutsListener listener)	Adds a ShortcutsListener.
void	clearShortcuts()	Clears all defined shortcuts.
void	executeShortcut(int index)	Executes a shortcut.
@Nullable java.nio.file.Path	getFile()	Returns the backing file.
boolean	isModified()	Returns whether the shortcuts have been modified since creation or last call to resetModified().
@NotNull java.util.Iterator<Shortcut>	iterator()
void	removeShortcutsListener(@NotNull ShortcutsListener listener)	Removes a ShortcutsListener.
void	resetModified()	Resets the modified state.
void	setCommandShortcut(int index, @NotNull java.lang.String command)	Sets a Shortcut to a command.
void	setFile(@Nullable java.nio.file.Path file)	Sets the backing file.
void	setShortcut(int index, @Nullable Shortcut shortcut)	Sets a Shortcut.
void	setSpellShortcut(int index, @NotNull Spell spell, boolean cast)	Sets a Shortcut to a spell.
void	setSpellShortcut(int index, @NotNull java.lang.String spellName, boolean cast)	Sets a Shortcut to a spell.
void	unsetShortcut(int index)	Unsets a Shortcut.

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 CommandQueue commandQueue,
                 @NotNull
                 @NotNull SpellsManager spellsManager)

Creates a new instance.

Parameters:

commandQueue - the command queue for executing commands

spellsManager - the instance to watch

Method Detail

clearShortcuts

public void clearShortcuts()

Clears all defined shortcuts.

setShortcut

public void setShortcut(int index,
                        @Nullable
                        @Nullable Shortcut shortcut)

Sets a Shortcut.

Parameters:

index - the shortcut index

shortcut - the shortcut to set or null to unset

unsetShortcut

public void unsetShortcut(int index)

Unsets a Shortcut.

Parameters:

index - the shortcut index

setSpellShortcut

public void setSpellShortcut(int index,
                             @NotNull
                             @NotNull java.lang.String spellName,
                             boolean cast)

Sets a Shortcut to a spell.

Parameters:

index - the shortcut index

spellName - the spell name to cast or invoke

cast - whether the spell should be cast (true) or invoked (false)

setSpellShortcut

public void setSpellShortcut(int index,
                             @NotNull
                             @NotNull Spell spell,
                             boolean cast)

Sets a Shortcut to a spell.

Parameters:

index - the shortcut index

spell - the spell to cast or invoke

cast - whether the spell should be cast (true) or invoked (false)

setCommandShortcut

public void setCommandShortcut(int index,
                               @NotNull
                               @NotNull java.lang.String command)

Sets a Shortcut to a command.

Parameters:

index - the shortcut index

command - the command to execute

executeShortcut

public void executeShortcut(int index)

Executes a shortcut. Does nothing if the shortcut is unset.

Parameters:

index - the shortcut index

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

isModified

public boolean isModified()

Returns whether the shortcuts have been modified since creation or last call to resetModified().

Returns:

whether anything was modified

resetModified

public void resetModified()

Resets the modified state.

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>