Collaboration diagram for com.realtime.crossfire.jxclient.window.JXCConnection:

Public Member Functions
String	getHostname ()
	Returns the currently connected server. More...

int	getPort ()
	Returns the currently connected port. More...

	JXCConnection (@NotNull final KeybindingsManager keybindingsManager, @NotNull final Shortcuts shortcuts, @NotNull final Settings settings, @NotNull final Pickup characterPickup, @NotNull final CrossfireServerConnection server, @NotNull final GuiStateManager guiStateManager, @NotNull final Logger logger)
	Creates a new instance. More...

void	setCharacter (@Nullable final String character)
	Updates the active character name. More...

void	setFrame (@Nullable final Frame frame)
	Sets the Frame for updating the title. More...

void	setHost (@Nullable final String serverInfo)
	Updates information about the connected host. More...

Private Member Functions
void	connect ()
	Connects to the Crossfire server. More...

void	disconnect (@NotNull final String reason)
	Disconnects from the Crossfire server. More...

void	updateTitle ()
	Updates the window title to reflect the current connection state. More...

Private Attributes
String	character
	The currently logged in character. More...

final Pickup	characterPickup
	The Pickup instance to update. More...

final CrossfirePickupListener	crossfirePickupListener
	The CrossfirePickupListener for tracking pickup mode changes. More...

Frame	frame
	The Frame for updating the title or. More...

final GuiStateListener	guiStateListener
	The GuiStateListener for detecting established or dropped connections. More...

String	hostname
	The currently connected server. More...

final KeybindingsManager	keybindingsManager
	The KeybindingsManager to update. More...

final Logger	logger
	The Logger that is notified about changed server names. More...

int	port
	The currently connected port. More...

final CrossfireServerConnection	server
	The CrossfireServerConnection instance used to connect to the Crossfire server. More...

final Settings	settings
	The settings instance to use. More...

final Shortcuts	shortcuts
	The Shortcuts to update. More...

Static Private Attributes
static final int	DEFAULT_CROSSFIRE_PORT = 13327
	The default port number for Crossfire servers. More...

static final String	TITLE_PREFIX = "jxclient"
	The prefix for the window title. More...

Detailed Description

Definition at line 39 of file JXCConnection.java.

Constructor & Destructor Documentation

◆ JXCConnection()

com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection	(	@NotNull final KeybindingsManager	keybindingsManager,
		@NotNull final Shortcuts	shortcuts,
		@NotNull final Settings	settings,
		@NotNull final Pickup	characterPickup,
		@NotNull final CrossfireServerConnection	server,
		@NotNull final GuiStateManager	guiStateManager,
		@NotNull final Logger	logger
	)

Creates a new instance.

Parameters

keybindingsManager	the keybindings manager to update
shortcuts	the shortcuts to update
settings	the settings instance to use
characterPickup	the character pickup instance to update
server	the crossfire server connection instance used to connect
guiStateManager	the gui state manager to watch
logger	the logger to notify about changed server names

Definition at line 180 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.window.JXCConnection.characterPickup, com.realtime.crossfire.jxclient.window.JXCConnection.guiStateListener, com.realtime.crossfire.jxclient.window.JXCConnection.keybindingsManager, com.realtime.crossfire.jxclient.window.JXCConnection.logger, com.realtime.crossfire.jxclient.window.JXCConnection.server, com.realtime.crossfire.jxclient.window.JXCConnection.settings, and com.realtime.crossfire.jxclient.window.JXCConnection.shortcuts.

Member Function Documentation

◆ connect()

void com.realtime.crossfire.jxclient.window.JXCConnection.connect ( )

private

Connects to the Crossfire server.

Definition at line 309 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.server.server.ServerConnection.connect(), com.realtime.crossfire.jxclient.window.JXCConnection.hostname, com.realtime.crossfire.jxclient.window.JXCConnection.port, and com.realtime.crossfire.jxclient.window.JXCConnection.server.

Here is the call graph for this function:

◆ disconnect()

void com.realtime.crossfire.jxclient.window.JXCConnection.disconnect ( @NotNull final String reason )

private

Disconnects from the Crossfire server.

Parameters

reason the reason for the disconnect

Definition at line 301 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.server.server.ServerConnection.disconnect(), com.realtime.crossfire.jxclient.window.JXCConnection.server, and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

Here is the call graph for this function:

◆ getHostname()

String com.realtime.crossfire.jxclient.window.JXCConnection.getHostname ( )

Returns the currently connected server.

Returns: the server or
null
if unconnected

Definition at line 204 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.window.JXCConnection.hostname.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.openDialog(), com.realtime.crossfire.jxclient.window.GuiManager.openQueryDialog(), com.realtime.crossfire.jxclient.window.GuiManager.selectCharacter(), com.realtime.crossfire.jxclient.window.GuiManager.setAccountName(), and com.realtime.crossfire.jxclient.window.GuiManager.updatePlayerName().

Here is the caller graph for this function:

◆ getPort()

int com.realtime.crossfire.jxclient.window.JXCConnection.getPort ( )

Returns the currently connected port.

Returns: the port or
0
if unconnected

Definition at line 212 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.window.JXCConnection.port.

◆ setCharacter()

void com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter ( @Nullable final String character )

Updates the active character name.

Parameters

character

the active character;

null

if not logged in

Definition at line 220 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrame()

void com.realtime.crossfire.jxclient.window.JXCConnection.setFrame ( @Nullable final Frame frame )

Sets the Frame for updating the title.

Parameters

frame

the frame or

null

Definition at line 194 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.window.JXCConnection.frame, and com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

Here is the call graph for this function:

◆ setHost()

void com.realtime.crossfire.jxclient.window.JXCConnection.setHost ( @Nullable final String serverInfo )

Updates information about the connected host.

Parameters

serverInfo

the hostname;

null

if not connected

Definition at line 273 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateTitle()

void com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle ( )

private

Updates the window title to reflect the current connection state.

Definition at line 254 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.window.JXCConnection.character, com.realtime.crossfire.jxclient.window.JXCConnection.hostname, and com.realtime.crossfire.jxclient.window.JXCConnection.TITLE_PREFIX.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), com.realtime.crossfire.jxclient.window.JXCConnection.setFrame(), and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

Here is the caller graph for this function:

Member Data Documentation

◆ character

String com.realtime.crossfire.jxclient.window.JXCConnection.character

private

The currently logged in character.

Set to

null

if not logged in.

Definition at line 110 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), and com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

◆ characterPickup

final Pickup com.realtime.crossfire.jxclient.window.JXCConnection.characterPickup

private

The Pickup instance to update.

Definition at line 80 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection().

◆ crossfirePickupListener

final CrossfirePickupListener com.realtime.crossfire.jxclient.window.JXCConnection.crossfirePickupListener

private

Initial value:

= new CrossfirePickupListener() {
        @Override
        public void pickupChanged(final int pickupOptions) {
            characterPickup.updatePickupMode(pickupOptions, false);
        }
    }

The CrossfirePickupListener for tracking pickup mode changes.

Definition at line 161 of file JXCConnection.java.

◆ DEFAULT_CROSSFIRE_PORT

final int com.realtime.crossfire.jxclient.window.JXCConnection.DEFAULT_CROSSFIRE_PORT = 13327

staticprivate

The default port number for Crossfire servers.

Definition at line 44 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

◆ frame

Frame com.realtime.crossfire.jxclient.window.JXCConnection.frame

private

The Frame for updating the title or.

null

.

Definition at line 74 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setFrame().

◆ guiStateListener

final GuiStateListener com.realtime.crossfire.jxclient.window.JXCConnection.guiStateListener

private

The GuiStateListener for detecting established or dropped connections.

Definition at line 118 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection().

◆ hostname

String com.realtime.crossfire.jxclient.window.JXCConnection.hostname

private

The currently connected server.

Set to

null

if unconnected.

Definition at line 99 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.connect(), com.realtime.crossfire.jxclient.window.JXCConnection.getHostname(), com.realtime.crossfire.jxclient.window.JXCConnection.setHost(), and com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

◆ keybindingsManager

final KeybindingsManager com.realtime.crossfire.jxclient.window.JXCConnection.keybindingsManager

private

The KeybindingsManager to update.

Definition at line 56 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection().

◆ logger

final Logger com.realtime.crossfire.jxclient.window.JXCConnection.logger

private

The Logger that is notified about changed server names.

Definition at line 93 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection(), and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

◆ port

int com.realtime.crossfire.jxclient.window.JXCConnection.port

private

The currently connected port.

Only valid if hostname is set.

Definition at line 104 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.connect(), com.realtime.crossfire.jxclient.window.JXCConnection.getPort(), and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

◆ server

final CrossfireServerConnection com.realtime.crossfire.jxclient.window.JXCConnection.server

private

The CrossfireServerConnection instance used to connect to the Crossfire server.

Definition at line 87 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.connect(), com.realtime.crossfire.jxclient.window.JXCConnection.disconnect(), and com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection().

◆ settings

final Settings com.realtime.crossfire.jxclient.window.JXCConnection.settings

private

The settings instance to use.

Definition at line 68 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection(), and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().

◆ shortcuts

final Shortcuts com.realtime.crossfire.jxclient.window.JXCConnection.shortcuts

private

The Shortcuts to update.

Definition at line 62 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection().

◆ TITLE_PREFIX

final String com.realtime.crossfire.jxclient.window.JXCConnection.TITLE_PREFIX = "jxclient"

staticprivate

The prefix for the window title.

Definition at line 50 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

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

crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/window/JXCConnection.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JXCConnection()

Member Function Documentation

◆ connect()

◆ disconnect()

◆ getHostname()

◆ getPort()

◆ setCharacter()

◆ setFrame()

◆ setHost()

◆ updateTitle()

Member Data Documentation

◆ character

◆ characterPickup

◆ crossfirePickupListener

◆ DEFAULT_CROSSFIRE_PORT

◆ frame

◆ guiStateListener

◆ hostname

◆ keybindingsManager

◆ logger

◆ port

◆ server

◆ settings

◆ shortcuts

◆ TITLE_PREFIX