A radio button is an overlay usually used to represent an option in a set of options where the user can choose only one. The control is done using the Group ID property.

addOverlay

Moves an Overlay to this RadioButton.

Parameters:

Overlay toAdd - Overlay to be moved to this RadioButton.

addRepresentation

Adds another representation to this representation.

Parameters:

representation toAdd - Representation to be added to this representation.

copyOverlay

Clones an overlay to this RadioButton.

Parameters:

Overlay toClone - Overlay that will be cloned.

string name - Name of the new RadioButton.

Returns:

representation - The new RadioButton.

createOverlay

Adds an overlay to the RadioButton.

Parameters:

string name - Name of the overlay.

number type - Type of the Overlay: OVT_WINDOW, OVT_BUTTON, OVT_CHECK_BOX, OVT_COMBO_BOX, OVT_EDIT_BOX, OVT_MULTILINE_EDIT_BOX, OVT_PROGRESS_BAR, OVT_SPINNER, OVT_RADIO_BUTTON, OVT_SCROLL_BAR_VERT, OVT_SCROLL_BAR_HORZ, OVT_SLIDER_BAR, OVT_STATIC_TEXT, OVT_STATIC_IMAGE, OVT_TAB_PANE, OVT_LIST_BOX, OVT_MENU_BAR, OVT_MENU_ITEM, OVT_MENU_POPUP, OVT_MULTICOLUMN_LIST, OVT_CODE_EDIT_BOX, OVT_SCROLL_PANE, OVT_TOGGLE_BUTTON or OVT_TREE.

MediaItem mediaitem - Media Item of the look n' feel to be applied to the overlay.

number x - X coordinate of the position of the overlay.

number y - Y coordinate of the position of the overlay.

number sx - Width of the overlay.

number sy - Height of the overlay.

Returns:

Overlay - The new overlay.

getAlpha

Gets the alpha level of the RadioButton.

Returns:

number - The transparency (alpha) level to be applied on the RadioButton (between 0 and 255).

getDisabledColour

Returns the colour of the RadioButton's text when the RadioButton is disabled.

Returns:

number - Red colour value (between 0 and 255)

number - Green colour value (between 0 and 255)

number - Blue colour value (between 0 and 255)

number - Alpha value (between 0 and 255)

getDragDropListener

Returns the 'drag and drop' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getDragDropListener

Returns the 'drag and drop' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getFont

Returns the text font and size applied on the RadioButton.

Returns:

MediaItem - The text font applied on the RadioButton.

number - The size of the font applied on the RadioButton.

getGroupId

Returns the ID of the RadioButton

Returns:

number - ID of the RadioButton

getHoverColour

Returns the colour of the RadioButton's text when the mouse is hovering it.

Returns:

number - Red colour value (between 0 and 255)

number - Green colour value (between 0 and 255)

number - Blue colour value (between 0 and 255)

number - Alpha value (between 0 and 255)

getID

Returns the representation ID.

Returns:

string - Representation ID.

getKeyPressedListener

Returns the 'key pressed' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getKeyPressedListener

Returns the 'key pressed' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getKeyReleasedListener

Returns the 'key released' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getKeyReleasedListener

Returns the 'key released' listener of the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getLookFeel

Returns the MediaItem of the RadioButton.

Returns:

MediaItem - The look 'n feel applied to the RadioButton.

getMaxSize

Gets the maximum size of the RadioButton.

Returns:

number - Maximum width of the RadioButton.

number - Maximum height of the RadioButton.

getMinSize

Gets the minimum size of the RadioButton.

Returns:

number - Minimum width of the RadioButton.

number - Minimum height of the RadioButton.

getMouseButtonClickedListener

Returns the 'mouse button clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonClickedListener

Returns the 'mouse button clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonDoubleClickedListener

Returns the 'mouse button double clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonDoubleClickedListener

Returns the 'mouse button double clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonPressedListener

Returns the 'mouse button pressed' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonPressedListener

Returns the 'mouse button pressed' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonReleasedListener

