net.sf.freecol.client.control

Class InGameInputHandler

java.lang.Object

net.sf.freecol.client.control.InputHandler

net.sf.freecol.client.control.InGameInputHandler

All Implemented Interfaces:

MessageHandler

public final class InGameInputHandler
extends InputHandler

Handle the network messages that arrives while in the game. Delegate to the real handlers in InGameController which are allowed to touch the GUI. Call IGC through invokeLater except for the messages that demand a response, which requires invokeAndWait. Note that the EDT often calls the controller, which queries the server, which results in handling the reply here, still within the EDT. invokeAndWait is illegal within the EDT, but none of messages that require a response are client-initiated so the problem does not arise... ...except for the special case of the animations. These have to be done in series but are sometimes in the EDT (our unit moves) and sometimes not (other nation unit moves). Hence the hack GUI.invokeNowOrWait.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Runnable	closeMenusRunnable
private java.lang.Runnable	displayModelMessagesRunnable
private static java.util.logging.Logger	logger
private java.lang.Runnable	reconnectRunnable

Constructor Summary

Constructors

Constructor and Description
InGameInputHandler(FreeColClient freeColClient) The constructor to use.

Method Summary

Modifier and Type	Method and Description
private org.w3c.dom.Element	addObject(org.w3c.dom.Element element) Add the objects which are the children of this Element.
private org.w3c.dom.Element	addPlayer(org.w3c.dom.Element element) Handle an "addPlayer"-message.
private org.w3c.dom.Element	animateAttack(org.w3c.dom.Element element) Handle an "animateAttack"-message.
private org.w3c.dom.Element	animateMove(org.w3c.dom.Element element) Handle an "animateMove"-message.
private org.w3c.dom.Element	chat(org.w3c.dom.Element element) Handle a "chat"-message.
private org.w3c.dom.Element	chooseFoundingFather(org.w3c.dom.Element element) Handle an "chooseFoundingFather"-request.
private org.w3c.dom.Element	closeMenus() Trivial handler to allow the server to signal to the client that an offer that caused a popup (for example, a native demand or diplomacy proposal) has not been answered quickly enough and that the offering player has assumed this player has refused-by-inaction, and therefore, the popup needs to be closed.
private org.w3c.dom.Element	diplomacy(org.w3c.dom.Element element) Handle a "diplomacy"-request.
private org.w3c.dom.Element	disposeUnits(org.w3c.dom.Element element) Disposes of the Units which are the children of this Element.
private org.w3c.dom.Element	error(org.w3c.dom.Element element) Handle an "error"-message.
private org.w3c.dom.Element	featureChange(org.w3c.dom.Element element) Adds a feature to or removes a feature from a FreeColGameObject.
private org.w3c.dom.Element	firstContact(org.w3c.dom.Element element) Handle a first contact with a native nation.
private org.w3c.dom.Element	fountainOfYouth(org.w3c.dom.Element element) Ask the player to choose migrants from a fountain of youth event.
private org.w3c.dom.Element	gameEnded(org.w3c.dom.Element element) Handle a "gameEnded"-message.
private static int	getIntegerAttribute(org.w3c.dom.Element element, java.lang.String attrib) Get the integer value of an element attribute.
org.w3c.dom.Element	handle(Connection connection, org.w3c.dom.Element element) Deals with incoming messages that have just been received.
private InGameController	igc() Shorthand to get the controller.
private org.w3c.dom.Element	indianDemand(org.w3c.dom.Element element) Handle an "indianDemand"-request.
private void	invokeAndWait(java.lang.Runnable runnable) Shorthand to run in the EDT and wait.
private void	invokeLater(java.lang.Runnable runnable) Shorthand to run in the EDT eventually.
private org.w3c.dom.Element	lootCargo(org.w3c.dom.Element element) Ask the player to choose something to loot.
private org.w3c.dom.Element	monarchAction(org.w3c.dom.Element element) Handle a "monarchAction"-request.
private org.w3c.dom.Element	multiple(Connection connection, org.w3c.dom.Element element) Handle all the children of this element.
private org.w3c.dom.Element	newLandName(org.w3c.dom.Element element) Ask the player to name the new land.
private org.w3c.dom.Element	newRegionName(org.w3c.dom.Element element) Ask the player to name a new region.
private org.w3c.dom.Element	newTurn(org.w3c.dom.Element element) Handle a "newTurn"-message.
private org.w3c.dom.Element	reconnect(org.w3c.dom.Element element) Handle an "reconnect"-message.
private org.w3c.dom.Element	remove(org.w3c.dom.Element element) Handle a "remove"-message.
private static org.w3c.dom.Element	selectElement(org.w3c.dom.Element parent, java.lang.String key) Select a child element with the given object identifier from a parent element.
private static Unit	selectUnitFromElement(Game game, org.w3c.dom.Element element, java.lang.String id) Sometimes units appear which the client does not know about, and are passed in as the children of the parent element.
private org.w3c.dom.Element	setAI(org.w3c.dom.Element element) Handle a "setAI"-message.
private org.w3c.dom.Element	setCurrentPlayer(org.w3c.dom.Element element) Handle a "setCurrentPlayer"-message.
private org.w3c.dom.Element	setDead(org.w3c.dom.Element element) Handle a "setDead"-message.
private org.w3c.dom.Element	setStance(org.w3c.dom.Element element) Handle a "setStance"-request.
private org.w3c.dom.Element	spyResult(org.w3c.dom.Element element) Handle a "spyResult" message.
private org.w3c.dom.Element	update(org.w3c.dom.Element element) Handle an "update"-message.

