Aquae GUI

Class: Control

Control

<abstract> new Control( [settings])

Creates an instance of a new Control, should only be called when creating derivative controls.

Parameters:
Name Type Argument Description
settings Object <optional>

The properties object used in the creation of the control.
Source:

Members

ParentControl :Control

The containing control.

Type:
Source:

Focusables :Array.<JQuery>

List of elements which should have focus related CSS classes set and events hooked.

Type:
  • Array.<JQuery>
Source:

Focused :boolean

Whether or not the control actively has focus.

Type:
  • boolean
Source:

CanGetFocus :boolean

Determines whether or not the control may receive focus.

Type:
  • boolean
Source:

CanTabFocus :boolean

Determines whether or not the control may receive focus via the tab key.

Type:
  • boolean
Source:

ControlUniqueID :number

The globally-unique ID of the control.

Type:
  • number
Source:

Arguments :Array

Arguments used to instantiate the control.

Type:
  • Array
Source:

ForFocus :Control

Control which should receive focus in place of this one.

Type:
Source:

TabIndex :number

The tab index of the control determines which order controls may shift focus via the tab key.

Type:
  • number
Source:

Methods

Activate()

Tells a control to render itself in an activated state.

Source:

Deactivate()

Tells a control to render itself in a deactivated state.

Source:

Blur()

Causes control instance to be blurred and fire off associated events, while bubbling up through containing controls.

Source:

Blur(event)

Fires off a context menu request for the control if available, otherwise bubbles up to containing controls.

Parameters:
Name Type Description
event IJQueryEventObject

The contextmenu event object.
Source:

Dispose()

Disposes of the base control instance and frees up allocated resources.

Source:

Focus( [last])

Causes control instance to be focused if available while firing off associated events, while bubbling up through containing controls when the control instance cannot receive focus.

Parameters:
Name Type Argument Default Description
last boolean <optional>
 false

Causes focus to bubble down into contained controls.
Source:

Initialize(args, parentControl, focusables)

Initializes an instance of a control.

Parameters:
Name Type Description
args Array

Arguments used to instantiate derived control.
parentControl Control

Parent control, if applicable.
focusables Array.<JQuery>

Array of focusable elements.
Source:

Keydown(event)

Handles the keydown event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keydown event object.
Source:

Keypress(event)

Handles the keypress event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keypress event object.
Source:

Keyup(event)

Handles the keyup event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keyup event object.
Source:

Mousedown(event)

Handles the mousedown event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The mousedown event object.
Source:

Mouseup(event)

Handles the mouseup event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The mouseup event object.
Source:

Mousewheel(event)

Handles the mousewheel event for a control

Parameters:
Name Type Description
event IJQueryEventObject

The mousewheel event object.
Source: