client.domestic

Class DomesticTradeController

java.lang.Object

client.base.Controller

client.domestic.DomesticTradeController

All Implemented Interfaces:

IController, IDomesticTradeController, ModelObserver

public class DomesticTradeController
extends Controller
implements IDomesticTradeController, ModelObserver

Domestic trade controller implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DomesticTradeController.ResourcePositions
private static class	DomesticTradeController.TradeResourceStates

Field Summary

Fields

Modifier and Type	Field and Description
private IAcceptTradeOverlay	acceptOverlay
private int	playerIndexToTradeWith
private boolean	playersToTradeWithAlreadySet
private DomesticTradeController.TradeResourceStates[]	resourceStates
private int[]	resourcesToTrade
private IDomesticTradeOverlay	tradeOverlay
private IWaitView	waitOverlay

Constructor Summary

Constructors

Constructor and Description
DomesticTradeController(IDomesticTradeView tradeView, IDomesticTradeOverlay tradeOverlay, IWaitView waitOverlay, IAcceptTradeOverlay acceptOverlay) DomesticTradeController constructor

Method Summary

Modifier and Type	Method and Description
void	acceptTrade(boolean willAccept) Called by the accept trade overlay when the user either accepts or rejects a trade.
void	alert() Notifies an object that something has happened
void	cancelTrade() Called by the domestic trade overlay when the user cancels a trade.
private void	checkIfTradeIsReady() Check if the trade is ready, enable and disable the trade button accordingly
void	decreaseResourceAmount(ResourceType resource) Called by the domestic trade overlay when the user decreases the amount of a resource.
private void	enableUpDownButtonsForReceiveResource(ResourceType type) Handles button enabling/disabling for receive resources
private void	enableUpDownButtonsForSendResource(ResourceType type) Handles button enabling/disabling for send resources
IAcceptTradeOverlay	getAcceptOverlay()
private int	getResourceIndex(ResourceType type) Helper method for converting a resource type into an index of the resource to trade array
IDomesticTradeOverlay	getTradeOverlay()
IDomesticTradeView	getTradeView()
IWaitView	getWaitOverlay()
void	increaseResourceAmount(ResourceType resource) Called by the domestic trade overlay when the user increases the amount of a resource.
private void	initializePlayersToTradeWith()
private boolean	playerCanAcceptTrade(int[] resources) Returns true if the player can accept the trade offer
private void	resetResourcesToTrade() Just resets the resource to trade each time it's called
private void	resetTradeOverlay()
private void	resetTradeResesourceStates() Researches the internal button states each time it's called, should only be called when domestic trade modal opens
private void	resetUpDownButtons()
private boolean	sendAndReceiveResourcesSet() Checks to see if send and receive resources are set in the trade
void	sendTradeOffer() Called by the domestic trade overlay when the user clicks the trade button.
void	setAcceptOverlay(IAcceptTradeOverlay acceptOverlay)
void	setPlayerToTradeWith(int playerIndex) Called by the domestic trade overlay when the user selects a player to trade with.
void	setResourceToReceive(ResourceType resource) Called by the domestic trade overlay when the user selects a resource to be received.
void	setResourceToSend(ResourceType resource) Called by the domestic trade overlay when the user selects a resource to be sent.
void	setTradeOverlay(IDomesticTradeOverlay tradeOverlay)
void	setWaitOverlay(IWaitView waitView)
void	startTrade() Called by the domestic trade view when the user clicks the domestic trade button.
void	unsetResource(ResourceType resource) Called by the domestic trade overlay when user selects "none" for a resource.
private void	updateUpDownForResource(ResourceType type) Called whenever the state of the upDown buttons has changed, disables or enables them after checking context

Methods inherited from class client.base.Controller

getView

Methods inherited from class java.lang.Object

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

Methods inherited from interface client.base.IController

getView

Field Detail

tradeOverlay

private IDomesticTradeOverlay tradeOverlay

waitOverlay

private IWaitView waitOverlay

acceptOverlay

private IAcceptTradeOverlay acceptOverlay

playersToTradeWithAlreadySet

private boolean playersToTradeWithAlreadySet

resourcesToTrade

private int[] resourcesToTrade

resourceStates

private DomesticTradeController.TradeResourceStates[] resourceStates

playerIndexToTradeWith

private int playerIndexToTradeWith

Constructor Detail

DomesticTradeController

public DomesticTradeController(IDomesticTradeView tradeView,
                               IDomesticTradeOverlay tradeOverlay,
                               IWaitView waitOverlay,
                               IAcceptTradeOverlay acceptOverlay)

DomesticTradeController constructor

Parameters:

tradeView - Domestic trade view (i.e., view that contains the "Domestic Trade" button)

