A toggle button is an overlay usually used to trigger an action that has two states. When pressed the toggle button maintains a pressed state until its clicked again.

addOverlay

Moves an Overlay to this ToggleButton.

Parameters:

Overlay toAdd - Overlay to be moved to this ToggleButton.

addRepresentation

Adds another representation to this representation.

Parameters:

representation toAdd - Representation to be added to this representation.

copyOverlay

Clones an overlay to this ToggleButton.

Parameters:

Overlay toClone - Overlay that will be cloned.

string name - Name of the new ToggleButton.

Returns:

representation - The new ToggleButton.

createOverlay

Adds an overlay to the ToggleButton.

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.

getActivatedListener

Returns the 'activated' listener of the ToggleButton.

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 - channel The channel of the listener.

getActivatedListener

Returns the 'activated' listener of the ToggleButton.

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.

getAlpha

Gets the alpha level of the ToggleButton.

Returns:

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

getAlphaChangedListener

Returns the 'alpha changed' listener of the ToggleButton.

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.

getAlphaChangedListener

Returns the 'alpha changed' listener of the ToggleButton.

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.

getCaptureGainedListener

Returns the 'capture gained' listener of the ToggleButton.

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.

getCaptureGainedListener

Returns the 'capture gained' listener of the ToggleButton.

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.

getCaptureLostListener

Returns the 'capture lost' listener of the ToggleButton.

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.

getCaptureLostListener

Returns the 'capture lost' listener of the ToggleButton.

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.

getCharacterKeyListener

Returns the 'character key pressed' listener of the ToggleButton.

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.

getCharacterKeyListener

Returns the 'character key pressed' listener of the ToggleButton.

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.

getDeactivatedListener

Returns the 'deactivated' listener of the ToggleButton.

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.

getDeactivatedListener

Returns the 'deactivated' listener of the ToggleButton.

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.

getDisabledColour

Returns the colour of the ToggleButton's text when the ToggleButton 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)

getDisabledImage

Returns the image of the ToggleButton when the ToggleButton is disabled.

Returns:

MediaItem - Image of the ToggleButton when the ToggleButton is disabled.

getDisabledListener

Returns the 'disabled' listener of the ToggleButton.

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.

getDisabledListener

Returns the 'disabled' listener of the ToggleButton.

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.

getDragDropListener

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

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

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.

getEnabledListener

Returns the 'enabled' listener of the ToggleButton.

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.

getEnabledListener

Returns the 'enabled' listener of the ToggleButton.

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

Returns:

MediaItem - The text font applied on the ToggleButton.

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

getHiddenListener

Returns the 'hidden' listener of the ToggleButton.

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.

getHiddenListener

Returns the 'hidden' listener of the ToggleButton.

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.

getHoverColour

Returns the colour of the ToggleButton'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)

getHoverImage

Returns the image of the ToggleButton when the mouse is hovering it.

Returns:

MediaItem - Image of the ToggleButton when the mouse is hovering it.

getID

Returns the representation ID.

Returns:

string - Representation ID.

getKeyPressedListener

Returns the 'key pressed' listener of the ToggleButton.

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

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

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

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

Returns:

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

getMaxSize

Gets the maximum size of the ToggleButton.

Returns:

number - Maximum width of the ToggleButton.

number - Maximum height of the ToggleButton.

getMinSize

Gets the minimum size of the ToggleButton.

Returns:

number - Minimum width of the ToggleButton.

number - Minimum height of the ToggleButton.

getMouseButtonClickedListener

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

getMovedListener

Returns the 'moved' listener of the ToggleButton.

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.

getMovedListener

Returns the 'moved' listener of the ToggleButton.

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.

getName

Returns the name of the ToggleButton

Returns:

string - The name of the ToggleButton

getNormalImage

Returns the image of the ToggleButton.

Returns:

MediaItem - Image of the ToggleButton.

getOverlay

Returns an Overlay identified by name contained in this ToggleButton.

Parameters:

string name - Name of the Overlay.

Returns:

Overlay - The child Overlay identified by name.

getOverlays

Returns the Overlays contained in this ToggleButton.

Returns:

array{} - Overlays contained in this ToggleButton.

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

Returns:

number - X coordinate of the position of the ToggleButton.

number - Y coordinate of the position of the ToggleButton.

getPushedColour

Returns the colour of the ToggleButton's text when the ToggleButton 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)

getPushedImage

Returns the image of the ToggleButton when the ToggleButton is pushed.

Returns:

MediaItem - Image of the ToggleButton when the ToggleButton is pushed.

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

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.

getShownListener

Returns the 'shown' listener of the ToggleButton.

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.

getShownListener

Returns the 'shown' listener of the ToggleButton.

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.

getSize

Gets the size of the ToggleButton.

Returns:

number - Width of the ToggleButton.

number - Height of the ToggleButton.

getSizedListener

Returns the 'sized' listener of the ToggleButton.

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.

getSizedListener

Returns the 'sized' listener of the ToggleButton.

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.

getText

Gets the text of the ToggleButton.

Returns:

