Aquae GUI

Class: Spinner

Spinner

The Spinner class provides a GUI representation of a Spinner.

new Spinner(settings)

Creates an instance of a new Spinner control.

Parameters:
Name Type Description
settings
Properties
Name Type Argument Default Description
Parent JQuery

Element within which to inject the textbox.
ForFocus Control <optional>
 null

Control which should receive focus in place of this one.
ParentControl Control <optional>
 null

The containing control.
TabIndex number <optional>
 0

The tab index of the control determines which order controls may shift focus via the tab key.
BlockedKeys Array.<number> <optional>
 []

Key codes which should be blocked from input.
Class string <optional>
 ""

CSS class(es) to apply to the injected textbox, space separated.
DataBinding Object <optional>
 null

The data binding to bind the textbox value to.
KeyBlocker Control <optional>
 settings.ParentControl

Control which should receive input events from blocked keys.
ParentControl Control <optional>
 null

The control which contains the textbox, if applicable.
ReadOnly boolean <optional>
 false

Sets whether or not the control is read-only.
Style Object.<string, string> <optional>
 {}

CSS style to apply to the injected textbox.
Validator Validator <optional>
 Validator

Validator to use in conjunction with the textbox control.
Value string <optional>
 ""

Value to set in the textbox upon creation.
Mixes In:
Source:

Extends

Members

Parent :JQuery

Element within which the spinner has been injected.

Type:
  • JQuery
Source:

ParentControl :Control

The containing control.

Type:
Inherited From:
Source:

Focusables :Array.<JQuery>

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

Type:
  • Array.<JQuery>
Inherited From:
Source:

Focused :boolean

Whether or not the control actively has focus.

Type:
  • boolean
Inherited From:
Source:

CanGetFocus :boolean

Determines whether or not the control may receive focus.

Type:
  • boolean
Inherited From:
Source:

CanTabFocus :boolean

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

Type:
  • boolean
Inherited From:
Source:

ControlUniqueID :number

The globally-unique ID of the control.

Type:
  • number
Inherited From:
Source:

Arguments :Array

Arguments used to instantiate the control.

Type:
  • Array
Inherited From:
Source:

ForFocus :Control

Control which should receive focus in place of this one.

Type:
Inherited From:
Source:

TabIndex :number

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

Type:
  • number
Inherited From:
Source:

Methods

Activate()

Tells a control to render itself in an activated state.

Inherited From:
Source:

Deactivate()

Tells a control to render itself in a deactivated state.

Inherited From:
Source:

Blur()

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

Inherited From:
Overrides:
Source:

Dispose()

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

Inherited From:
Overrides:
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.
Inherited From:
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.
Inherited From:
Source:

Keydown(event)

Handles the keydown event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keydown event object.
Inherited From:
Overrides:
Source:

Keypress(event)

Handles the keypress event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keypress event object.
Inherited From:
Overrides:
Source:

Keyup(event)

Handles the keyup event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The keyup event object.
Inherited From:
Overrides:
Source:

Mousedown(event)

Handles the mousedown event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The mousedown event object.
Inherited From:
Overrides:
Source:

Mouseup(event)

Handles the mouseup event for a control.

Parameters:
Name Type Description
event IJQueryEventObject

The mouseup event object.
Inherited From:
Overrides:
Source:

Mousewheel(event)

Handles the mousewheel event for a control

Parameters:
Name Type Description
event IJQueryEventObject

The mousewheel event object.
Inherited From:
Source: