| Package | ardisia.components.carouselList |
| Class | public class CarouselList |
| Inheritance | CarouselList  spark.components.List |
Supports animation between elements. See the easer and duration properties.
Keyboard navigation is also supported.
To jump to elements in the list, use the centerIndex() property.
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
| duration : Number = 350
The duration of the animations. | CarouselList | ||
| easer : IEaser
The easer to use for animations. | CarouselList | ||
| Method | Defined By | ||
|---|---|---|---|
centerIndex(index:int):void
Center the renderer in the layout. | CarouselList | ||
startAnimation(scrollTo:Number):void
Start a scrolling animation. | CarouselList | ||
| Method | Defined By | ||
|---|---|---|---|
dataProvider_collectionChangeHandler(event:Event):void [override]
Handles the collection events on the dataProvider. | CarouselList | ||
hScrollerPartHandler(event:Event):void
Handles events on the HScroller skin part. | CarouselList | ||
mouseHandler(event:MouseEvent):void
Handles mouse events. | CarouselList | ||
updateHScroller():void
Updates the HScroller skin part. | CarouselList | ||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
hScrollerPart:spark.components.supportClasses.ScrollBarBase | Required: false Part Type: Static Scroll bar used to navigate the coverflow. | CarouselList | ||
| duration | property |
public var duration:Number = 350The duration of the animations. Set to 0 to skip animation.
The default value is 350.
| easer | property |
public var easer:IEaserThe easer to use for animations.
The default value is Power(0.1, 4).
| centerIndex | () | method |
public function centerIndex(index:int):voidCenter the renderer in the layout.
Parameters
index:int — the index of the renderer
|
| dataProvider_collectionChangeHandler | () | method |
override protected function dataProvider_collectionChangeHandler(event:Event):voidHandles the collection events on the dataProvider.
Parameters
event:Event — The CollectionEvent that triggered the handler
|
| hScrollerPartHandler | () | method |
protected function hScrollerPartHandler(event:Event):voidHandles events on the HScroller skin part.
Parameters
event:Event — the Event that triggered the handler
|
| mouseHandler | () | method |
protected function mouseHandler(event:MouseEvent):voidHandles mouse events.
Parameters
event:MouseEvent — the MouseEvent that triggered the handler
|
| startAnimation | () | method |
public function startAnimation(scrollTo:Number):voidStart a scrolling animation.
Parameters
scrollTo:Number — the property to animate
|
| updateHScroller | () | method |
protected function updateHScroller():voidUpdates the HScroller skin part.