client.maritime

Interface IMaritimeTradeOverlay

All Superinterfaces:

IOverlayView, IView

All Known Implementing Classes:

MaritimeTradeOverlay

public interface IMaritimeTradeOverlay
extends IOverlayView

Interface for the maritime trade overlay, which lets the user make a maritime trade

Method Summary

Modifier and Type	Method and Description
void	hideGetOptions() Hides the "get" resources and undo components.
void	hideGiveOptions() Hides the "give" resources and undo components.
void	reset() Resets the view to its initial state.
void	selectGetOption(ResourceType selectedResource, int amount) Selects the resource the user has selected to receive.
void	selectGiveOption(ResourceType selectedResource, int amount) Selects the resource the user has selected to give.
void	setCancelEnabled(boolean enabled) Enables or disables the cancel button.
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.
void	showGetOptions(ResourceType[] enabledResources) Shows all the "get" resources, enabling the ones the player can receive, and disabling the ones he can't.
void	showGiveOptions(ResourceType[] enabledResources) Shows all the "give" resources, enabling the ones the player can give, and disabling the ones he can't.

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.

hideGetOptions

void hideGetOptions()

Hides the "get" resources and undo components.

hideGiveOptions

void hideGiveOptions()

Hides the "give" resources and undo components.

selectGetOption

void selectGetOption(ResourceType selectedResource,
                     int amount)

Selects the resource the user has selected to receive. Specifically, this method does the following: 1. Hides all the "get" resources except the selected one 2. Displays and disables the selected "get" resource 3. Displays the "get" undo components using the specified amount

Parameters:

selectedResource - The "get" resource selected by the user

amount - The amount of the specified "get" resource the user will receive (e.g., 1)

selectGiveOption

void selectGiveOption(ResourceType selectedResource,
                      int amount)

Selects the resource the user has selected to give. Specifically, this method does the following: 1. Hides all the "give" resources except the selected one 2. Displays and disables the selected "give" resource 3. Displays the "give" undo components using the specified amount

Parameters:

selectedResource - The "give" resource selected by the user

amount - The amount of the specified "give" resource the user will give (e.g., 3)

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

showGetOptions

void showGetOptions(ResourceType[] enabledResources)

Shows all the "get" resources, enabling the ones the player can receive, and disabling the ones he can't.

Parameters:

enabledResources - Array of "get" resources that should be enabled.

showGiveOptions

void showGiveOptions(ResourceType[] enabledResources)

Shows all the "give" resources, enabling the ones the player can give, and disabling the ones he can't.

Parameters:

enabledResources - Array of "give" resources that should be enabled.