com.realtime.crossfire.jxclient.shortcuts

Class Shortcut

java.lang.Object

com.realtime.crossfire.jxclient.shortcuts.Shortcut

public class Shortcut
extends java.lang.Object

Abstract base class for shortcut commands.

Constructor Summary

Constructors

Constructor and Description
Shortcut(@NotNull java.lang.String command, @Nullable Spell spell) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addShortcutListener(@NotNull ShortcutListener listener) Registers a shortcut listener.
boolean	displaysFace(@NotNull Face face) Returns whether this shortcut displays the given face.
void	dispose() Releases all allocated resources.
@NotNull java.lang.String	getCommand() Returns the command to execute.
@Nullable Spell	getSpell() Returns the associated spell to cast.
@NotNull java.lang.String	getTooltipText() Returns the current tooltip text.
boolean	isImmediate() Returns whether the command should be executed immediately.
void	removeShortcutListener(@NotNull ShortcutListener listener) Unregisters a shortcut listener.
void	toggleImmediate() Toggles between immediate execution and activation only.

Methods inherited from class java.lang.Object

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

Constructor Detail

Shortcut

public Shortcut(@NotNull
                @NotNull java.lang.String command,
                @Nullable
                @Nullable Spell spell)

Creates a new instance.

Parameters:

command - the command to execute

spell - the spell associated with the command or null is the command is not a spell related command or if the spell is unknown

Method Detail

getCommand

@NotNull
public @NotNull java.lang.String getCommand()

Returns the command to execute.

Returns:

the command

getSpell

@Nullable
public @Nullable Spell getSpell()

Returns the associated spell to cast.

Returns:

the spell or null if the command is not a spell related command or if the spell is unknown

dispose

public void dispose()

Releases all allocated resources.

addShortcutListener

public void addShortcutListener(@NotNull
                                @NotNull ShortcutListener listener)

Registers a shortcut listener.

Parameters:

listener - the listener to register

removeShortcutListener

public void removeShortcutListener(@NotNull
                                   @NotNull ShortcutListener listener)

Unregisters a shortcut listener.

Parameters:

listener - the listener to unregister

getTooltipText

@NotNull
public @NotNull java.lang.String getTooltipText()

Returns the current tooltip text.

Returns:

the tooltip text

displaysFace

public boolean displaysFace(@NotNull
                            @NotNull Face face)

Returns whether this shortcut displays the given face.

Parameters:

face - the face to check for

Returns:

whether the face is displayed

isImmediate

public boolean isImmediate()

Returns whether the command should be executed immediately.

Returns:

true to execute immediately or false to only activate

toggleImmediate

public void toggleImmediate()

Toggles between immediate execution and activation only. Does nothing for other commands.