Module AM37

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

Class InputDialog

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.Window

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

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

All Implemented Interfaces:

KeyEventListener

Direct Known Subclasses:

ButtonsDialog, MultipleChoiceListDialog, SingleChoiceListDialog, TextInputDialog

public abstract class InputDialog
extends Dialog

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.HashMap<ActiveItem,java.lang.String>	inputs	Maps all the activeItems which

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

message, title

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

background, cli, enableInputOnReturn, returnTo

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
InputDialog(java.lang.String title, java.lang.String message, int width, int height, CursorPosition initCoord, Window caller)	Custom constructor
InputDialog(java.lang.String title, java.lang.String message, int width, int height, Window caller)	Custom constructor
InputDialog(java.lang.String title, java.lang.String message, Window caller)	Default constructor

Method Summary

Modifier and Type	Method	Description
boolean	canBeClosed()	Determines if the dialog can be closed
java.util.Map<ActiveItem,java.lang.String>	getInputs()	Provides a map containing active items and their corresponding values to be returned
java.lang.String	getTextColor()	Provides the first WindowItem.activeItems textColor
void	onArrowDown()	Selects the next ActiveItem on the Dialog
void	onArrowLeft()	Selects the previous ActiveItem on the Dialog
void	onArrowRight()	Selects the next ActiveItem on the Dialog
void	onArrowUp()	Selects the previous ActiveItem on the Dialog
void	onCarriageReturn()	Performs an action based on the currently selected ActiveItem
void	onQuit()	Determines the Dialog behaviour when it is asked to close itself
void	onTab()	Selects the next ActiveItem on the Dialog
void	show()	Draws itself

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

drawBackground, drawMessage, drawShadows, drawTitle, getBackgroundColor, remove

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

addToBackground, getCli, getReturnTo

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

addActiveItem, addPassiveItem, currentActiveItem, getID, getParent, hideShadows, maxStringLength, nextActiveItem, previousActiveItem

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

drawBorders, findCenter, getColor, getHeight, getInitCoord, 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

Field Details

inputs

protected final java.util.HashMap<ActiveItem,java.lang.String> inputs

Maps all the activeItems which

Constructor Details

InputDialog

public InputDialog(java.lang.String title, java.lang.String message, Window caller)

Default constructor

Creates a standard size inputDialog window, using the properties file, without printing it; if other dialogs are already showing, the new dialog is created at an offset from the already existing one.
The console echo is disabled as soon as the Dialog is created

Parameters:

title - the dialog title

message - the dialog message

caller - the window which invoked this

InputDialog

public InputDialog(java.lang.String title, java.lang.String message, int width, int height, Window caller)

Custom constructor

Creates a custom size input dialog window, without printing it; if other dialogs are already showing, the new dialog is created at an offset from the already existing one
The console echo is disabled as soon as the Dialog is created

Parameters:

height - the dialog height

width - the dialog width

title - the dialog title

message - the dialog message

caller - the window which invoked this

InputDialog

public InputDialog(java.lang.String title, java.lang.String message, int width, int height, CursorPosition initCoord, Window caller)

Custom constructor

Creates a custom size input dialog window, without printing it;
The console echo is disabled as soon as the Dialog is created

Parameters:

height - the dialog height

width - the dialog width

title - the dialog title

message - the dialog message

caller - the window which invoked this

Method Details

getInputs

public java.util.Map<ActiveItem,java.lang.String> getInputs()

Provides a map containing active items and their corresponding values to be returned

Returns:

the up mentioned map

canBeClosed

public boolean canBeClosed()

Determines if the dialog can be closed

For a InputDialog, it can be closed when all the required input fields have been filled

Overrides:

canBeClosed in class Dialog

Returns:

true if the dialog can be closed, false otherwise

onQuit

public void onQuit()

Determines the Dialog behaviour when it is asked to close itself

For an InputDialog, all of its inputs are passed to the inputManager

Specified by:

onQuit in class Dialog

getTextColor

public java.lang.String getTextColor()

Provides the first WindowItem.activeItems textColor

Overrides:

getTextColor in class Rectangle

Returns:

the first item's text color scheme

show

public void show()

Draws itself

Overrides:

show in class Dialog

onArrowRight

public void onArrowRight()

Selects the next ActiveItem on the Dialog

onArrowLeft

public void onArrowLeft()

Selects the previous ActiveItem on the Dialog

onCarriageReturn

public void onCarriageReturn()

Performs an action based on the currently selected ActiveItem

onTab

public void onTab()

Selects the next ActiveItem on the Dialog

onArrowUp

public void onArrowUp()

Selects the previous ActiveItem on the Dialog

onArrowDown

public void onArrowDown()

Selects the next ActiveItem on the Dialog