com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback:

Collaboration diagram for com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback:

Public Member Functions
void	accountCreate (@NotNull final String login, @NotNull final String password)
void	accountCreateCharacter (@NotNull final String login, @NotNull final Collection< String > attributes)
void	accountLink (final int force, @NotNull final String login, @NotNull final String password)
void	accountLogin (@NotNull final String login, @NotNull final String password)
void	accountPassword (@NotNull final String currentPassword, @NotNull final String newPassword)
void	accountPlayCharacter (@NotNull final String name)
void	activateCommandInput (@NotNull final String newText)
void	closeDialog (@NotNull final String dialog)
boolean	createKeyBinding (final boolean perCharacter, @NotNull final CommandList commandList)
CommandList	getCommandList (@NotNull final String args) throws NoSuchCommandException
Collection< String >	getCommandListNames ()
	GuiManagerCommandCallback (@NotNull final Exiter exiter, @NotNull final CrossfireServerConnection server)
void	init (@NotNull final GuiManager guiManager)
void	openDialog (@NotNull final String dialog)
void	quitApplication ()
boolean	removeKeyBinding (final boolean perCharacter)
void	toggleDialog (@NotNull final String dialog)
void	updatePlayerName (@NotNull final String playerName)

Private Attributes
final Exiter	exiter
GuiManager	guiManager
String	lastAccountPassword = ""
final CrossfireServerConnection	server

Detailed Description

A CommandCallback that delegates to a GuiManager.

Author

Andreas Kirschbaum

Definition at line 37 of file GuiManagerCommandCallback.java.

Constructor & Destructor Documentation

GuiManagerCommandCallback()

com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.GuiManagerCommandCallback	(	@NotNull final Exiter	exiter,
		@NotNull final CrossfireServerConnection	server
	)

Creates a new instance.

Parameters

exiter	the exiter instance
server	the crossfire server connection for sending commands

Definition at line 69 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.exiter, and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Member Function Documentation

accountCreate()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreate	(	@NotNull final String	login,
		@NotNull final String	password
	)

Creates an account.

Parameters

