InputDialog

This object represents a window asking the user to enter data.

Constructor function.

var myObject = new InputDialog();

var myObject = new InputDialog(parameters);

1. parameters - (object) window parameters
   • title - (string) the window's title
   • position - (Point) the window's position
   • opacity - (float) the window's opacity
   • enabled - (boolean) the window's enabled status
   • visible - (boolean) the window's visible status
   • labelText - (string) the label text
   • okButtonText - (string) the text of the ok button
   • cancelButtonText - (string) the text of the cancel button
   • textEchoMode - (TextEchoMode) the text echo mode
   • floatDecimals - (integer) the number of decimals
   • integerStep - (integer) the integer step
   • minimum - (mixed) the minimum value
   • maximum - (mixed) the maximum value
   • range - (object) the range
     • minimum - (mixed) the minimum value
     • maximum - (mixed) the maximum value
   • inputType - (InputType) the input type
   • value - (mixed) the default value
   • items - (array) the items (used when asking an item from a list)
   • itemsEditable - (boolean) are the items from the list editable
   • onClosed - (OnClosed) event called when the window is closed
   • onValueChanged - (OnValueChanged) event called when the value changes

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

var myObject = new InputDialog();

var myObject = new InputDialog({
	title: "Enter text:",
	inputType: InputDialog.Text
});

Sets the window's title.

myObject.setTitle(title);

1. title - (string) the window's title

• (InputDialog) this InputDialog

Sets the window's position.

myObject.setPosition(point);

1. point - (Point) the window's position

• (InputDialog) this InputDialog

Sets the window's opacity.

myObject.setOpacity(opacity);

1. opacity - (float) the window's opacity

• (InputDialog) this InputDialog

Sets the window's enabled status.

myObject.setEnabled(enabled);

1. enabled - (boolean) the window's enabled status

• (InputDialog) this InputDialog

Sets the window's visible status.

myObject.setVisible(visible);

1. visible - (boolean) the window's visible status

• (InputDialog) this InputDialog

Closes the window.

myObject.close();

• (InputDialog) this InputDialog

Returns the window's title.

myObject.title();

• (string) the window's title

Returns the window's position.

myObject.position();

• (Point) the window's position

Returns the window's opacity.

myObject.opacity();

• (float) the window's opacity

Returns the window's enabled status.

myObject.enabled();

• (boolean) the window's enabled status

Returns the window's visible status.

myObject.visible();

• (boolean) the window's visible status

Sets the label text.

myObject.setLabelText(text);

1. text - (string) the label text

• (InputDialog) this InputDialog

Sets the ok button text.

myObject.setLabelText(text);

1. text - (string) the ok button's label

• (InputDialog) this InputDialog

Sets the cancel button text.

myObject.setCancelButtonText(text);

1. text - (string) the cancel button's label

• (InputDialog) this InputDialog

Sets the text echo mode.

myObject.setTextEchoMode(textEchoMode);

1. textEchoMode - (TextEchoMode) the text echo mode

• (InputDialog) this InputDialog

Sets the number of decimals of floating values.

myObject.setFloatDecimals(decimals);

1. decimals - (integer) the number of decimals of floating values

• (InputDialog) this InputDialog

Sets the integer step value.

myObject.setIntegerStep(step);

1. step - (integer) the integer step value

• (InputDialog) this InputDialog

Sets the maximum value.

myObject.setMaximum(maximum);

1. maximum - (mixed) the maximum value

• (InputDialog) this InputDialog

Sets the minimum value.

myObject.setMinimum(minimum);

1. minimum - (mixed) the minimum value

• (InputDialog) this InputDialog

Sets the minimum and maximum values.

myObject.setRange(minimum, maximum);

1. minimum - (mixed) the minimum value
2. maximum - (mixed) the maximum value

• (InputDialog) this InputDialog

Sets the input type.

myObject.setRange(inputType);

1. inputType - (InputType) the input type

• (InputDialog) this InputDialog

Sets the value.

myObject.setValue(value);

1. value - (mixed) the value

• (InputDialog) this InputDialog

Sets the items that can be choosen from.

myObject.setItems(items);

1. items - (array) the items that can be choosen from

• (InputDialog) this InputDialog

Sets the items as editable.

myObject.setItemsEditable(itemsEditable);

1. itemsEditable - (boolean) should the item list be editable

• (InputDialog) this InputDialog

Returns the value.

myObject.value();

• (mixed) the value

Show the window. (non-blocking) Use the OnClosed event to know when the window has been closed.

myObject.show();

• (InputDialog) this InputDialog

Show the window. (blocking)

myObject.showModal();

• (integer) the window result (0 means that it has been canceled)

Called when the window is closed.

myObject.onClosed = function(result) {};

1. result - (integer) the window result (0 means that it has been canceled)

myObject.onClosed = function(result)
{
	if(result)
	{
		//Event action
	}
};

Called when the value changes.

myObject.onValueChanged = function(value) {};

1. value - (mixed) the current value

myObject.onValueChanged = function(value)
{
	//Event action
};

The window's title. (string)

The window's position. (Point)

The window's opacity. (float)

The window's enabled status. (boolean)

The window's visible status. (boolean)

The window's value. (mixed)

The input type.

• Text: text
• Integer: an integer
• Float: a floating number (decimal)
• Items: a list of items

The text echo mode.

• Normal: normal text display
• NoEcho: do not show the text
• Password: show password characters instead of the typed characters
• PasswordEchoOnEdit: show password characters instead of the typed characters only when editing