Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Spinner

Package | org.apache.flex.html
Class | public class Spinner
Inheritance | Spinner UIBase HTMLElementWrapper flash.display.Sprite

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The Spinner class is a component that displays a control for incrementing a value and a control for decrementing a value. The org.apache.flex.html.NumericStepper uses a Spinner as part of the component. Spinner uses the following beads: org.apache.flex.core.IBeadModel: an IRangeModel to hold the properties. org.apache.flex.core.IBeadView: the bead that constructs the visual parts of the Spinner. org.apache.flex.core.IBeadController: a bead that handles the input events.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | $height : Number [read-only] Retrieve the low-level bounding box height. | UIBase
|  | $width : Number [read-only] Retrieve the low-level bounding box width. | UIBase
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIBase
|  | className : String The classname. | UIBase
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | height : Number [override] The height of the component. | UIBase
|  | id : String An id property for MXML documents. | UIBase
|  | maximum : Number The maximum value of the Spinner. | Spinner
|  | measurementBead : IMeasurementBead [read-only] A measurement bead, if one exists. | UIBase
|  | minimum : Number The minimum value of the Spinner. | Spinner
|  | model : Object An IBeadModel that serves as the data model for the component. | UIBase
|  | numElements : int [read-only] The number of elements in the parent. | UIBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIBase
|  | snapInterval : Number The modulus for the value. | Spinner
|  | stepSize : Number The amount to increase or descrease the value. | Spinner
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIBase
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIBase
|  | typeNames : String A list of type names. | UIBase
|  | value : Number The current value of the Spinner. | Spinner
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIBase
|  | width : Number [override] The width of the component. | UIBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Spinner() constructor. | Spinner
|  | addBead(bead:IBead):void [override] Add a bead to the strand. | UIBase
|  | addedToParent():void The method called when added to a parent. | UIBase
|  | addElement(c:Object, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIBase
|  | getElementAt(index:int):Object Get a component from the parent. | UIBase
|  | getElementIndex(c:Object):int Gets the index of this subcomponent. | UIBase
|  | isHeightSizedToContent():Boolean | UIBase
|  | isWidthSizedToContent():Boolean | UIBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIBase
|  | removeElement(c:Object, dispatchEvent:Boolean = true):void Remove a component from the parent. | UIBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase
|  | setX(value:Number):void | UIBase
|  | setY(value:Number):void | UIBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | repeaterListener(event:Event):void Rebroadcast an event from a sub component from the component. | UIBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseDown | Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseMove | Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOut | Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOver | Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseUp | Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOut | Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOver | Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | valueChange |  | Spinner

Property Detail

maximum | property

`maximum:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The maximum value of the Spinner.

Implementation
`public function get maximum():Number`
`public function set maximum(value:Number):void`

minimum | property |

`minimum:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The minimum value of the Spinner.

Implementation
`public function get minimum():Number`
`public function set minimum(value:Number):void`

snapInterval | property |

`snapInterval:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The modulus for the value. If this property is set, the value displayed with a muliple of the snapInterval.

Implementation
`public function get snapInterval():Number`
`public function set snapInterval(value:Number):void`

stepSize | property |

`stepSize:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The amount to increase or descrease the value. The value will not exceed the minimum or maximum value. The final value is affected by the snapInterval.

Implementation
`public function get stepSize():Number`
`public function set stepSize(value:Number):void`

value | property |

`value:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The current value of the Spinner.

Implementation
`public function get value():Number`
`public function set value(value:Number):void`
Constructor Detail

Spinner | () | Constructor

`public function Spinner()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

constructor.

Event Detail

valueChange | Event

Event Object Type: `org.apache.flex.events.Event`

Mon Sep 5 2016, 07:19 AM -07:00