tradeOverlay - Domestic trade overlay (i.e., view that lets the user propose a domestic trade)

waitOverlay - Wait overlay used to notify the user they are waiting for another player to accept a trade

acceptOverlay - Accept trade overlay which lets the user accept or reject a proposed trade

Method Detail

getTradeView

public IDomesticTradeView getTradeView()

getTradeOverlay

public IDomesticTradeOverlay getTradeOverlay()

setTradeOverlay

public void setTradeOverlay(IDomesticTradeOverlay tradeOverlay)

getWaitOverlay

public IWaitView getWaitOverlay()

setWaitOverlay

public void setWaitOverlay(IWaitView waitView)

getAcceptOverlay

public IAcceptTradeOverlay getAcceptOverlay()

setAcceptOverlay

public void setAcceptOverlay(IAcceptTradeOverlay acceptOverlay)

alert

public void alert()

Description copied from interface: ModelObserver

Notifies an object that something has happened

Specified by:

alert in interface ModelObserver

playerCanAcceptTrade

private boolean playerCanAcceptTrade(int[] resources)

Returns true if the player can accept the trade offer

startTrade

public void startTrade()

Description copied from interface: IDomesticTradeController

Called by the domestic trade view when the user clicks the domestic trade button.

Specified by:

startTrade in interface IDomesticTradeController

initializePlayersToTradeWith

private void initializePlayersToTradeWith()

resetResourcesToTrade

private void resetResourcesToTrade()

Just resets the resource to trade each time it's called

resetTradeResesourceStates

private void resetTradeResesourceStates()

Researches the internal button states each time it's called, should only be called when domestic trade modal opens

resetTradeOverlay

private void resetTradeOverlay()

checkIfTradeIsReady

private void checkIfTradeIsReady()

Check if the trade is ready, enable and disable the trade button accordingly

sendAndReceiveResourcesSet

private boolean sendAndReceiveResourcesSet()

Checks to see if send and receive resources are set in the trade

Returns:

decreaseResourceAmount

public void decreaseResourceAmount(ResourceType resource)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user decreases the amount of a resource.

Specified by:

decreaseResourceAmount in interface IDomesticTradeController

Parameters:

resource - The resource whose amount is being decreased

increaseResourceAmount

public void increaseResourceAmount(ResourceType resource)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user increases the amount of a resource.

Specified by:

increaseResourceAmount in interface IDomesticTradeController

Parameters:

resource - The resource whose amount is being increased

resetUpDownButtons

private void resetUpDownButtons()

updateUpDownForResource

private void updateUpDownForResource(ResourceType type)

Called whenever the state of the upDown buttons has changed, disables or enables them after checking context

Parameters:

type -

enableUpDownButtonsForSendResource

private void enableUpDownButtonsForSendResource(ResourceType type)

Handles button enabling/disabling for send resources

Parameters:

type -

enableUpDownButtonsForReceiveResource

private void enableUpDownButtonsForReceiveResource(ResourceType type)

Handles button enabling/disabling for receive resources

Parameters:

type -

getResourceIndex

private int getResourceIndex(ResourceType type)

Helper method for converting a resource type into an index of the resource to trade array

Parameters:

type -

Returns:

sendTradeOffer

public void sendTradeOffer()

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user clicks the trade button.

Specified by:

sendTradeOffer in interface IDomesticTradeController

setPlayerToTradeWith

public void setPlayerToTradeWith(int playerIndex)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user selects a player to trade with.

Specified by:

setPlayerToTradeWith in interface IDomesticTradeController

Parameters:

playerIndex - The index [0, 3] of the selected trading partner, or -1 if "None" was selected

setResourceToReceive

public void setResourceToReceive(ResourceType resource)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user selects a resource to be received.

Specified by:

setResourceToReceive in interface IDomesticTradeController

Parameters:

resource - The resource to be received

setResourceToSend

public void setResourceToSend(ResourceType resource)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user selects a resource to be sent.

Specified by:

setResourceToSend in interface IDomesticTradeController

Parameters:

resource - The resource to be sent

unsetResource

public void unsetResource(ResourceType resource)

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when user selects "none" for a resource.

Specified by:

unsetResource in interface IDomesticTradeController

Parameters:

resource - The resource for which "none" was selected

cancelTrade

public void cancelTrade()

Description copied from interface: IDomesticTradeController

Called by the domestic trade overlay when the user cancels a trade.

Specified by:

cancelTrade in interface IDomesticTradeController

acceptTrade

public void acceptTrade(boolean willAccept)

Description copied from interface: IDomesticTradeController

Called by the accept trade overlay when the user either accepts or rejects a trade.

Specified by:

acceptTrade in interface IDomesticTradeController

Parameters:

willAccept - Whether or not the user accepted the trade