documentation

Documentation generator: JsDoc Toolkit 2.4.0
Template: Wink 1.0
Generated on:

Class wink.ui.xy.Spinner

Implement a spinner.
As spinner images (dark background and light background) are base 64 encoded and included in this class as _DARK_BG_IMAGE and _LIGHT_BG_IMAGE, you should remove the one you don't need.

To instantiate the spinner, you should specify the image you want to see.
It can be "light","dark" or "personal".
If you choose "personal", you must specify the image yourself in the properties (adding a "backgroundImage" to the properties). In this case, the background image should be of that form: "data:image/[gif/png/jpeg];base64,[base64 image content]"
Use the 'getDomNode' method to add it to your page.

Class Summary
Constructor Attributes Constructor Name and Description
 
wink.ui.xy.Spinner(properties)
Compatibility
Compatibility list Supported platforms / browsers
iOS2, iOS3, iOS4, iOS5, iOS6, Android 1.5, Android 2.1, Android 2.2, Android 2.3, Android 3.0, Android 3.1, Android 4.0, BlackBerry 6, BlackBerry 7, Bada 1.0, Windows Phone 8

Method Summary

Class Detail

wink.ui.xy.Spinner(properties)
var properties = 
{
	background: "light"
}

var spinner = new wink.ui.xy.Spinner(properties);

wink.byId('output').appendChild(spinner.getDomNode());
Parameters:
{object} properties
The properties object
{string} properties.background
The type of background (either "dark", "light" or "personal")
{string} properties.backgroundImage Optional
The spinner image (in case the background was declared as "personal")
See:
Test page

Field Detail

{string} background
The type of background (either "dark", "light" or "personal")
{string} backgroundImage
The spinner image (in case the background was declared as "personal")
{integer} size
The size of the spinner (in pixels)
{integer} uId
Unique identifier

Method Detail

  • {HTMLElement} getDomNode()
    Returns the main DOM node of the Spinner
    Returns:
    {HTMLElement} The main dom node