com.realtime.crossfire.jxclient.window.JXCConnection Class Reference

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

Public Member Functions
String	getHostname ()
int	getPort ()
	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)
void	setCharacter (@Nullable final String character)
void	setFrame (@Nullable final Frame frame)
void	setHost (@Nullable final String serverInfo)

Private Member Functions
void	connect ()
void	disconnect (@NotNull final String reason)
void	updateTitle ()

Private Attributes
String	character
final Pickup	characterPickup
final CrossfirePickupListener	crossfirePickupListener
Frame	frame
final GuiStateListener	guiStateListener
String	hostname
final KeybindingsManager	keybindingsManager
final Logger	logger
int	port
final CrossfireServerConnection	server
final Settings	settings
final Shortcuts	shortcuts

Static Private Attributes
static final int	DEFAULT_CROSSFIRE_PORT = 13327
static final String	TITLE_PREFIX = "jxclient"

Detailed Description

Definition at line 41 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 182 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 206 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 214 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 222 of file JXCConnection.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.addCrossfirePickupListener(), com.realtime.crossfire.jxclient.window.JXCConnection.character, com.realtime.crossfire.jxclient.window.JXCConnection.characterPickup, com.realtime.crossfire.jxclient.window.JXCConnection.crossfirePickupListener, com.realtime.crossfire.jxclient.settings.Settings.getLong(), com.realtime.crossfire.jxclient.settings.options.Pickup.getPickupMode(), com.realtime.crossfire.jxclient.settings.SettingsEntries.getPickupSettingsEntry(), com.realtime.crossfire.jxclient.window.JXCConnection.hostname, com.realtime.crossfire.jxclient.window.JXCConnection.keybindingsManager, com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.loadPerCharacterBindings(), com.realtime.crossfire.jxclient.window.ShortcutsLoader.loadShortcuts(), com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NOTHING, com.realtime.crossfire.jxclient.settings.Settings.putLong(), com.realtime.crossfire.jxclient.settings.Settings.remove(), com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.removeCrossfirePickupListener(), com.realtime.crossfire.jxclient.window.JXCConnection.server, com.realtime.crossfire.jxclient.window.JXCConnection.settings, com.realtime.crossfire.jxclient.window.JXCConnection.shortcuts, com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.unloadPerCharacterBindings(), com.realtime.crossfire.jxclient.settings.options.Pickup.updatePickupMode(), and com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

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 196 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.

References com.realtime.crossfire.jxclient.window.JXCConnection.DEFAULT_CROSSFIRE_PORT, com.realtime.crossfire.jxclient.window.JXCConnection.hostname, com.realtime.crossfire.jxclient.window.JXCConnection.logger, com.realtime.crossfire.jxclient.util.NumberParser.parseInt(), com.realtime.crossfire.jxclient.window.JXCConnection.port, com.realtime.crossfire.jxclient.settings.Settings.putString(), com.realtime.crossfire.jxclient.settings.SettingsEntries.SERVER, com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), com.realtime.crossfire.jxclient.window.Logger.setHostname(), com.realtime.crossfire.jxclient.window.JXCConnection.settings, and com.realtime.crossfire.jxclient.window.JXCConnection.updateTitle().

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.frame, 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 112 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 82 of file JXCConnection.java.

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

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 163 of file JXCConnection.java.

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

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 46 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 76 of file JXCConnection.java.

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

guiStateListener

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

private

The GuiStateListener for detecting established or dropped connections.

Definition at line 120 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 101 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.setCharacter(), 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 58 of file JXCConnection.java.

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

logger

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

private

The Logger that is notified about changed server names.

Definition at line 95 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 106 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 89 of file JXCConnection.java.

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

settings

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

private

The settings instance to use.

Definition at line 70 of file JXCConnection.java.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.JXCConnection(), com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter(), 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 64 of file JXCConnection.java.

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

TITLE_PREFIX

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

staticprivate

The prefix for the window title.

Definition at line 52 of file JXCConnection.java.

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

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/window/JXCConnection.java