Methods inherited from class net.sf.freecol.client.control.InputHandler

disconnect, getFreeColClient, getGame, getGUI, unknown

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

closeMenusRunnable

private final java.lang.Runnable closeMenusRunnable

displayModelMessagesRunnable

private final java.lang.Runnable displayModelMessagesRunnable

reconnectRunnable

private final java.lang.Runnable reconnectRunnable

Constructor Detail

InGameInputHandler

public InGameInputHandler(FreeColClient freeColClient)

The constructor to use.

Parameters:

freeColClient - The FreeColClient for the game.

Method Detail

igc

private InGameController igc()

Shorthand to get the controller.

Returns:

The in-game controller.

invokeAndWait

private void invokeAndWait(java.lang.Runnable runnable)

Shorthand to run in the EDT and wait.

Parameters:

runnable - The Runnable to run.

invokeLater

private void invokeLater(java.lang.Runnable runnable)

Shorthand to run in the EDT eventually.

Parameters:

runnable - The Runnable to run.

getIntegerAttribute

private static int getIntegerAttribute(org.w3c.dom.Element element,
                                       java.lang.String attrib)

Get the integer value of an element attribute.

Parameters:

element - The Element to query.

attrib - The attribute to use.

Returns:

The integer value of the attribute, or Integer.MIN_VALUE on failure.

selectElement

private static org.w3c.dom.Element selectElement(org.w3c.dom.Element parent,
                                                 java.lang.String key)

Select a child element with the given object identifier from a parent element.

Parameters:

parent - The parent Element.

key - The key to search for.

Returns:

An Element with matching key, or null if none found.

selectUnitFromElement

private static Unit selectUnitFromElement(Game game,
                                          org.w3c.dom.Element element,
                                          java.lang.String id)

Sometimes units appear which the client does not know about, and are passed in as the children of the parent element. Worse, if their location is a Unit, that unit has to be passed in too. Pull a unit out of the children by id.

Parameters:

game - The Game to add the unit to.

element - The Element to find a unit in.

id - The object identifier of the unit to find.

Returns:

A unit or null if none found.

handle

public org.w3c.dom.Element handle(Connection connection,
                                  org.w3c.dom.Element element)

Deals with incoming messages that have just been received.

Specified by:

handle in interface MessageHandler

Specified by:

handle in class InputHandler

Parameters:

connection - The Connection the message was received on.

element - The root Element of the message.

Returns:

The reply.

addObject

private org.w3c.dom.Element addObject(org.w3c.dom.Element element)

Add the objects which are the children of this Element.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

addPlayer

private org.w3c.dom.Element addPlayer(org.w3c.dom.Element element)

Handle an "addPlayer"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

animateAttack

private org.w3c.dom.Element animateAttack(org.w3c.dom.Element element)

Handle an "animateAttack"-message. This only performs animation, if required. It does not actually perform any attacks.

Parameters:

element - An element (root element in a DOM-parsed XML tree) that holds attributes for the old and new tiles and an element for the unit that is moving (which are used solely to operate the animation).

Returns:

Null.

animateMove

private org.w3c.dom.Element animateMove(org.w3c.dom.Element element)

