Stack (AS 3.0) V. 1.3 Documentation
Properties
| Name | Type | Description |
| animationStyle | Object | Defines how items should animate. Options
Example: myStack.animationStyle = {enabled:true, easing:"easeOut", duration:1500, type:"Strong"} |
| content | Collection | Sets the content of the Stack. Options: 1. path:String – path to load 2. description:String – item description 3. data:String – misc. data 4. type:String – similar to tooltip (image, instance, etc) Example: import fl.data.DataProvider; import com.afcomponents.events.StackEvent; function onStackInit(event:Event) { var dp:DataProvider = new DataProvider(); dp.addItem({path:"pic.jpg", type:"image", description:"text description", data:"http://www.url.com"}); myStack.content = dp; } myStack.addEventListener(StackEvent.INITIALIZE, onStackInit); |
| contentXML | String | Path to an XML or RSS file that describes data for Stack content. XML File Format: <content> <item> <description>Image 1</description> <path>image.jpg</path> <data>url.html</data> <type>image</type> </item> </content> Example: myStack.contentXML = "some_file.xml" |
| slideShowStyle | Object | Defines slide show settings. Options 1. enabled:Boolean 2. loop:Boolean 3. time:Number Example: myStack.slideShowStyle = {enabled:true, loop:true, time:2000}; |
| itemDefaultStyle | Object | Defines the default container style for each item. Options 1. cornerRadius:Number 2. fill:Boolean 3. fillAlpha:Number 4. fillColor:Number 5. stroke:Boolean 6. strokeAlpha:Number 7. strokeColor:Number 8. strokeWidth:Number 9. horizontalPadding:Number 10. verticalPadding:Number Example myStack.itemDefaultStyle = {cornerRadius:10, fill:false, fillAlpha:1, fillColor:0x000000, stroke:false, strokeAlpha:1, strokeColor:0x000000, strokeWidth:1, horizontalPadding:0, verticalPadding:0}; |
| itemOverStyle | Object | Defines the over container style for each item. Options 1. cornerRadius:Number 2. fill:Boolean 3. fillAlpha:Number 4. fillColor:Number 5. stroke:Boolean 6. strokeAlpha:Number 7. strokeColor:Number 8. strokeWidth:Number 9. horizontalPadding:Number 10. verticalPadding:Number Example myStack.itemOverStyle = {cornerRadius:7, fill:false, fillAlpha:1, fillColor:0x000000,stroke:true,strokeAlpha:1, strokeColor:0xFF0000, strokeWidth:1, horizontalPadding:0, verticalPadding:0}; |
| itemSelectedStyle | Object | Defines the selected container style for each item. Note: itemOverStyle should be disabled for the selected item. Options 1. cornerRadius:Number 2. fill:Boolean 3. fillAlpha:Number 4. fillColor:Number 5. stroke:Boolean 6. strokeAlpha:Number 7. strokeColor:Number 8. strokeWidth:Number 9. horizontalPadding:Number 10. verticalPadding:Number Example myStack.itemSelectedStyle = {cornerRadius:7, fill:false, fillAlpha:1, fillColor:0x000000, stroke:false, strokeAlpha:1, strokeColor:0x000000, strokeWidth:1, horizontalPadding:0, verticalPadding:0}; |
| stackStyle | Object | Property defines the 3D rotation and perspective. Options 1. direction:String (IN or OUT) 2. displayedItemsCount:Number 3. rotationX:Number [- 180 | 180 ] 4. rotationY:Number [- 180 | 180 ] 5. rotationZ:Number [- 180 | 180 ] 6. distance:Number Example myStack.stackStyle = {direction:"IN", displayedItemsCount:8, rotationX:-30, rotationY:0, rotationZ:0, distance:100}; |
| fadeEnabled | Boolean | Property defines whether items fade out towards the back of the stack. Example myStack.fadeEnabled = true; |
| reflectionStyle | Object | Defines reflection settings. Options 1. enabled:Boolean 2. alpha:Number 3. clipAlpha:Number 4. distance:Number 5. matrixRatio:Number 6. matrixDropOff:Number Example myStack.reflectionStyle = {enabled:true, alpha:0.5, clipAlpha:0.5, distance:0, matrixRatio:1, matrixDropOff:1.2}; |
| displayStyle | Object | Property defines how images are sized. Options 1. autoSize:Boolean 2. maintainAspectRatio:Boolean 3. scaleContent:Boolean Example myStack.displayStyle = {autoSize:false, maintainAspectRatio:true, scaleContent:true}; |
| previewClip | String | Property defines a class of a placeholder movie clip. Example myStack.previewClip = MyClip; |
| length | Number | Read-only property indicates the number of items in the stack. Example trace(myStack.length); |
| camera3D | Object | See Papervision3D documentation. Example import org.papervision3d.objects.*; // position for the camera to look at var zero:DisplayObject3D = DisplayObject3D.ZERO; myStack.scene3D.addChild(zero); // camera settings myStack.camera3D.x = 125; myStack.camera3D.y = -110; myStack.camera3D.zoom = 3; // update view for user based on settings myStack.camera3D.lookAt(zero); |
Methods
| Name | Return Type | Description |
| getItemAt( item ) | Object | Returns content item object specified by Number attribute. Example myStack.getItemAt(3); |
| getSelectedItem( ) | Object | Returns selected item object. Example var item:Object = new Object(); item = myStack.getSelectedItem(); trace(item.description); trace(item.path); trace(item.data); } |
| getSelectedIndex( ) | Number | Returns selected item index Example myStack.getSelectedIndex(); |
| getItemIdex( item ) | Number | Returns static item index. Example myCarousel.getItemIndex(myCarousel.getSelectedItem()); |
| selectItem( item ) | Void | Selects the item. Example myStack.selectItem(myStack.getItemAt(3)); |
| selectItemAt( item ) | Void | Selects the item. Example myStack.selectItemAt(3); |
| selectNextItem( ) | Void | Selects next item. Example myStack.selectNextItem(); |
| selectPreviousItem( ) | Void | Selects previous item. Example myStack.selectPreviousItem(); |
| addItem( item ) | Void | Adds an item to the stack. Example myStack.addItem({description:"description", path:"pic.jpg", data:"url.html", type:"image"}); |
| addItemAt( item, index ) |
Void | Adds an item to the stack at the indicated index. Example var itemToAdd:Object ={description:"description", path:"pic.jpg", data:"url.html", type:"image"}; myStack.addItemAt(itemToAdd,1); |
| removeItem( item ) | Void | Removes the item from the stack. Note: This is a known issue with removing the selected item. Example myStack.removeItem(myStack.getItemAt(3)); |
| removeAll( ) | Void | Removes all items from the stack. Example myStack.removeAll(); |
| addItemEventListener( index,event,listener ) | Void | Adds an event to the indicated item by index in the stack. Note: To add an event to all items, loop stack.length. Example import flash.events.MouseEvent; import com.afcomponents.events.StackEvent; function contentLoad (event:Event) { for (var i:Number = 0; i<=myStack.length-1; i++) { myStack.addItemEventListener (i, MouseEvent.CLICK, itemClick); } } myStack.addEventListener(StackEvent.CONTENT_LOAD_START, contentLoad); |
Events
| Name | Return Value | Description |
| INITIALIZE | target type |
Triggered after component initializes. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.INITIALIZE, eventHandler); |
| ERROR | target type message |
Triggered once error occurs. If there is an error loading an image this event fired. If a wrong parameter is passed to a function this event is fired. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); trace(event.message); } myStack.addEventListener(StackEvent.ERROR, eventHandler); |
| CHANGE | type target |
Triggered once any of the component properties is modified or component state changes. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.CHANGE, eventHandler); |
| XML_LOAD_START | type target |
Triggered when XML loading starts. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.XML_LOAD_START, eventHandler); |
| XML_LOAD_PROGRESS | type target bytesLoaded bytesTotal |
Triggered during XML loading to track progress. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.XML_LOAD_PROGRESS, eventHandler); |
| XML_LOAD_COMPLETE | type target |
Triggered when XML loading is finished. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.XML_LOAD_COMPLETE, eventHandler); |
| ITEM_LOAD_START | type target |
Triggered for each item when it starts loading. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.ITEM_LOAD_START, eventHandler); |
| ITEM_LOAD_PROGRESS | type target bytesLoaded bytesTotal |
Triggered for each item during loading to track progress. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.ITEM_LOAD_PROGRESS, eventHandler); |
| ITEM_LOAD_COMPLETE | type target |
Triggered for each item when loading is finished. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.ITEM_LOAD_COMPLETE, eventHandler); |
| CONTENT_LOAD_START | type target |
Triggered when content loading starts. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.CONTENT_LOAD_START, eventHandler); |
| CONTENT_LOAD_PROGRESS | type target itemsLoaded itemsTotal |
Triggered during content loading to track progress. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.CONTENT_LOAD_PROGRESS, eventHandler); |
| CONTENT_LOAD_COMPLETE | type target |
Triggered when content loading is finished. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myStack.addEventListener(StackEvent.CONTENT_LOAD_COMPLETE, eventHandler); |
| ITEM_SELECTED | type target |
Triggered once the item is selected. This event is triggered during the during the slide show mode. Example import com.afcomponents.events.StackEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); //selected item } myStack.addEventListener(StackEvent.ITEM_SELECTED, eventHandler); |
