Module AM37

Package it.polimi.ingsw.view.cli.console.graphics

Class GridOverlay

java.lang.Object

it.polimi.ingsw.view.cli.console.graphics.components.Rectangle

it.polimi.ingsw.view.cli.console.graphics.components.WindowItem

it.polimi.ingsw.view.cli.console.graphics.components.ActiveItem

it.polimi.ingsw.view.cli.console.graphics.GridOverlay

All Implemented Interfaces:

Toggleable, KeyEventListener

public final class GridOverlay
extends ActiveItem
implements Toggleable

An invisible overlay to select the cells on the board

Field Summary

Fields inherited from class it.polimi.ingsw.view.cli.console.graphics.components.WindowItem

activeItems, id, parent, passiveItems

Fields inherited from class it.polimi.ingsw.view.cli.console.graphics.components.Rectangle

color, height, initCoord, properties, width

Constructor Summary

Constructors

Constructor	Description
GridOverlay(Window parent, CursorPosition initCoord, FancyPrinterBoardUtils printer, java.lang.String id)

Method Summary

Modifier and Type	Method	Description
void	enable()	Enables the component
void	onArrowDown()	Moves to the cell immediately below the current one, highlighting it;
void	onArrowLeft()	Moves to the cell immediately on the left of the current one, highlighting it;
void	onArrowRight()	Moves to the cell immediately on the right of the current one, highlighting it;
void	onArrowUp()	Moves to the cell immediately above the current one, highlighting it;
void	onCarriageReturn()	Returns the currently selected cell to the inputManager
void	onDisable()	Disables the component
void	onRelease()	Defines the object behaviour when released
void	onSelect()	Defines the object behaviour when selected
void	setHighlightedCells(java.util.List<Cell> highlightedCells)	Sets the cells to highlight, valid until this gets disabled
void	show()	(Does not) print the object on the screen

Methods inherited from class it.polimi.ingsw.view.cli.console.graphics.components.ActiveItem

getBackgroundColor

Methods inherited from class it.polimi.ingsw.view.cli.console.graphics.components.WindowItem

addActiveItem, addPassiveItem, currentActiveItem, drawShadows, getCli, getID, getParent, hideShadows, maxStringLength, nextActiveItem, previousActiveItem, remove

Methods inherited from class it.polimi.ingsw.view.cli.console.graphics.components.Rectangle

drawBackground, drawBorders, findCenter, getColor, getHeight, getInitCoord, getTextColor, getWidth, hideBorders, loadPropertiesFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.polimi.ingsw.view.cli.console.KeyEventListener

onBackspace, onPrintableKey, onTab

Constructor Details

GridOverlay

public GridOverlay(Window parent, CursorPosition initCoord, FancyPrinterBoardUtils printer, java.lang.String id) throws java.io.IOException

Throws:

java.io.IOException

Method Details

setHighlightedCells

public void setHighlightedCells(java.util.List<Cell> highlightedCells)

Sets the cells to highlight, valid until this gets disabled

Parameters:

highlightedCells - the cells to highlight

onSelect

public void onSelect()

Defines the object behaviour when selected

Specified by:

onSelect in class ActiveItem

onRelease

public void onRelease()

Defines the object behaviour when released

Specified by:

onRelease in class ActiveItem

enable

public void enable()

Enables the component

Specified by:

enable in interface Toggleable

Overrides:

enable in class ActiveItem

onDisable

public void onDisable()

Disables the component

Specified by:

onDisable in interface Toggleable

Overrides:

onDisable in class ActiveItem

onArrowUp

public void onArrowUp()

Moves to the cell immediately above the current one, highlighting it;

Specified by:

onArrowUp in interface KeyEventListener

onArrowDown

public void onArrowDown()

Moves to the cell immediately below the current one, highlighting it;

Specified by:

onArrowDown in interface KeyEventListener

onArrowRight

public void onArrowRight()

Moves to the cell immediately on the right of the current one, highlighting it;

Specified by:

onArrowRight in interface KeyEventListener

onArrowLeft

public void onArrowLeft()

Moves to the cell immediately on the left of the current one, highlighting it;

Specified by:

onArrowLeft in interface KeyEventListener

onCarriageReturn

public void onCarriageReturn()

Returns the currently selected cell to the inputManager

Specified by:

onCarriageReturn in interface KeyEventListener

show

public void show()

(Does not) print the object on the screen

Overrides:

show in class WindowItem