Handle an "animateMove"-message. This only performs animation, if required. It does not actually change unit positions, which happens in an "update".

Parameters:

element - An element (root element in a DOM-parsed XML tree) that holds attributes for the old and new tiles and an element for the unit that is moving (which are used solely to operate the animation).

Returns:

Null.

chat

private org.w3c.dom.Element chat(org.w3c.dom.Element element)

Handle a "chat"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

chooseFoundingFather

private org.w3c.dom.Element chooseFoundingFather(org.w3c.dom.Element element)

Handle an "chooseFoundingFather"-request.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null. The choice is returned asynchronously.

closeMenus

private org.w3c.dom.Element closeMenus()

Trivial handler to allow the server to signal to the client that an offer that caused a popup (for example, a native demand or diplomacy proposal) has not been answered quickly enough and that the offering player has assumed this player has refused-by-inaction, and therefore, the popup needs to be closed.

Returns:

Null.

diplomacy

private org.w3c.dom.Element diplomacy(org.w3c.dom.Element element)

Handle a "diplomacy"-request. If the message informs of an acceptance or rejection then display the result and return null. If the message is a proposal, then ask the user about it and return the response with appropriate response set.

Parameters:

element - The element (root element in a DOM-parsed XML tree) containing a "diplomacy"-message.

Returns:

A diplomacy response, or null if none required.

disposeUnits

private org.w3c.dom.Element disposeUnits(org.w3c.dom.Element element)

Disposes of the Units which are the children of this Element.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

error

private org.w3c.dom.Element error(org.w3c.dom.Element element)

Handle an "error"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

featureChange

private org.w3c.dom.Element featureChange(org.w3c.dom.Element element)

Adds a feature to or removes a feature from a FreeColGameObject.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

firstContact

private org.w3c.dom.Element firstContact(org.w3c.dom.Element element)

Handle a first contact with a native nation.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

fountainOfYouth

private org.w3c.dom.Element fountainOfYouth(org.w3c.dom.Element element)

Ask the player to choose migrants from a fountain of youth event.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

gameEnded

private org.w3c.dom.Element gameEnded(org.w3c.dom.Element element)

Handle a "gameEnded"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

indianDemand

private org.w3c.dom.Element indianDemand(org.w3c.dom.Element element)

Handle an "indianDemand"-request.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

An IndianDemand message containing the response, or null on error.

lootCargo

private org.w3c.dom.Element lootCargo(org.w3c.dom.Element element)

Ask the player to choose something to loot.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null. The choice is returned asynchronously.

monarchAction

private org.w3c.dom.Element monarchAction(org.w3c.dom.Element element)

Handle a "monarchAction"-request.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null. The response is returned asynchronously.

multiple

private org.w3c.dom.Element multiple(Connection connection,
                                     org.w3c.dom.Element element)

Handle all the children of this element.

Parameters:

connection - The Connection the element arrived on.

element - The Element to process.

Returns:

An Element containing the response/s.

newLandName

private org.w3c.dom.Element newLandName(org.w3c.dom.Element element)

Ask the player to name the new land.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null. The name is returned asynchronously.

newRegionName

private org.w3c.dom.Element newRegionName(org.w3c.dom.Element element)

Ask the player to name a new region.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null. The name is returned asynchronously.

newTurn

private org.w3c.dom.Element newTurn(org.w3c.dom.Element element)

Handle a "newTurn"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

reconnect

private org.w3c.dom.Element reconnect(org.w3c.dom.Element element)

Handle an "reconnect"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

remove

private org.w3c.dom.Element remove(org.w3c.dom.Element element)

Handle a "remove"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

setAI

private org.w3c.dom.Element setAI(org.w3c.dom.Element element)

Handle a "setAI"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

setCurrentPlayer

private org.w3c.dom.Element setCurrentPlayer(org.w3c.dom.Element element)

Handle a "setCurrentPlayer"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

setDead

private org.w3c.dom.Element setDead(org.w3c.dom.Element element)

Handle a "setDead"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

setStance

private org.w3c.dom.Element setStance(org.w3c.dom.Element element)

Handle a "setStance"-request.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

spyResult

private org.w3c.dom.Element spyResult(org.w3c.dom.Element element)

Handle a "spyResult" message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

update

private org.w3c.dom.Element update(org.w3c.dom.Element element)

Handle an "update"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.