Returns the 'mouse button released' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonReleasedListener

Returns the 'mouse button released' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonTripleClickedListener

Returns the 'mouse button triple clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonTripleClickedListener

Returns the 'mouse button triple clicked' listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseCursor

Sets the image of the mouse cursor when over the RadioButton..

Parameters:

MediaItem cursorImage - Media Item containing the look n' feel of the cursor.

Returns:

string - The name of the image.

getMouseEnteredListener

Returns the 'mouse entered' listener of the RadioButton.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseEnteredListener

Returns the 'mouse entered' listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseLeftListener

Returns the 'mouse left' listener of the RadioButton.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseLeftListener

Returns the 'mouse left' listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseMovedListener

Returns the 'mouse moved' listener of the RadioButton.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseMovedListener

Returns the 'mouse moved' listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseWheelMovedListener

Returns the 'mouse wheel moved' listener of the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseWheelMovedListener

Returns the 'mouse wheel moved' listener of the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getName

Returns the name of the RadioButton

Returns:

string - The name of the RadioButton

getOverlay

Returns an Overlay identified by name contained in this RadioButton.

Parameters:

string name - Name of the Overlay.

Returns:

Overlay - The child Overlay identified by name.

getOverlays

Returns the Overlays contained in this RadioButton.

Returns:

array{} - Overlays contained in this RadioButton.

getOverlayType

Returns the type of the Overlay.

Returns:

number - The type of the Overlay: OVT_WINDOW, OVT_BUTTON, OVT_CHECK_BOX, OVT_COMBO_BOX, OVT_EDIT_BOX, OVT_MULTILINE_EDIT_BOX, OVT_PROGRESS_BAR, OVT_SPINNER, OVT_RADIO_BUTTON, OVT_SCROLL_BAR_VERT, OVT_SCROLL_BAR_HORZ, OVT_SLIDER_BAR, OVT_STATIC_TEXT, OVT_STATIC_IMAGE, OVT_TAB_PANE, OVT_LIST_BOX, OVT_MENU_BAR, OVT_MENU_ITEM, OVT_MENU_POPUP, OVT_MULTICOLUMN_LIST, OVT_CODE_EDIT_BOX, OVT_SCROLL_PANE, OVT_TOGGLE_BUTTON or OVT_TREE.

getPosition

Gets the position of the RadioButton.

Returns:

number - X coordinate of the position of the RadioButton.

number - Y coordinate of the position of the RadioButton.

getPushedColour

Returns the colour of the RadioButton's text when the RadioButton is pushed.

Returns:

number - Red colour value (between 0 and 255)

number - Green colour value (between 0 and 255)

number - Blue colour value (between 0 and 255)

number - Alpha value (between 0 and 255)

getRepresentation

Returns the contained representation with the specified name and type.

Parameters:

string name - The name of the contained representation.

number type - The type of the contained representation.

Returns:

representation - The contained representation with the specified name and type.

getRepresentationContainer

Returns the representation that contains this representation.

Returns:

representation - The representation that contains this representation.

getRepresentations

Returns an array of the contained representations.

Returns:

array{} - Array of the contained representations.

getSelectionChangedListener

Returns the 'selection changed' listener of the RadioButton.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getSize

Gets the size of the RadioButton.

Returns:

number - Width of the RadioButton.

number - Height of the RadioButton.

getText

Gets the text of the RadioButton.

Returns:

string - The text of the RadioButton

getTextColour

Returns the colour of the RadioButton's text.

Returns:

number - Red colour value (between 0 and 255)

number - Green colour value (between 0 and 255)

number - Blue colour value (between 0 and 255)

number - Alpha value (between 0 and 255)

getType

Returns the representation type:
2 - MODEL,
3 - LIGHT,
4 - EFFECT,
5 - PLANE,
6 - WATER,
7 - SOUND,
8 - TERRAIN_MESH_DECAL,
9 - TERRAIN_HIGHLIGHTING_DECAL,
10 - BILLBOARD,
11 - OVERLAY

