client.domestic

Interface IDomesticTradeOverlay

All Superinterfaces:

IOverlayView, IView

All Known Implementing Classes:

DomesticTradeOverlay

public interface IDomesticTradeOverlay
extends IOverlayView

Implementation of the domestic trade overlay, which allows the user to propose a domestic trade

Method Summary

Modifier and Type	Method and Description
void	reset() Resets the view to its initial state.
void	setCancelEnabled(boolean enabled) Enables or disables the cancel button.
void	setPlayers(PlayerInfo[] value) Sets the opponents the local player may trade with.
void	setPlayerSelectionEnabled(boolean enable) Enables or disables the ability to select a player to trade with.
void	setResourceAmount(ResourceType resource, java.lang.String amount) Sets the amount displayed for a resource.
void	setResourceAmountChangeEnabled(ResourceType resource, boolean canIncrease, boolean canDecrease) Enables or disables the ability to increase and decrease a resource's amount.
void	setResourceSelectionEnabled(boolean enable) Enables or disables the ability to select resources to trade.
void	setStateMessage(java.lang.String message) Sets the message on the button indicating the state of the trade.
void	setTradeEnabled(boolean enable) Enables or disables the trade button.

Methods inherited from interface client.base.IOverlayView

closeModal, isModalShowing, showModal

Methods inherited from interface client.base.IView

getController, setController

Method Detail

reset

void reset()

Resets the view to its initial state.

setPlayers

void setPlayers(PlayerInfo[] value)

Sets the opponents the local player may trade with. This should be called on initializing the controller, and only called once.

Parameters:

value - Information about the players that can be traded with

setPlayerSelectionEnabled

void setPlayerSelectionEnabled(boolean enable)

Enables or disables the ability to select a player to trade with.

Parameters:

enable - Whether or not player selection is currently allowed

setResourceAmount

void setResourceAmount(ResourceType resource,
                       java.lang.String amount)

Sets the amount displayed for a resource.

Parameters:

resource - The resource for which the amount is being set

amount - The string to be displayed as the resource's amount (can be empty)

setResourceAmountChangeEnabled

void setResourceAmountChangeEnabled(ResourceType resource,
                                    boolean canIncrease,
                                    boolean canDecrease)

Enables or disables the ability to increase and decrease a resource's amount.

Parameters:

resource - The resource for which amount changing is being enabled or disabled

canIncrease - Whether or not the resource's amount may be increased

canDecrease - Whether or not the resource's amount may be decreased

setResourceSelectionEnabled

void setResourceSelectionEnabled(boolean enable)

Enables or disables the ability to select resources to trade.

Parameters:

enable - Whether or not the user can select resources to trade

setStateMessage

void setStateMessage(java.lang.String message)

Sets the message on the button indicating the state of the trade.

Parameters:

message - The new state message

setTradeEnabled

void setTradeEnabled(boolean enable)

Enables or disables the trade button.

Parameters:

enable - Whether or not the user may currently execute the trade

setCancelEnabled

void setCancelEnabled(boolean enabled)

Enables or disables the cancel button.

Parameters:

enabled - Whether or not the user may cancel the trade operation