| Package | com.gestureworks.cml.element |
| Class | public class Slideshow |
| Inheritance | Slideshow  Container ContainerFactory ElementFactory flash.display.Sprite |
var slideShow:Slideshow = new Slideshow();
slideShow.x = 500;
slideShow.y = 100;
slideShow.rate = 2000;
slideShow.fadeDuration = 1000;
slideShow.loop = true;
slideShow.autoplay = true;
addChild(slideShow);
slideShow.addChild(text1);
slideShow.childToList("text1", text1);
slidheShow.addChild(graphic1);
slideShow.childToList("circle", graphic1);
slideShow.init();
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| autoplay : Boolean
Sets autoplay variable. | Slideshow | ||
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| childList : ChildList [read-only]
store the child list
| ContainerFactory | |
| class_ : String
Object's css class;
| ElementFactory | |
| className : String
sets the class name of displayobject
| ElementFactory | |
| cmlIndex : int
sets the cml index
| ElementFactory | |
| currentIndex : int
sets the current index of slides
| Slideshow | ||
| debugStyle : *
sets the debug style
| ElementFactory | |
| dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | |
| displayEvents : String
Use for dispatch completes. | ElementFactory | |
| dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | |
| fadeDuration : Number
Cross-fade duration in milliseconds, must be less than seqeunce rate
| Slideshow | ||
| height : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| heightPercent : String
sets the height percent of display object
| ElementFactory | |
| horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | |
| id : String
sets the id of child
| ElementFactory | |
| index : int
sets the index of display object
| ElementFactory | |
| infoSource : String
sets info source
| ContainerFactory | |
| layout : *
Sets the layout of the container
| Container | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| Container | |
| layoutList : Dictionary
Defines the layoutlist
| Container | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| Container | |
| left : Number
sets left value
| ElementFactory | |
| loop : Boolean
Sets whether or not the sequence will loop once it reaches the end or beginning depending on play direction. | Slideshow | ||
| paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | Container | |
| paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | |
| paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | |
| paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | |
| position : String
Sets the position
| Container | |
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| rate : Number
Rate of change between slides in milliseconds
| Slideshow | ||
| right : Number
sets the right value
| ElementFactory | |
| scale : Number
Sets both the x and y scale values
| ElementFactory | |
| scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| state : Array
property states array
| ElementFactory | |
| top : Number
sets top value
| ElementFactory | |
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Property | Defined By | ||
|---|---|---|---|
| timer : Timer | Slideshow | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
| Slideshow | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
TODO: This mechanism should be abstracted to better syncrhonize child and display lists
| Container | |
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
clear():void
Method to clear children and reset the childlist so the slideshow can be repopulated by running
init without simply appending or duplicating itself or the ChildList. | Slideshow | ||
| clone():*
Returns clone of self
| ElementFactory | |
displayComplete():void [override]
CML callback Initialisation
| Slideshow | ||
dispose():void [override]
Dispose method to remove children
| Slideshow | ||
fadein(index:int):void
adds the slideshow items and tweening for current item
| Slideshow | ||
fadeout(index:int):void
tweening for last item and removes the slide show items
| Slideshow | ||
forward():void
resume method
| Slideshow | ||
| getIndex(index:int):*
returns childlist index
| Container | |
| getKey(key:String):*
returns the childlist key
| Container | |
| hideIndex(index:int):void
hides the childlist index
| Container | |
| hideKey(key:String):void
hides the childlist key
| Container | |
init():void [override]
Initialisation method
| Slideshow | ||
next():void
Goes to the next slide without restarting playback or changing play direction. | Slideshow | ||
onComplete(event:TimerEvent):void
plays the slideshow
| Slideshow | ||
onTimer(event:TimerEvent):void
timer event
| Slideshow | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
pause():void
pauses the slideshow
| Slideshow | ||
play():void
plays the slideshow
| Slideshow | ||
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
previous():void
Goes to the previous slide without restarting playback or changing play direction. | Slideshow | ||
reverse():void | Slideshow | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | |
| setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | |
| showIndex(index:int):void
shows the childlist index
| Container | |
| showKey(key:String):void
shows the childlist key
| Container | |
snapTo(index:Number):void | Slideshow | ||
stop():void
stops the slideshow
| Slideshow | ||
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
reset():void | Slideshow | ||
showNext():void | Slideshow | ||
showPrev():void | Slideshow | ||
| autoplay | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesautoplay:BooleanSets autoplay variable.
public function get autoplay():Boolean public function set autoplay(value:Boolean):void| currentIndex | property |
currentIndex:intsets the current index of slides
The default value is =-1;.
public function get currentIndex():int public function set currentIndex(value:int):void| fadeDuration | property |
fadeDuration:NumberCross-fade duration in milliseconds, must be less than seqeunce rate
The default value is 250.
public function get fadeDuration():Number public function set fadeDuration(value:Number):void| loop | property |
loop:BooleanSets whether or not the sequence will loop once it reaches the end or beginning depending on play direction.
public function get loop():Boolean public function set loop(value:Boolean):void| rate | property |
rate:NumberRate of change between slides in milliseconds
The default value is 1000.
public function get rate():Number public function set rate(value:Number):void| timer | property |
protected var timer:Timer| Slideshow | () | Constructor |
public function Slideshow()Constructor
| clear | () | method |
public function clear():voidMethod to clear children and reset the childlist so the slideshow can be repopulated by running init without simply appending or duplicating itself or the ChildList.
| displayComplete | () | method |
override public function displayComplete():voidCML callback Initialisation
| dispose | () | method |
override public function dispose():voidDispose method to remove children
| fadein | () | method |
public function fadein(index:int):voidadds the slideshow items and tweening for current item
Parameters
index:int |
| fadeout | () | method |
public function fadeout(index:int):voidtweening for last item and removes the slide show items
Parameters
index:int |
| forward | () | method |
public function forward():voidresume method
| init | () | method |
override public function init():voidInitialisation method
| next | () | method |
public function next():voidGoes to the next slide without restarting playback or changing play direction.
| onComplete | () | method |
public function onComplete(event:TimerEvent):voidplays the slideshow
Parameters
event:TimerEvent |
| onTimer | () | method |
public function onTimer(event:TimerEvent):voidtimer event
Parameters
event:TimerEvent |
| pause | () | method |
public function pause():voidpauses the slideshow
| play | () | method |
public function play():voidplays the slideshow
| previous | () | method |
public function previous():voidGoes to the previous slide without restarting playback or changing play direction.
| reset | () | method |
protected function reset():void| reverse | () | method |
public function reverse():void| showNext | () | method |
protected function showNext():void| showPrev | () | method |
protected function showPrev():void| snapTo | () | method |
public function snapTo(index:Number):voidParameters
index:Number |
| stop | () | method |
public function stop():voidstops the slideshow