Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.commands.BindCommand Class Reference

Crossfire JXClient, Trunk

Inheritance diagram for com.realtime.crossfire.jxclient.commands.BindCommand:

Inheritance graph

Collaboration diagram for com.realtime.crossfire.jxclient.commands.BindCommand:

Collaboration graph

Public Member Functions
boolean	allArguments ()

	BindCommand (@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final CommandCallback commandCallback, @NotNull final GUICommandFactory guiCommandFactory)

void	execute (@NotNull final String args)

String	getHelp ()

Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand
String	getCommandName ()

String	toString ()

Private Attributes
final CommandCallback	commandCallback

final GUICommandFactory	guiCommandFactory

Additional Inherited Members
Protected Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand
	AbstractCommand (@NotNull final String commandName, @NotNull final CrossfireServerConnection crossfireServerConnection)

void	drawInfo (@NotNull final String message)

void	drawInfo (@NotNull final String message, final int color)

void	drawInfoError (@NotNull final String message)

Detailed Description

Implements the "bind" command. It associates a key with a command.

Author: Andreas Kirschbaum

Definition at line 37 of file BindCommand.java.

Constructor & Destructor Documentation

◆ BindCommand()

com.realtime.crossfire.jxclient.commands.BindCommand.BindCommand	(	@NotNull final CrossfireServerConnection	crossfireServerConnection,
		@NotNull final CommandCallback	commandCallback,
		@NotNull final GUICommandFactory	guiCommandFactory
	)

Creates a new instance.

Parameters

crossfireServerConnection	the connection instance
commandCallback	the command callback to use
guiCommandFactory	the gui command factory for creating commands

Definition at line 57 of file BindCommand.java.

References com.realtime.crossfire.jxclient.commands.BindCommand.commandCallback, com.realtime.crossfire.jxclient.commands.AbstractCommand.crossfireServerConnection, and com.realtime.crossfire.jxclient.commands.BindCommand.guiCommandFactory.

Member Function Documentation

◆ allArguments()

boolean com.realtime.crossfire.jxclient.commands.BindCommand.allArguments ( )

Returns whether all remaining commands should be included as arguments.

Returns: whether all remaining commands should be included as arguments

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 64 of file BindCommand.java.

◆ execute()

void com.realtime.crossfire.jxclient.commands.BindCommand.execute ( @NotNull final String args )

Executes the command with the given arguments.

Parameters

args	the command arguments

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 69 of file BindCommand.java.

References com.realtime.crossfire.jxclient.gui.commandlist.CommandList.add(), com.realtime.crossfire.jxclient.gui.commandlist.CommandListType.AND, com.realtime.crossfire.jxclient.commands.BindCommand.commandCallback, com.realtime.crossfire.jxclient.gui.commandlist.GUICommandFactory.createCommand(), com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.createKeyBinding(), com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfoError(), com.realtime.crossfire.jxclient.commands.BindCommand.guiCommandFactory, and com.realtime.crossfire.jxclient.util.StringUtils.trimLeading().

Here is the call graph for this function:

◆ getHelp()

String com.realtime.crossfire.jxclient.commands.BindCommand.getHelp ( )

Returns the help text for this command.

Returns: the help text

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 99 of file BindCommand.java.

Member Data Documentation

◆ commandCallback

final CommandCallback com.realtime.crossfire.jxclient.commands.BindCommand.commandCallback

private

The CommandCallback to use.

Definition at line 43 of file BindCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.BindCommand.BindCommand(), and com.realtime.crossfire.jxclient.commands.BindCommand.execute().

◆ guiCommandFactory

final GUICommandFactory com.realtime.crossfire.jxclient.commands.BindCommand.guiCommandFactory

private

The GUICommandFactory for creating commands.

Definition at line 49 of file BindCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.BindCommand.BindCommand(), and com.realtime.crossfire.jxclient.commands.BindCommand.execute().

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/commands/BindCommand.java