ColorDialog

This object represents a window allowing the user to choose a color.

Constructor function.

var myObject = new ColorDialog();

var myObject = new ColorDialog(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
   • showAlphaChannel - (boolean) show the alpha channel
   • color - (Color) the selected color
   • onClosed - (OnClosed) the OnClosed event
   • onColorSelected - (OnColorSelected) the OnColorSelected event
   • onColorChanged - (OnColorChanged) the OnColorChanged event

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

var myObject = new ColorDialog();

var myObject = new ColorDialog({
	title: "My title",
	opacity: 0.5
});

Sets the window's title.

myObject.setTitle(title);

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

• (ColorDialog) this ColorDialog

Sets the window's position.

myObject.setPosition(point);

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

• (ColorDialog) this ColorDialog

Sets the window's opacity.

myObject.setOpacity(opacity);

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

• (ColorDialog) this ColorDialog

Sets the window's enabled status.

myObject.setEnabled(enabled);

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

• (ColorDialog) this ColorDialog

Sets the window's visible status.

myObject.setVisible(visible);

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

• (ColorDialog) this ColorDialog

Closes the window.

myObject.close();

• (ColorDialog) this ColorDialog

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 if the alpha channel should be visible.

myObject.showAlphaChannel(showAlphaChannel);

1. showAlphaChannel - (boolean) the alpha channel visibility status

• (ColorDialog) this ColorDialog

Sets the current color.

myObject.setColor(color);

1. color - (Color) the current color

• (ColorDialog) this ColorDialog

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

myObject.show();

• (ColorDialog) this ColorDialog

Show the window. (blocking)

myObject.showModal();

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

Returns the current color.

myObject.color();

• (Color) the current color

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 a color has been selected.

myObject.onColorSelected = function(color) {};

1. color - (Color) the selected color

myObject.onColorSelected = function(color)
{
	//Event action
};

Called when the current color has been changed.

myObject.onColorChanged = function(color) {};

1. color - (Color) the current color

myObject.onColorChanged = function(color)
{
	//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)