Returns:

number - The type of the representation.

hasDragDropListener

Returns 'true' if the RadioButton has a listener for the 'drag and drop' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event when released.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'drag and drop' event, otherwise 'false'.

hasDragDropListener

Returns 'true' if the RadioButton has a listener for the 'drag and drop' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event when released.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'drag and drop' event, otherwise 'false'.

hasKeyPressedListener

Returns 'true' if the RadioButton has a listener for the 'key pressed' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'key pressed' event, otherwise 'false'.

hasKeyPressedListener

Returns 'true' if the RadioButton has a listener for the 'key pressed' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'key pressed' event, otherwise 'false'.

hasKeyReleasedListener

Returns 'true' if the RadioButton has a listener for the 'key released' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event when released.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'key released' event, otherwise 'false'.

hasKeyReleasedListener

Returns 'true' if the RadioButton has a listener for the 'key released' event, otherwise 'false'.

Parameters:

string key - The key that will trigger the event when released.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'key released' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the RadioButton has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the RadioButton has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the RadioButton has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the RadioButton has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the RadioButton has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the RadioButton has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the RadioButton has a listener for the 'button released' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the RadioButton has a listener for the 'button released' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the RadioButton has a listener for the 'button triple clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the RadioButton has a listener for the 'button triple clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseEnteredListener

Returns 'true' if the RadioButton has a listener for the 'mouse entered' event, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseEnteredListener

Returns 'true' if the RadioButton has a listener for the 'mouse entered' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseLeftListener

Returns 'true' if the RadioButton has a listener for the 'mouse left' event, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseLeftListener

Returns 'true' if the RadioButton has a listener for the 'mouse left' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseMovedListener

Returns 'true' if the RadioButton has a listener for the 'mouse moved' event, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseMovedListener

Returns 'true' if the RadioButton has a listener for the 'mouse moved' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the RadioButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the RadioButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the RadioButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasRepresentation

Returns 'true' if this representation has the other representation, otherwise 'false'.

Parameters:

representation other - The other representation.

Returns:

boolean - 'True' if this representation has the other representation, otherwise 'false'.

hasRepresentation

Returns 'true' if this representation has another representation with the specified name and type, otherwise 'false'.

Parameters:

string name - Name of the representation.

number type - Type of the representation

Returns:

boolean - 'True' if this representation has another representation with the specified name and type, otherwise 'false'.

hasSelectionChangedListener

Returns 'true' if the RadioButton has a 'selection changed' listener, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton has a 'selection changed' listener, otherwise 'false'.

isEnabled

Returns 'true' if the RadioButton is enabled, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton is enabled, otherwise 'false'.

isInheritsAlpha

Returns 'true' if the RadioButton is set to inherit the alpha level from its parent, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton is set to inherit the alpha level from its parent, otherwise 'false'.

isOnTop

Returns 'true' if the RadioButton is set to show on top, otherwise 'false'.

Returns:

boolean - 'True' if the RadioButton is set to show on top, otherwise 'false'.

isPersistent

Returns true if the representation is persistent, false otherwise.

Returns:

boolean - Whether the RadioButton is persistent or not.

isVisible

Returns 'true' if the representation is visible, 'false' otherwise.

Returns:

boolean - Whether the RadioButton is visible or not.

print

Prints the RadioButton data and attributes to the console.

removeAllOverlays

Removes all Overlays contained in this RadioButton.

removeAllRepresentations

Removes all representations contained in this representation.

removeDragDropListener

Removes the listener for the 'drag and drop' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

removeDragDropListener

Removes the listener for the 'drag and drop' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeKeyPressedListener

Removes the listener for the 'key pressed' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

removeKeyPressedListener

Removes the listener for the 'key pressed' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeKeyReleasedListener

Removes the listener for the 'key released' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

removeKeyReleasedListener

Removes the listener for the 'key released' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonClickedListener

Removes the 'mouse button clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonClickedListener

Removes the 'mouse button clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonDoubleClickedListener

Removes the 'mouse button double clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonDoubleClickedListener

Removes the 'mouse button double clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonPressedListener

Removes the 'mouse button pressed' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonPressedListener

Removes the 'mouse button pressed' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonReleasedListener

Removes the 'mouse button released' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonReleasedListener

Removes the 'mouse button released' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonTripleClickedListener

Removes the 'mouse button triple clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonTripleClickedListener

Removes the 'mouse button triple clicked' event listener of the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseEnteredListener

Removes the 'mouse entered' event listener of the RadioButton.

removeMouseEnteredListener

Removes the 'mouse entered' event listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseLeftListener

Removes the 'mouse left' event listener of the RadioButton.

removeMouseLeftListener

Removes the 'mouse left' event listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseMovedListener

Removes the 'mouse moved' event listener of the RadioButton.

removeMouseMovedListener

Removes the 'mouse moved' event listener of the RadioButton.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseWheelMovedListener

Removes the 'mouse wheel moved' event listener of the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

removeMouseWheelMovedListener

Removes the 'mouse wheel moved' event listener of the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeOverlay

Removes an Overlay identified by name contained in this RadioButton.

Parameters:

string name - Name of the Overlay.

removeRepresentation

Removes a representation from this representation.

Parameters:

representation other - The representation to be removed.

removeRepresentation

Removes a representation with the specified name and type from this representation.

Parameters:

string name - Name of the representation.

number type - Type of the representation

removeSelectionChangedListener

Removes the 'selection changed' listener from the RadioButton.

setAlpha

Sets the alpha level of the RadioButton.

Parameters:

number The - new transparency (alpha) level to be applied on the RadioButton (between 0 and 255).

setDisabledColour

Changes the colour of the RadioButton's text when the RadioButton is disabled.

Parameters:

number r - Red Colour value (between 0 and 255).

number g - Green Colour value (between 0 and 255).

number b - Blue Colour value (between 0 and 255).

number a - Alpha value (between 0 and 255).

setDragDropListener

Sets a listener to be invoked upon a 'drag and drop' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setDragDropListener

Sets a listener to be invoked upon a 'drag and drop' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setEnabled

Enables or disables the RadioButton.

Parameters:

boolean enable - 'True' if the RadioButton is enabled, otherwise 'false'.

setFont

Changes the text font to be applied on the RadioButton.

Parameters:

MediaItem font - The Media Item containing the font for the RadioButton.

number size - The size of the font.

setGroupId

Sets the ID of the RadioButton.
The RadioButton will only allow one selected RadioButton per ID.

Parameters:

number groupID - ID of the RadioButton.

setHoverColour

Changes the colour of the RadioButton's text when the mouse is hovering it.

Parameters:

number r - Red Colour value (between 0 and 255).

number g - Green Colour value (between 0 and 255).

number b - Blue Colour value (between 0 and 255).

number a - Alpha value (between 0 and 255).

setInheritsAlpha

Sets whether the RadioButton inherits the alpha level from the parent component of not.

Parameters:

boolean inAlpha - Whether the RadioButton inherits the alpha level from the parent component of not.

setKeyPressedListener

Sets a listener to be invoked upon a 'key pressed' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setKeyPressedListener

Sets a listener to be invoked upon a 'key pressed' event on the RadioButton.

Parameters:

string key - The key that will trigger the event.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setKeyReleasedListener

Sets a listener to be invoked upon a 'key released' event on the RadioButton.

Parameters:

string key - The key that will trigger the event when released.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setKeyReleasedListener

Sets a listener to be invoked upon a 'key released' event on the RadioButton.

Parameters:

string key - The key that will trigger the event when released.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMaxSize

Sets the maximum size of the RadioButton.

Parameters:

number w - Maximum width of the RadioButton.

number h - Maximum height of the RadioButton.

setMinSize

Sets the minimum size of the RadioButton.

Parameters:

number w - Minimum width of the RadioButton.

number h - Minimum height of the RadioButton.

setMouseButtonDoubleClickedListener

