Class HybridClient

java.lang.Object

VASSAL.chat.HybridClient

All Implemented Interfaces:

ServerConnection, ChatServerConnection, PlayerEncoder, ChatControlsInitializer

Direct Known Subclasses:

DynamicClient

public class HybridClient
extends Object
implements ChatServerConnection, PlayerEncoder, ChatControlsInitializer

Delegates calls to another SvrConnection instance, which can be changed programmatically

Author:

rkinney

Field Summary

Fields

Modifier and Type	Field	Description
protected ChatServerControls	controls
protected Icon	currentIcon
protected String	currentText
protected String	defaultRoom
protected ChatServerConnection	delegate
protected PropertyChangeSupport	propSupport

Fields inherited from interface VASSAL.chat.ChatServerConnection

AVAILABLE_ROOMS, DEFAULT_ROOM_NAME, INCOMING_MSG, PLAYER_INFO, ROOM, STATUS, STATUS_SERVER

Fields inherited from interface VASSAL.build.module.ServerConnection

CONNECTED, CONNECTION_LOST

Constructor Summary

Constructors

Constructor	Description
HybridClient()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)	Register a PropertyChangeListener.
protected void	fireStatus(String msg)
Room[]	getAvailableRooms()	Return an array of all rooms on the server
ChatServerConnection	getDelegate()
Room	getRoom()	Return the room currently occupied by the player
Player	getUserInfo()	Return a Player instance representing the current player
void	initializeControls(ChatServerControls controls)	Register all event listeners
boolean	isConnected()
String	playerToString(Player p)
void	sendTo(Player recipient, Command c)	Send a Command to a particular player
void	sendToOthers(Command c)	Send a command to other players on the server
void	setConnected(boolean connect)
void	setDelegate(ChatServerConnection newDelegate)
void	setRoom(Room r)	Join the given room
void	setUserInfo(Player p)	Set the Player instance representing this player
Player	stringToPlayer(String s)
void	uninitializeControls(ChatServerControls controls)	Remove all previously-registered event listeners
void	updateDisplayControls(Icon icon, String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

delegate

protected ChatServerConnection delegate

defaultRoom

protected String defaultRoom

propSupport

protected PropertyChangeSupport propSupport

controls

protected ChatServerControls controls

currentIcon

protected Icon currentIcon

currentText

protected String currentText

Constructor Details

HybridClient

public HybridClient()

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener l)

Description copied from interface: ServerConnection

Register a PropertyChangeListener. Changes to connection status triggers a PropertyChangeEvent, and concrete implementations may define other properties

Specified by:

addPropertyChangeListener in interface ServerConnection

getAvailableRooms

public Room[] getAvailableRooms()

Description copied from interface: ChatServerConnection

Return an array of all rooms on the server

Specified by:

getAvailableRooms in interface ChatServerConnection

getRoom

public Room getRoom()

Description copied from interface: ChatServerConnection

Return the room currently occupied by the player

Specified by:

getRoom in interface ChatServerConnection

getUserInfo

public Player getUserInfo()

Description copied from interface: ChatServerConnection

Return a Player instance representing the current player

Specified by:

getUserInfo in interface ChatServerConnection

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ServerConnection

sendTo

public void sendTo(Player recipient,
 Command c)

Description copied from interface: ChatServerConnection

Send a Command to a particular player

Specified by:

sendTo in interface ChatServerConnection

sendToOthers

public void sendToOthers(Command c)

Description copied from interface: ServerConnection

Send a command to other players on the server

Specified by:

sendToOthers in interface ServerConnection

setConnected

public void setConnected(boolean connect)

Specified by:

setConnected in interface ServerConnection

getDelegate

public ChatServerConnection getDelegate()

setRoom

public void setRoom(Room r)

Description copied from interface: ChatServerConnection

Join the given room

Specified by:

setRoom in interface ChatServerConnection

setUserInfo

public void setUserInfo(Player p)

Description copied from interface: ChatServerConnection

Set the Player instance representing this player

Specified by:

setUserInfo in interface ChatServerConnection

stringToPlayer

public Player stringToPlayer(String s)

Specified by:

stringToPlayer in interface PlayerEncoder

playerToString

public String playerToString(Player p)

Specified by:

playerToString in interface PlayerEncoder

fireStatus

protected void fireStatus(String msg)

setDelegate

public void setDelegate(ChatServerConnection newDelegate)

initializeControls

public void initializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Register all event listeners

Specified by:

initializeControls in interface ChatControlsInitializer

uninitializeControls

public void uninitializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Remove all previously-registered event listeners

Specified by:

uninitializeControls in interface ChatControlsInitializer

updateDisplayControls

public void updateDisplayControls(Icon icon,
 String text)