string - The text of the ToggleButton

getTextChangedListener

Returns the 'text changed' listener of the ToggleButton.

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.

getTextChangedListener

Returns the 'text changed' listener of the ToggleButton.

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.

getTextColour

Returns the colour of the ToggleButton'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.

hasActivatedListener

Returns 'true' if the ToggleButton has a listener for the 'activated' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'activated' event, otherwise 'false'.

hasActivatedListener

Returns 'true' if the ToggleButton has a listener for the 'activated' 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 ToggleButton has a listener for the 'activated' event, otherwise 'false'.

hasAlphaChangedListener

Returns 'true' if the ToggleButton has a listener for the 'alpha changed' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'alpha changed' event, otherwise 'false'.

hasAlphaChangedListener

Returns 'true' if the ToggleButton has a listener for the 'alpha changed' 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 ToggleButton has a listener for the 'alpha changed' event, otherwise 'false'.

hasCaptureGainedListener

Returns 'true' if the ToggleButton has a listener for the 'capture gained' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'capture gained' event, otherwise 'false'.

hasCaptureGainedListener

Returns 'true' if the ToggleButton has a listener for the 'capture gained' 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 ToggleButton has a listener for the 'capture gained' event, otherwise 'false'.

hasCaptureLostListener

Returns 'true' if the ToggleButton has a listener for the 'capture lost' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'capture lost' event, otherwise 'false'.

hasCaptureLostListener

Returns 'true' if the ToggleButton has a listener for the 'capture lost' 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 ToggleButton has a listener for the 'capture lost' event, otherwise 'false'.

hasCharacterKeyListener

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

Parameters:

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

Returns:

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

hasCharacterKeyListener

Returns 'true' if the ToggleButton has a listener for the 'character key pressed' 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 ToggleButton has a listener for the 'character key pressed' event, otherwise 'false'.

hasDeactivatedListener

Returns 'true' if the ToggleButton has a listener for the 'deactivated' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'deactivated' event, otherwise 'false'.

hasDeactivatedListener

Returns 'true' if the ToggleButton has a listener for the 'deactivated' 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 ToggleButton has a listener for the 'deactivated' event, otherwise 'false'.

hasDisabledListener

Returns 'true' if the ToggleButton has a listener for the 'disabled' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'disabled' event, otherwise 'false'.

hasDisabledListener

Returns 'true' if the ToggleButton has a listener for the 'disabled' 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 ToggleButton has a listener for the 'disabled' event, otherwise 'false'.

hasDragDropListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'drag and drop' event, otherwise 'false'.

hasDragDropListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'drag and drop' event, otherwise 'false'.

hasEnabledListener

Returns 'true' if the ToggleButton has a listener for the 'enabled' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'enabled' event, otherwise 'false'.

hasEnabledListener

Returns 'true' if the ToggleButton has a listener for the 'enabled' 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 ToggleButton has a listener for the 'enabled' event, otherwise 'false'.

hasHiddenListener

Returns 'true' if the ToggleButton has a listener for the 'hidden' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'hidden' event, otherwise 'false'.

hasHiddenListener

Returns 'true' if the ToggleButton has a listener for the 'hidden' 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 ToggleButton has a listener for the 'hidden' event, otherwise 'false'.

hasKeyPressedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'key pressed' event, otherwise 'false'.

hasKeyPressedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'key pressed' event, otherwise 'false'.

hasKeyReleasedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'key released' event, otherwise 'false'.

hasKeyReleasedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'key released' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseEnteredListener

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

Returns:

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

hasMouseEnteredListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseLeftListener

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

Returns:

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

hasMouseLeftListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseMovedListener

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

Returns:

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

hasMouseMovedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the ToggleButton 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 ToggleButton has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMovedListener

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

Parameters:

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

Returns:

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

hasMovedListener

Returns 'true' if the ToggleButton has a listener for the 'moved' 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 ToggleButton has a listener for the '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 ToggleButton has a 'selection changed' listener, otherwise 'false'.

Returns:

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

hasShownListener

Returns 'true' if the ToggleButton has a listener for the 'shown' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'shown' event, otherwise 'false'.

hasShownListener

Returns 'true' if the ToggleButton has a listener for the 'shown' 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 ToggleButton has a listener for the 'shown' event, otherwise 'false'.

hasSizedListener

Returns 'true' if the ToggleButton has a listener for the 'sized' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'resize' event, otherwise 'false'.

hasSizedListener

Returns 'true' if the ToggleButton has a listener for the 'sized' 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 ToggleButton has a listener for the 'resize' event, otherwise 'false'.

hasTextChangedListener

Returns 'true' if the ToggleButton has a listener for the 'text changed' event, otherwise 'false'.

Parameters:

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

Returns:

boolean - 'True' if the ToggleButton has a listener for the 'text changed' event, otherwise 'false'.

hasTextChangedListener

Returns 'true' if the ToggleButton has a listener for the 'text changed' 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 ToggleButton has a listener for the 'text changed' event, otherwise 'false'.

isEnabled

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

Returns:

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

isInheritsAlpha

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

