Packageorg.as3lib.kitchensync.action
Classpublic class KSStepedSequenceGroup
InheritanceKSStepedSequenceGroup Inheritance KSSequenceGroup Inheritance AbstractActionGroup Inheritance AbstractAction Inheritance flash.events.EventDispatcher

A sequence that plays each child then pauses until it is started again. Perfect for slideshow or powerpoint-like applications.



Public Properties
 PropertyDefined by
 InheritedautoDelete : Boolean
autoDelete is a flag that indicates whether the action should be killed when it is done executing.
AbstractAction
 InheritedchildActions : Array
An array containing all of the child actions of the group.
AbstractActionGroup
 InheritedchildrenAreRunning : Boolean
KSSequenceGroup
 InheritedcurrentAction : IAction
KSSequenceGroup
 Inheriteddelay : int
delay is the time that will pass after the start() method is called before the action begins.
AbstractAction
 Inheritedduration : *
AbstractActionGroup
 InheriteddurationHasElapsed : Boolean
Checks to see whether the duration of the action has elapsed and if the _startTime is defined.
AbstractAction
 InheritedisInstantaneous : Boolean
Returns true if the action will occur instantaneously when started
AbstractAction
 InheritedisPaused : Boolean
Will return true if the action is paused (after pause() has been called).
AbstractAction
 InheritedisRunning : Boolean
The human-readable name of this action.
AbstractAction
 Inheritedoffset : int
legacy accessors.
AbstractAction
 InheritedpauseTime : Timestamp
The time at which the action was last paused.
AbstractAction
 InheritedresetChildrenAtStart : Boolean = true
If true, the group's KSTween children will reset to their default positions when the group is started.
AbstractActionGroup
 InheritedstartTime : Timestamp
The time at which the action was last started.
AbstractAction
 InheritedstartTimeHasElapsed : Boolean
Checks to see whether the start time delay has elapsed and if the _startTime is defined.
AbstractAction
 Inheritedsync : Boolean
Setting sync to true will cause the action to sync up with real time even if framerate drops.
AbstractAction
 InheritedtimeStringParser : ITimeStringParser
[static] The timeStringParser will determine how strings are parsed into valid time values.
AbstractAction
Protected Properties
 PropertyDefined by
 Inherited_autoDelete : Boolean
AbstractAction
 Inherited_childActions : Array
AbstractActionGroup
 Inherited_currentAction : IAction = null
KSSequenceGroup
 Inherited_currentActionIndex : int = -1
KSSequenceGroup
 Inherited_delay : int = 0
AbstractAction
 Inherited_duration : int = 0
AbstractAction
 Inherited_paused : Boolean = false
AbstractAction
 Inherited_pauseTime : Timestamp
AbstractAction
 Inherited_running : Boolean = false
AbstractAction
 Inherited_startTime : Timestamp
AbstractAction
 Inherited_sync : Boolean
AbstractAction
  _waitingForInput : Boolean = false
Used internally to determine whether the next item should play or whether the children should simply be unpaused when the unpause() method is called.
KSStepedSequenceGroup
Public Methods
 MethodDefined by
  
KSStepedSequenceGroup(... children)
Constructor.
KSStepedSequenceGroup
 Inherited
addAction(action:IAction, ... additionalActions):void
Adds an action to the group.
AbstractActionGroup
 Inherited
addActionAtIndex(action:IAction, index:int = -1):void
Adds an action to the group at the specified index.
AbstractActionGroup
 Inherited
addEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Causes the action to start playing when a specified event is fired.
AbstractAction
 Inherited
addTrigger(trigger:IAction):void
Causes the action to start playing when another event completes.
AbstractAction
 Inherited
KSSequenceGroup
 Inherited
Returns the action at the specified index.
AbstractActionGroup
 Inherited
kill():void
AbstractActionGroup
 Inherited
pause():void
AbstractActionGroup
 Inherited
register():void
Adds the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
Removes an action from the group.
AbstractActionGroup
 Inherited
Removes an action at the specified index.
AbstractActionGroup
 Inherited
removeEventTrigger(dispatcher:IEventDispatcher, eventType:String):void
Removes an event trigger added by addEventTrigger().
AbstractAction
 Inherited
removeTrigger(trigger:IAction):void
Removes a trigger added with addTrigger().
AbstractAction
 Inherited
Reverse the order that the children play back in.
AbstractActionGroup
 Inherited
Override start to automatically quit if there are no children.
KSSequenceGroup
 Inherited
stop():void
AbstractActionGroup
 Inherited
toString():String
KSSequenceGroup
  
unpause():void
Override unpause to see if the sequence was paused internally or externally.
KSStepedSequenceGroup
 Inherited
unregister():void
Removes the action as a listener to the Synchronizer's update event.
AbstractAction
 Inherited
update(currentTimestamp:Timestamp):void
Listens for updates to synchronize the start time of the sequence.
KSSequenceGroup
Protected Methods
 MethodDefined by
 Inherited
checkForComplete():Boolean
Checks to see if all of the children have completed.
KSSequenceGroup
 Inherited
complete():void
override to reset the _currentActionIndex.
KSSequenceGroup
 Inherited
forceUpdate():void
Foreces the update() method to fire without being triggered by Synchronizer.
AbstractAction
  
Override the onChildFinished handler to pause the sequence after each child completes.
KSStepedSequenceGroup
 Inherited
Dispatches a CHILD_START event when the child begins.
AbstractActionGroup
 Inherited
onTrigger(event:Event):void
Handler that starts playing the action that is called by a trigger event.
AbstractAction
 Inherited
Starts playing the next action in the sequence.
KSSequenceGroup
Events
 EventSummaryDefined by
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractAction
 Inherited  AbstractActionGroup
 Inherited  AbstractActionGroup
Protected Constants
 ConstantDefined by
 InheritedNO_CURRENT_ACTION_INDEX : int = -1
KSSequenceGroup
Property detail
_waitingForInputproperty
protected var _waitingForInput:Boolean = false

Used internally to determine whether the next item should play or whether the children should simply be unpaused when the unpause() method is called.

Constructor detail
KSStepedSequenceGroup()constructor
public function KSStepedSequenceGroup(... children)

Constructor. Identical to KSSequenceGroup.

Parameters
... children — Optional children to add upon instantiation.
Method detail
onChildFinished()method
protected override function onChildFinished(event:KitchenSyncEvent):void

Override the onChildFinished handler to pause the sequence after each child completes.

Parameters
event:KitchenSyncEvent
unpause()method 
public override function unpause():void

Override unpause to see if the sequence was paused internally or externally.