client.map.view.dropObject

Class SettlementDropObject

java.lang.Object

client.map.view.dropObject.DropObject

client.map.view.dropObject.SettlementDropObject

public class SettlementDropObject
extends DropObject

Handles the placement of settlements on the map.

Author:

Jonathan Sadler

Field Summary

Fields

Modifier and Type	Field and Description
private Coordinate	vertex

Fields inherited from class client.map.view.dropObject.DropObject

color, controller

Constructor Summary

Constructors

Constructor and Description
SettlementDropObject(IMapController controller, CatanColor color) Creates a SettlementDropObject.

Method Summary

Modifier and Type	Method and Description
void	Click() Indicates the mouse button was pressed.
Vertex	GetDropLocation() Gets the vertex associated with the object.
void	Handle(java.awt.geom.Point2D point) Used to handle mouse movement.
boolean	IsAllowed() Returns if the object can be placed at the current location.
boolean	IsValid() Returns if the location of the object is a valid location.

Methods inherited from class client.map.view.dropObject.DropObject

GetClosestHexCoordinate, GetColor, GetSortedVerticies

Methods inherited from class java.lang.Object

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

Field Detail

vertex

private Coordinate vertex

Constructor Detail

SettlementDropObject

public SettlementDropObject(IMapController controller,
                            CatanColor color)

Creates a SettlementDropObject.

Parameters:

controller - The controller associated with the object.

color - The color of the object.

Method Detail

GetDropLocation

public Vertex GetDropLocation()
                       throws MapException

Gets the vertex associated with the object.

Returns:

The vertex of the object.

Throws:

MapException - Thrown if the vertex isn't valid.

IsValid

public boolean IsValid()

Description copied from class: DropObject

Returns if the location of the object is a valid location.

Specified by:

IsValid in class DropObject

Returns:

True if valid, else false.

IsAllowed

public boolean IsAllowed()

Description copied from class: DropObject

Returns if the object can be placed at the current location.

Specified by:

IsAllowed in class DropObject

Returns:

True if yes, else false.

Handle

public void Handle(java.awt.geom.Point2D point)

Description copied from class: DropObject

Used to handle mouse movement. Gets the associated data with the new coordinate.

Specified by:

Handle in class DropObject

Parameters:

point - The location of the mouse.

Click

public void Click()

Description copied from class: DropObject

Indicates the mouse button was pressed.

Specified by:

Click in class DropObject