login	the account's name
password	the account's password

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 142 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.lastAccountPassword, com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountCreate(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

accountCreateCharacter()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreateCharacter	(	@NotNull final String	login,
		@NotNull final Collection< String >	attributes
	)

Creates a character. The password should be the last from accountLogin or accountCreate.

Parameters

login	the character's name
attributes	the character attributes

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 158 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.lastAccountPassword, com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountCharacterCreate(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

accountLink()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountLink	(	final int	force,
		@NotNull final String	login,
		@NotNull final String	password
	)

Links a character to the current account.

Parameters

force	0 to allow failure, 1 to force in certain situations
login	the character's name
password	the character's password

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 153 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountLink(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

accountLogin()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountLogin	(	@NotNull final String	login,
		@NotNull final String	password
	)

Login to an account.

Parameters

login	login
password	password

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 136 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.lastAccountPassword, com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountLogin(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

accountPassword()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountPassword	(	@NotNull final String	currentPassword,
		@NotNull final String	newPassword
	)

Change the account password.

Parameters

currentPassword	the current account password
newPassword	the new account password

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 163 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountPassword(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

accountPlayCharacter()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountPlayCharacter

(

@NotNull final String

name

)

Plays a character from the current account.

Parameters

name	the character's name

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 148 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.sendAccountPlay(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server.

Here is the call graph for this function:

activateCommandInput()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.activateCommandInput

(

@NotNull final String

newText

)

Activates the command input text field. If the skin defines more than one input field, the first matching one is selected.

If neither the main gui nor any visible dialog has an input text field, invisible GUIs are checked as well. If one is found, it is made visible.

Parameters

newText

the new command text if non- null

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 121 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.window.GuiManager.activateCommandInput(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Here is the call graph for this function:

closeDialog()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.closeDialog

(

@NotNull final String

dialog

)

Closes a dialog. Does nothing if the dialog is not open.

Parameters

dialog

the dialog to close

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 99 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.window.GuiManager.closeDialog(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Here is the call graph for this function:

createKeyBinding()

boolean com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.createKeyBinding	(	final boolean	perCharacter,
		@NotNull final CommandList	commandList
	)

Adds a key binding.

Parameters

perCharacter	whether a per-character key binding should be added
commandList	the command list to execute on key press

Returns

whether the key bindings dialog should be opened

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 126 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.window.GuiManager.createKeyBinding(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Here is the call graph for this function:

getCommandList()

CommandList com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.getCommandList

(

@NotNull final String

args

)

throws NoSuchCommandException

Returns a command list.

Parameters

args	the name of the command list

Returns

the command list

Exceptions

NoSuchCommandException

if the command list does not exist

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 105 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.window.GuiManager.getCommandList(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Here is the call graph for this function:

getCommandListNames()

Collection<String> com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.getCommandListNames

(

)

Returns all command list names.

Returns

the names in alphabetical order

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 111 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.window.GuiManager.getCommandListNames(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Here is the call graph for this function:

init()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.init

(

@NotNull final GuiManager

guiManager

)

Creates a new instance.

Parameters

guiManager

the gui manager to forward to

Definition at line 79 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager.

Referenced by com.realtime.crossfire.jxclient.main.JXClient.JXClient().

Here is the caller graph for this function:

openDialog()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.openDialog

(

@NotNull final String

dialog

)

Opens a dialog. Does nothing if the dialog is open.

Parameters

dialog

the dialog to open

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 89 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager, and com.realtime.crossfire.jxclient.window.GuiManager.openDialog().

Here is the call graph for this function:

quitApplication()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.quitApplication

(

)

Terminates the application.

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 84 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.exiter, and com.realtime.crossfire.jxclient.main.Exiter.terminate().

Here is the call graph for this function:

removeKeyBinding()

boolean com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.removeKeyBinding

(

final boolean

perCharacter

)

Removes a key binding.

Parameters

perCharacter

whether a per-character key binding should be removed

Returns

whether the key bindings dialog should be opened

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 131 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager, and com.realtime.crossfire.jxclient.window.GuiManager.removeKeyBinding().

Here is the call graph for this function:

toggleDialog()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.toggleDialog

(

@NotNull final String

dialog

)

Toggles a dialog.

Parameters

dialog

the dialog to toggle

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 94 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager, and com.realtime.crossfire.jxclient.window.GuiManager.toggleDialog().

Here is the call graph for this function:

updatePlayerName()

void com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.updatePlayerName

(

@NotNull final String

playerName

)

Sets the current player name. Does nothing if not currently in the character name prompt.

Parameters

playerName

the player name

Implements com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.

Definition at line 116 of file GuiManagerCommandCallback.java.

References com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager, and com.realtime.crossfire.jxclient.window.GuiManager.updatePlayerName().

Here is the call graph for this function:

Member Data Documentation

exiter

final Exiter com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.exiter

private

The Exiter instance.

Definition at line 43 of file GuiManagerCommandCallback.java.

Referenced by com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.GuiManagerCommandCallback(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.quitApplication().

guiManager

GuiManager com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.guiManager

private

The GuiManager to forward to.

Definition at line 49 of file GuiManagerCommandCallback.java.

Referenced by com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.activateCommandInput(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.closeDialog(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.createKeyBinding(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.getCommandList(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.getCommandListNames(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.init(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.openDialog(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.removeKeyBinding(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.toggleDialog(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.updatePlayerName().

lastAccountPassword

String com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.lastAccountPassword = ""

private

The last sent account or character password. Set to

"" 

if no password has been sent yet.

Definition at line 62 of file GuiManagerCommandCallback.java.

Referenced by com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreate(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreateCharacter(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountLogin().

server

final CrossfireServerConnection com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.server

private

The CrossfireServerConnection for sending commands.

Definition at line 55 of file GuiManagerCommandCallback.java.

Referenced by com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreate(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountCreateCharacter(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountLink(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountLogin(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountPassword(), com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.accountPlayCharacter(), and com.realtime.crossfire.jxclient.main.GuiManagerCommandCallback.GuiManagerCommandCallback().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/main/GuiManagerCommandCallback.java