ictk.boardgame.chess.ui
Interface ChessBoardDisplay

All Known Subinterfaces:

CLIChessBoardDisplay

All Known Implementing Classes:

TxChessBoardDisplay

public interface ChessBoardDisplay

This is a visual representation of a chess board. The interface can be extended by both GUI (Graphic) and CLI (command line) classes.

Field Summary

static int	BOTTOM_COORDINATES no coordinates to appear around the boarders of the board
static int	LEFT_COORDINATES no coordinates to appear around the boarders of the board
static int	NO_COORDINATES no coordinates to appear around the boarders of the board
static int	RIGHT_COORDINATES no coordinates to appear around the boarders of the board
static int	TOP_COORDINATES no coordinates to appear around the boarders of the board

Method Summary

boolean	getSideToMoveOnBottom() returns true if the board is set to re-orient itself so the side to move is at the bottom after every move on update.
int	getVisibleCoordinates() returns the mask of which coordinates are set visible for this board.
boolean	isLowerCaseCoordinates() returns if the coordinates are currently set to appear in lowercase.
boolean	isWhiteOnBottom() returns true if the board is oriented so white is currently on the bottom.
void	setLowerCaseCoordinates(boolean t) sets the coordinates to appear in lowercase.
void	setSideToMoveOnBottom(boolean t) sets the board to re-orient itself so the side to move is at the bottom after every move on update.
void	setVisibleCoordinates(int whichCoordinatesMask) sets which coordinates should appear when the board is displayed.
void	setWhiteOnBottom(boolean t) orients the board so White is on the bottom.

Field Detail

NO_COORDINATES

public static final int NO_COORDINATES

no coordinates to appear around the boarders of the board

See Also:

Constant Field Values

TOP_COORDINATES

public static final int TOP_COORDINATES

no coordinates to appear around the boarders of the board

See Also:

Constant Field Values

RIGHT_COORDINATES

public static final int RIGHT_COORDINATES

no coordinates to appear around the boarders of the board

See Also:

Constant Field Values

BOTTOM_COORDINATES

public static final int BOTTOM_COORDINATES

no coordinates to appear around the boarders of the board

See Also:

Constant Field Values

LEFT_COORDINATES

public static final int LEFT_COORDINATES

no coordinates to appear around the boarders of the board

See Also:

Constant Field Values

Method Detail

setWhiteOnBottom

public void setWhiteOnBottom(boolean t)

orients the board so White is on the bottom. This setting is overriden by setPlayerToMoveOnBottom(true).

isWhiteOnBottom

public boolean isWhiteOnBottom()

returns true if the board is oriented so white is currently on the bottom. This value could change on the next move, depending on the value of setPlayerToMoveOnBottom(true).

setSideToMoveOnBottom

public void setSideToMoveOnBottom(boolean t)

sets the board to re-orient itself so the side to move is at the bottom after every move on update.

getSideToMoveOnBottom

public boolean getSideToMoveOnBottom()

returns true if the board is set to re-orient itself so the side to move is at the bottom after every move on update. This does not indicate whether the board is currently oriented so that the current player to move is on the bottom.

setVisibleCoordinates

public void setVisibleCoordinates(int whichCoordinatesMask)

sets which coordinates should appear when the board is displayed. Coordinates can be bitwise ORed together to get multiple coordinates to appear.
For example: TOP_COORDINATES | BOTTOM_COORDINATES

getVisibleCoordinates

public int getVisibleCoordinates()

returns the mask of which coordinates are set visible for this board.

setLowerCaseCoordinates

public void setLowerCaseCoordinates(boolean t)

sets the coordinates to appear in lowercase.

isLowerCaseCoordinates

public boolean isLowerCaseCoordinates()

returns if the coordinates are currently set to appear in lowercase.