Crossfader
class Crossfader extends UIComponent
The Crossfader class creates an image (gif, jpg, png, swf) slide show with a crossfading transition between slides.
Property summary
| Property | Description |
|---|---|
| autoSize:Boolean | Gets or sets the autoSize property. Determines whether to scale the images to the component width & height. The default value is true. |
| controls:Sprite | [read-only] A reference to the controls DisplayObject. |
| dataProvider:DataProvider | Gets or sets the data model of the list of items to be viewed. A data provider can be shared by multiple list-based components. Changes to the data provider are immediately available to all components that use it as a data source. The default value is null. |
| displayDuration:Number | Gets or sets the amount of time (in seconds) to display each slide. The default value is 3 seconds. |
| enabled:Boolean | Gets or sets a value that indicates whether the component can accept user interaction. The default value is true. |
| fadeDuration:Number | Gets or sets the amount of time (in seconds) the transition takes. The default value is 2. |
| imageField:String | Gets or sets the item field that provides the image for the item. The default value is “src”. |
| linkField:String | Gets or sets the item field that provides the url for the item. The default value is “link”. |
| selectedIndex:int | Gets or sets the index of the item that is visible. The default value is 0. |
| selectedItem:Object | [read-only] Gets the item that is visible. |
| showControls:Boolean | Gets or sets the whether to display the controls The default value is true. |
Method summary
| Method | Description |
|---|---|
| next() : uint | Displays the next image. |
| prev() : uint | Displays the previous image |
| redraw(event:) : void | Initiates the internal draw() function |
Crossfader()
Description
Creates a new Crossfader component instance
next() : uint
Usage
public function next():uint
Returns
Nothing.
Description
Displays the next image.
See Also
prev() : uint
Usage
public function prev():uint
Returns
Nothing.
Description
Displays the previous image
See Also
redraw(event:) : void
Usage
public function redraw(event = null):void
Returns
Nothing.
Description
Initiates the internal draw() function
autoSize : Boolean
Usage
public function get autoSize():Boolean
Description
[read-write]
Gets or sets the autoSize property.
Determines whether to scale the images to the component width & height.
The default value is true.
controls : Sprite
Usage
public function get controls():Sprite
Description
[read-only]
A reference to the controls DisplayObject.
dataProvider : DataProvider
Usage
public function get dataProvider():DataProvider
Description
[read-write]
Gets or sets the data model of the list of items to be viewed.
A data provider can be shared by multiple list-based components.
Changes to the data provider are immediately available to all components that use it as a data source.
The default value is null.
displayDuration : Number
Usage
public function get displayDuration():Number
Description
[read-write]
Gets or sets the amount of time (in seconds) to display each slide.
The default value is 3 seconds.
enabled : Boolean
Usage
override public function get enabled():Boolean
Description
[read-write]
Gets or sets a value that indicates whether the component can accept user interaction.
The default value is true.
fadeDuration : Number
Usage
public function get fadeDuration():Number
Description
[read-write]
Gets or sets the amount of time (in seconds) the transition takes.
The default value is 2.
imageField : String
Usage
public function get imageField():String
Description
[read-write]
Gets or sets the item field that provides the image for the item.
The default value is “src”.
linkField : String
Usage
public function get linkField():String
Description
[read-write]
Gets or sets the item field that provides the url for the item.
The default value is “link”.
selectedIndex : int
Usage
public function get selectedIndex():int
Description
[read-write]
Gets or sets the index of the item that is visible.
The default value is 0.
selectedItem : Object
Usage
public function get selectedItem():Object
Description
[read-only]
Gets the item that is visible.
showControls : Boolean
Usage
public function get showControls():Boolean
Description
[read-write]
Gets or sets the whether to display the controls
The default value is true.