Sets a listener to be invoked upon a 'mouse button double clicked' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonDoubleClickedListener

Sets a listener to be invoked upon a 'mouse button double clicked' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonPressedListener

Sets a listener to be invoked upon a 'mouse button pressed' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonPressedListener

Sets a listener to be invoked upon a 'mouse button pressed' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonReleasedListener

Sets a listener to be invoked upon a 'mouse button released' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonReleasedListener

Sets a listener to be invoked upon a 'mouse button released' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonTripleClickedListener

Sets a listener to be invoked upon a 'mouse button triple clicked' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonTripleClickedListener

Sets a listener to be invoked upon a 'mouse button triple clicked' event on the RadioButton.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseCursor

Sets an image to the mouse cursor when over the RadioButton..

Parameters:

MediaItem cursorImage - Media Item containing the look n' feel for the cursor.

string imageName - Name of the image to apply.

setMouseEnteredListener

Sets a listener to be invoked upon a 'mouse enter' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseEnteredListener

Sets a listener to be invoked upon a 'mouse enter' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseLeftListener

Sets a listener to be invoked upon a 'mouse leave' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseLeftListener

Sets a listener to be invoked upon a 'mouse leave' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseMovedListener

Sets a listener to be invoked upon a 'mouse move' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseMovedListener

Sets a listener to be invoked upon a 'mouse move' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseWheelMovedListener

Sets a listener to be invoked upon a 'mouse wheel moved' event on the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseWheelMovedListener

Sets a listener to be invoked upon a 'mouse wheel moved' event on the RadioButton.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setOnTop

Sets the RadioButton to show on top or not.

Parameters:

boolean onTop - Whether the RadioButton is set to show on top or not.

setPersistent

Makes the RadioButton persistent or not persistent.

Parameters:

boolean persistent - Whether the RadioButton is persistent or not.

setPosition

Sets the position of the RadioButton without a smooth transition.

Parameters:

number x - X coordinate of the position of the RadioButton.

number y - Y coordinate of the position of the RadioButton.

setPosition

Sets the position of the RadioButton.

Parameters:

number x - X coordinate of the position of the RadioButton.

number y - Y coordinate of the position of the RadioButton.

bool Smooth - Whether the position changes with a smooth transition.

setPushedColour

Changes the colour of the RadioButton's text when the RadioButton is pushed.

Parameters:

number r - Red Colour value (between 0 and 255).

number g - Green Colour value (between 0 and 255).

number b - Blue Colour value (between 0 and 255).

number a - Alpha value (between 0 and 255).

setSelected

Selects or deselects the RadioButton.

Parameters:

boolean state - 'True' to select the RadioButton, 'false' to deselect it.

setSelectionChangedListener

Sets a listener to be invoked upon a 'selection changed' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setSelectionChangedListener

Sets a listener to be invoked upon a 'selection changed' event on the RadioButton.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setSize

Sets the size of the RadioButton without a smooth transition.

Parameters:

number w - Width of the RadioButton.

number h - Height of the RadioButton.

setSize

Sets the size of the RadioButton.

Parameters:

number w - Width of the RadioButton.

number h - Height of the RadioButton.

bool smooth - Whether the size changes with a smooth transition.

setText

Sets the text of the RadioButton.

Parameters:

string text - The text of the RadioButton

setTextColour

Changes the colour of the RadioButton's text.

Parameters:

number r - Red Colour value (between 0 and 255).

number g - Green Colour value (between 0 and 255).

number b - Blue Colour value (between 0 and 255).

number a - Alpha value (between 0 and 255).

setTooltip

Sets the tooltip text of the RadioButton.

Parameters:

string tooltip - The new tooltip text.

setVisible

Makes the RadioButton visible or invisible without a smooth transition.

Parameters:

boolean visible - Whether the RadioButton is visible or not.

setVisible

Makes the RadioButton visible or invisible.

Parameters:

boolean visible - Whether the RadioButton is visible or not.

bool smooth - Whether the RadioButton appears or disappears smoothly.