Returns:

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

isOnTop

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

Returns:

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

isPersistent

Returns true if the representation is persistent, false otherwise.

Returns:

boolean - Whether the ToggleButton is persistent or not.

isVisible

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

Returns:

boolean - Whether the ToggleButton is visible or not.

print

Prints the ToggleButton data and attributes to the console.

removeActivatedListener

Removes the listener for the 'activated' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeActivatedListener

Removes the listener for the 'activated' event on the ToggleButton.

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.

removeAllOverlays

Removes all Overlays contained in this ToggleButton.

removeAllRepresentations

Removes all representations contained in this representation.

removeAlphaChangedListener

Removes the listener for the 'alpha changed' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeAlphaChangedListener

Removes the listener for the 'alpha changed' event on the ToggleButton.

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.

removeCaptureGainedListener

Removes the listener for the 'capture gained' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeCaptureGainedListener

Removes the listener for the 'capture gained' event on the ToggleButton.

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.

removeCaptureLostListener

Removes the listener for the 'capture lost' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeCaptureLostListener

Removes the listener for the 'capture lost' event on the ToggleButton.

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.

removeCharacterKeyListener

Removes the listener for the 'character key pressed' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeCharacterKeyListener

Removes the listener for the 'character key pressed' event on the ToggleButton.

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.

removeDeactivatedListener

Removes the listener for the 'deactivated' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeDeactivatedListener

Removes the listener for the 'deactivated' event on the ToggleButton.

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.

removeDisabledListener

Removes the listener for the 'disabled' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeDisabledListener

Removes the listener for the 'disabled' event on the ToggleButton.

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.

removeDragDropListener

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

Parameters:

string key - The key that will trigger the event.

removeDragDropListener

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

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.

removeEnabledListener

Removes the listener for the 'enabled' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeEnabledListener

Removes the listener for the 'enabled' event on the ToggleButton.

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.

removeHiddenListener

Removes the listener for the 'hidden' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeHiddenListener

Removes the listener for the 'hidden' event on the ToggleButton.

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

Parameters:

string key - The key that will trigger the event.

removeKeyPressedListener

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

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

Parameters:

string key - The key that will trigger the event.

removeKeyReleasedListener

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

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

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

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

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

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

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

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

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

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

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

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

removeMouseEnteredListener

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

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

removeMouseLeftListener

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

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

removeMouseMovedListener

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

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

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

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.

removeMovedListener

Removes the listener for the 'moved' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeMovedListener

Removes the listener for the 'moved' event on the ToggleButton.

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.

removeOverlay

Removes an Overlay identified by name contained in this ToggleButton.

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

removeShownListener

Removes the listener for the 'shown' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeShownListener

Removes the listener for the 'shown' event on the ToggleButton.

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.

removeSizedListener

Removes the listener for the 'sized' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeSizedListener

Removes the listener for the 'sized' event on the ToggleButton.

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.

removeTextChangedListener

Removes the listener for the 'text changed' event on the ToggleButton.

Parameters:

string key - The key that will trigger the event.

removeTextChangedListener

Removes the listener for the 'text changed' event on the ToggleButton.

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.

setActivatedListener

Sets a listener to be invoked upon a 'activated' event on the ToggleButton.

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.

setActivatedListener

Sets a listener to be invoked upon a 'activated' event on the ToggleButton.

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.

setAlpha

Sets the alpha level of the ToggleButton.

Parameters:

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

setAlphaChangedListener

Sets a listener to be invoked upon a 'alpha changed' event on the ToggleButton.

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.

setAlphaChangedListener

Sets a listener to be invoked upon a 'alpha changed' event on the ToggleButton.

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.

setCaptureGainedListener

Sets a listener to be invoked upon a 'capture gained' event on the ToggleButton.

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.

setCaptureGainedListener

Sets a listener to be invoked upon a 'capture gained' event on the ToggleButton.

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.

setCaptureLostListener

Sets a listener to be invoked upon a 'capture lost' event on the ToggleButton.

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.

setCaptureLostListener

Sets a listener to be invoked upon a 'capture lost' event on the ToggleButton.

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.

setCharacterKeyListener

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

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.

setCharacterKeyListener

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

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.

setDeactivatedListener

Sets a listener to be invoked upon a 'deactivated' event on the ToggleButton.

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.

setDeactivatedListener

Sets a listener to be invoked upon a 'deactivated' event on the ToggleButton.

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.

setDisabledColour

Changes the colour of the ToggleButton's text when the ToggleButton 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).

setDisabledImage

Sets the image of the ToggleButton when the ToggleButton is disabled.

Parameters:

MediaItem image - Image of the ToggleButton when the ToggleButton is disabled.

setDisabledListener

Sets a listener to be invoked upon a 'disabled' event on the ToggleButton.

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.

setDisabledListener

Sets a listener to be invoked upon a 'disabled' event on the ToggleButton.

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.

setDragDropListener

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

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

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

Parameters:

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

setEnabledListener

Sets a listener to be invoked upon a 'enabled' event on the ToggleButton.

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.

setEnabledListener