com.realtime.crossfire.jxclient.guistate.GuiStateManager Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.guistate.GuiStateManager:

Collaboration diagram for com.realtime.crossfire.jxclient.guistate.GuiStateManager:

Public Member Functions
void	addGuiStateListener (@NotNull final GuiStateListener listener)
void	changeGUI (@NotNull final GuiState guiState)
void	connect (@NotNull final String serverInfo)
void	disconnect ()
void	disconnected ()
void	disconnecting (@NotNull final String reason, final boolean isError)
GuiState	getGuiState ()
void	removeGuiStateListener (@NotNull final GuiStateListener listener)
void	setClientSocketState (@NotNull final ClientSocketState clientSocketState, @NotNull final String param)

Protected Member Functions
abstract void	doChangeGUI (@NotNull final Runnable runnable)
	GuiStateManager ()

Private Member Functions
void	changeGUI (@NotNull final GuiState guiState, @NotNull final String param)

Private Attributes
GuiState	guiState
final EventListenerList2< GuiStateListener >	guiStateListeners = new EventListenerList2<>()
final Object	sync = new Object()

Detailed Description

Maintains the current GuiState. Notifies registered listeners about changes.

Author

Andreas Kirschbaum

Definition at line 34 of file GuiStateManager.java.

Constructor & Destructor Documentation

GuiStateManager()

com.realtime.crossfire.jxclient.guistate.GuiStateManager.GuiStateManager ( )

protected

Creates a new instance.

Definition at line 57 of file GuiStateManager.java.

Member Function Documentation

addGuiStateListener()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.addGuiStateListener

(

@NotNull final GuiStateListener

listener

)

Adds a gui state listener.

Parameters

listener

the listener to add

Definition at line 164 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners.

Referenced by com.realtime.crossfire.jxclient.skin.events.ConnectionStateSkinEvent.ConnectionStateSkinEvent().

Here is the caller graph for this function:

changeGUI() [1/2]

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI

(

@NotNull final GuiState

guiState

)

Sets a new GuiState.

Parameters

guiState

the new gui state

Definition at line 64 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.doChangeGUI(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState, com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync.

Referenced by com.realtime.crossfire.jxclient.guistate.GuiStateManager.connect(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnect(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnected(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnecting(), com.realtime.crossfire.jxclient.gui.commands.StartCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.MetaCommand.execute(), com.realtime.crossfire.jxclient.main.JXClient.JXClient(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.setClientSocketState(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessorTest.start_queryMetaserver_updatesMetaserverModel().

Here is the call graph for this function:

Here is the caller graph for this function:

changeGUI() [2/2]

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI ( @NotNull final GuiState  guiState, @NotNull final String  param  )

private

Sets a new GuiState.

Parameters

guiState	the new gui state
param	a parameter for the new gui state

Definition at line 113 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState, com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync.

connect()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.connect

(

@NotNull final String

serverInfo

)

Connects to a Crossfire server.

Parameters

serverInfo

the server to connect to

Definition at line 180 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), and com.realtime.crossfire.jxclient.guistate.GuiState.CONNECTING.

Referenced by com.realtime.crossfire.jxclient.gui.commands.ConnectCommand.execute(), and com.realtime.crossfire.jxclient.main.JXClient.JXClient().

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnect

(

)

Disconnects from the Crossfire server.

Definition at line 187 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), and com.realtime.crossfire.jxclient.guistate.GuiState.METASERVER.

Referenced by com.realtime.crossfire.jxclient.main.DefaultKeyHandler.escPressed(), and com.realtime.crossfire.jxclient.gui.commands.DisconnectCommand.execute().

Here is the call graph for this function:

Here is the caller graph for this function:

disconnected()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnected

(

)

Called after the connection has been closed.

Definition at line 222 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiState.CONNECT_FAILED, com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState, com.realtime.crossfire.jxclient.guistate.GuiState.METASERVER, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync.

Referenced by com.realtime.crossfire.jxclient.server.socket.ClientSocket.processDisconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

disconnecting()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnecting	(	@NotNull final String	reason,
		final boolean	isError
	)

Called when the connection is being torn down.

Parameters

reason	the disconnect reason
isError	whether the disconnect is unexpected

Definition at line 211 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiState.CONNECT_FAILED, com.realtime.crossfire.jxclient.guistate.GuiState.CONNECTED, com.realtime.crossfire.jxclient.guistate.GuiState.CONNECTING, com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync.

Referenced by com.realtime.crossfire.jxclient.server.socket.ClientSocket.processDisconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

doChangeGUI()

abstract void com.realtime.crossfire.jxclient.guistate.GuiStateManager.doChangeGUI ( @NotNull final Runnable  runnable )

abstractprotected

Calls the Runnable.

Parameters

runnable

the runnable

Reimplemented in com.realtime.crossfire.jxclient.guistate.SwingGuiStateManager, and com.realtime.crossfire.jxclient.guistate.TestGuiStateManager.

Referenced by com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI().

Here is the caller graph for this function:

getGuiState()

GuiState com.realtime.crossfire.jxclient.guistate.GuiStateManager.getGuiState

(

)

Returns the current GuiState.

Returns

the gui state

Definition at line 154 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync.

Referenced by com.realtime.crossfire.jxclient.main.DefaultKeyHandler.escPressed().

Here is the caller graph for this function:

removeGuiStateListener()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.removeGuiStateListener

(

@NotNull final GuiStateListener

listener

)

Removes a gui state listener.

Parameters

listener

the listener to remove

Definition at line 172 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners.

Referenced by com.realtime.crossfire.jxclient.skin.events.ConnectionStateSkinEvent.dispose().

Here is the caller graph for this function:

setClientSocketState()

void com.realtime.crossfire.jxclient.guistate.GuiStateManager.setClientSocketState	(	@NotNull final ClientSocketState	clientSocketState,
		@NotNull final String	param
	)

Sets the new ClientSocketState.

Parameters

clientSocketState	the new state
param	additional information; currently only used in state ClientSocketState#REQUESTINFO

Definition at line 197 of file GuiStateManager.java.

References com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiState.CONNECTED, com.realtime.crossfire.jxclient.guistate.ClientSocketState.CONNECTED, and com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.cmdReplyinfo(), and com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.setClientSocketState().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

guiState

GuiState com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiState

private

The current GUI state.

Definition at line 40 of file GuiStateManager.java.

Referenced by com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnected(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnecting(), and com.realtime.crossfire.jxclient.guistate.GuiStateManager.getGuiState().

guiStateListeners

final EventListenerList2<GuiStateListener> com.realtime.crossfire.jxclient.guistate.GuiStateManager.guiStateListeners = new EventListenerList2<>()

private

The connection state listeners to notify.

Definition at line 52 of file GuiStateManager.java.

Referenced by com.realtime.crossfire.jxclient.guistate.GuiStateManager.addGuiStateListener(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.removeGuiStateListener(), and com.realtime.crossfire.jxclient.guistate.GuiStateManager.setClientSocketState().

sync

final Object com.realtime.crossfire.jxclient.guistate.GuiStateManager.sync = new Object()

private

The synchronization object for accessing guiState.

Definition at line 46 of file GuiStateManager.java.

Referenced by com.realtime.crossfire.jxclient.guistate.GuiStateManager.changeGUI(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnected(), com.realtime.crossfire.jxclient.guistate.GuiStateManager.disconnecting(), and com.realtime.crossfire.jxclient.guistate.GuiStateManager.getGuiState().

---

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

• src/model/src/main/java/com/realtime/crossfire/jxclient/guistate/GuiStateManager.java