| Package | impression.players.sequencers |
| Class | public class CommandSequencer |
| Inheritance | CommandSequencer  BasePlayer flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
 | alwaysCheckComplete : Boolean
Specifies how the object should handle storyboard completion. | BasePlayer | |
| commandObjects : ChildElementCollection [read-only]
The command objects associated with the storyboard. | CommandSequencer | ||
| narrationComplete : Boolean
Indicates whether narration has finished playing. | BasePlayer | |
| position : int
The position of the sequencer. | CommandSequencer | ||
| status : String [read-only]
The current status of the sequencer. | CommandSequencer | ||
| storyboard : Storyboard [override]
Specifies the storyboard for the player. | CommandSequencer | ||
| useLastPosition : Boolean
Indicates whether or not the last position should be used when loading a previously loaded storyboard. | CommandSequencer | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the CommandSequencer. | CommandSequencer | ||
| checkForComplete():void
Causes the player to examine the completion criteria for the current storyboard. | BasePlayer | |
getStoryboardState(sb:Storyboard):String [static]
Creates a string describing the state of the storyboard. | CommandSequencer | ||
resetStoryboard(sb:Storyboard):void [static]
Removes all properties set by the player. | CommandSequencer | ||
setStoryboardState(sb:Storyboard, state:String):void [static]
Modifies the storyboard to match the described state passed. | CommandSequencer | ||
| Method | Defined By | ||
|---|---|---|---|
| initializeStoryboard():void
Initializes the storyboard. | BasePlayer | |
loadStoryboard():void [override]
Loads the storyboard. | CommandSequencer | ||
[override]
Removes known completion criteria from the CompleteRemaining storyboard persisted property. | CommandSequencer | ||
unloadStoryboard():void [override]
Performs cleanup actions when a storyboard is unloaded. | CommandSequencer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the BasePlayer needs to resolve completion criteria beyond those defined for the class. | BasePlayer | ||
| Dispatched when a storyboard is marked as complete. | BasePlayer | ||
| Dispatched after a storyboard is initialized. | BasePlayer | ||
| Dispatched when storyboard loading is complete. | BasePlayer | ||
| Dispatched when a storyboard is loaded, but before any processing occurs. | BasePlayer | ||
| Dispatched when the status of the sequencer changes. | CommandSequencer | |||
| Dispatched before a storyboard is unloaded. | BasePlayer | ||
| commandObjects | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescommandObjects:ChildElementCollection [read-only] The command objects associated with the storyboard.
public function get commandObjects():ChildElementCollection| position | property |
position:intThe position of the sequencer. In the CommandSequencer, this value indicates the index of the current command.
Setting this property value may cause the status property to be changed. Specifically, if position
is set to a value < 0, the status property will be changed to SequencerStatusTypes.UNKNOWN.
If position is set to a value >= the number of children, the status property will be changed to
SequencerStatusTypes.EOF. For all other values, the status property will be changed to
SequencerStatusTypes.STOPPED. If the storyboard property value is null, the status
property will be changed to SequencerStatusTypes.NO_STORYBOARD.
If the storyboard property value is not null, setting this value will also set the storyboard's
LastPosition persisted property value.
public function get position():int public function set position(value:int):voidSee also
| status | property |
status:String [read-only]
The current status of the sequencer. This value will be one of the SequencerStatusTypes constant values.
public function get status():StringSee also
| storyboard | property |
storyboard:Storyboard[override] Specifies the storyboard for the player.
If null is passed, the current storyboard is
unloaded, the StoryboardEvent.UNLOAD event is dispatched, and
no further action occurs.
If a non- null storyboard object is passed, the following actions
occur, in order:
null, the StoryboardEvent.UNLOAD event is dispatched. If the event is not cancelled, the current storyboard is unloaded. If the event is cancelled, further processing stops.StoryboardEvent.LOAD_START event is dispatched. If the event is not cancelled, the new storyboard is associated with the player. If the event is cancelled, further processing stops and the value of this property is set to null. StoryboardEvent.LOAD_COMPLETE event is dispatched.checkForComplete() method is invoked. If all completion criteria have been met, the StoryboardEvent.COMPLETE event is dispatched.Note that the CommandSequencer may raise one or move SequencerStatusEvent.STATUS_CHANGED events during storyboard load.
public function get storyboard():Storyboard public function set storyboard(value:Storyboard):voidSee also
| useLastPosition | property |
useLastPosition:BooleanIndicates whether or not the last position should be used when loading a previously loaded storyboard.
The default value is false.
public function get useLastPosition():Boolean public function set useLastPosition(value:Boolean):void| CommandSequencer | () | Constructor |
public function CommandSequencer()Creates a new instance of the CommandSequencer.
| getStoryboardState | () | method |
public static function getStoryboardState(sb:Storyboard):StringCreates a string describing the state of the storyboard.
This method returns a multiple-character string to describe
the state of the storyboard. The size of the string will depend on
the number of child elements and the aggregate state. The value of the LastPosition
persisted property and the Complete values of each child element
are included in the state string. The returned string may contain upper- and lower-case letters,
numbers, the slash (/) character, and the dot (.) character.
Note that this string only describes the state that the player is aware of. If the shell stores additional data in the storyboard, it is the shell's responsibility to store the additional data if it is needed.
Parameters
sb:Storyboard — The storyboard to describe the state of.
|
String — The state of the storyboard.
|
See also
| loadStoryboard | () | method |
override protected function loadStoryboard():voidLoads the storyboard.
This method is invoked by the storyboard property set method. Unlike other player classes, this
method is invoked even if a null storyboard object is loaded. This method is invoked after
initialization (if needed) occurs.
When loading a storyboard, the TimeSequencer performs the following actions:
alwaysCheckComplete property value is true, each child element's Complete
persisted property value is set to false.storyboard property value is null, the status property value is set to
SequencerStatusTypes.NO_STORYBOARD, the SequencerStatusEvent.STATUS_CHANGED event is dispatched,
and further processing stops.useLastPosition property value is true, the position property value is
set using the storyboard's LastPosition persisted property value, otherwise, the position
property value is set to 0.position property value is 0, the status is set to SequencerStatusTypes.STOPPED,
otherwise, it is set to SequencerStatusTypes.PAUSED. In either case, a SequencerStatusTypes.STATUS_CHANGED
event is dispatched.See also
| removeCompleteRemainingCriteria | () | method |
override protected function removeCompleteRemainingCriteria():void
Removes known completion criteria from the CompleteRemaining storyboard persisted property.
This method is invoked by the checkForComplete() method if the value of the storyboard
property is not null, and the complete event has not been dispatched since the storyboard
was loaded.
In addition to the substrings processed by the BasePlayer, the AudioSequencer will remove the following substrings from the completeRemaining
persisted property:
| Substring | Meaning |
|---|---|
| commandObjectsComplete; | All child elements have a Complete persisted property value of true. |
See also
| resetStoryboard | () | method |
public static function resetStoryboard(sb:Storyboard):voidRemoves all properties set by the player.
Note that this method also removes interim completion properties used by the player, but not necessarily set by the player.
Parameters
sb:Storyboard — The storyboard to remove properties from.
This method removes the following properties from a storyboard:
This method removes the following properties from each ChildElement in the storyboard's
|
| setStoryboardState | () | method |
public static function setStoryboardState(sb:Storyboard, state:String):voidModifies the storyboard to match the described state passed.
If the value of state indicates a completed storyboard, interim completion criteria will
be marked as complete in addition to the overall storyboard state.
State values created using a function other than getStoryboardState may not work.
Parameters
sb:Storyboard — The Storyboard object to modify.
| |
state:String — A String created using the getStoryboardState() method containing the state to restore.
|
See also
| unloadStoryboard | () | method |
override protected function unloadStoryboard():voidPerforms cleanup actions when a storyboard is unloaded.
This method is invoked by the storyboard property set method when the current value of the property
is not null and the unload event has not been cancelled.
When unloading a storyboard, the TimeSequencer performs the following actions:
position property value is set to -1.status property value is set to SequencerStatusTypes.NO_STORYBOARD.See also
| sequencerStatusChanged | Event |
impression.events.SequencerStatusEventimpression.events.SequencerStatusEvent.STATUS_CHANGEDDispatched when the status of the sequencer changes.
The SequencerStatusEvent.STATUS_CHANGED constant defines the value of the type property of a status changed event object. This event has the following properties:| Property | Value |
|---|---|
| bubbles | false |
| cancelable | false; there is no default behavior to cancel. |
| currentTarget | The object that is actively processing the Event object with an event listener. |
| target | The object that raised the event. |
| sb | The Storyboard object assigned to the target. |
| status | The status of the sequencer. |
| text | Additional information about the status. |