Package com.realtime.crossfire.jxclient.shortcuts

Class ShortcutCommand

java.lang.Object

com.realtime.crossfire.jxclient.shortcuts.Shortcut

com.realtime.crossfire.jxclient.shortcuts.ShortcutCommand

public class ShortcutCommand
extends Shortcut

A Shortcut that executes a Crossfire command.

Constructor Summary

Constructors

Constructor	Description
ShortcutCommand(@NotNull CommandQueue commandQueue, @NotNull java.lang.String command)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	displaysFace(Face face)	Returns whether this shortcut displays the given face.
void	dispose()	Releases all allocated resources.
void	execute()	Executes the shortcut.
@NotNull java.lang.String	getCommand()	Returns the command to execute.
@NotNull java.lang.String	getTooltipText()	Returns the current tooltip text.
void	visit(@NotNull ShortcutVisitor visitor)	Calls a ShortcutVisitor's visit() function for this instance.

Methods inherited from class com.realtime.crossfire.jxclient.shortcuts.Shortcut

addShortcutListener, fireModifiedEvent, removeShortcutListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortcutCommand

public ShortcutCommand(@NotNull
                       @NotNull CommandQueue commandQueue,
                       @NotNull
                       @NotNull java.lang.String command)

Creates a new instance.

Parameters:

commandQueue - the command queue for sending commands

command - the command to execute

Method Detail

getCommand

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

Returns the command to execute.

Returns:

the command

dispose

public void dispose()

Description copied from class: Shortcut

Releases all allocated resources.

Specified by:

dispose in class Shortcut

execute

public void execute()

Description copied from class: Shortcut

Executes the shortcut.

Specified by:

execute in class Shortcut

getTooltipText

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

Description copied from class: Shortcut

Returns the current tooltip text.

Specified by:

getTooltipText in class Shortcut

Returns:

the tooltip text

visit

public void visit(@NotNull
                  @NotNull ShortcutVisitor visitor)

Description copied from class: Shortcut

Calls a ShortcutVisitor's visit() function for this instance.

Specified by:

visit in class Shortcut

Parameters:

visitor - the visitor to call

displaysFace

public boolean displaysFace(Face face)

Description copied from class: Shortcut

Returns whether this shortcut displays the given face.

Specified by:

displaysFace in class Shortcut

Parameters:

face - the face to check for

Returns:

whether the face is displayed