| Package | impression.persistence |
| Class | public class Storyboard |
| Inheritance | Storyboard  Object |
| Property | Defined By | ||
|---|---|---|---|
| children : ChildElementCollection [read-only]
The object's ChildElementCollection. | Storyboard | ||
| classification : String
The classification level of the object. | Storyboard | ||
| identifier : String
The human-readable identification code for the object. | Storyboard | ||
| properties : PersistedPropertiesCollection [read-only]
The object's persisted properties collection. | Storyboard | ||
| sbid : String [read-only]
The unique identifier of the object. | Storyboard | ||
| sbType : String
The storyboard type. | Storyboard | ||
| shortID : Number = -1
The object's unique position within its parent collection's original XML file. | Storyboard | ||
| title : String = New Storyboard
The title of the storyboard. | Storyboard | ||
| Method | Defined By | ||
|---|---|---|---|
Storyboard(sbid:String = null, title:String = null, identifier:String = null, sbType:String = null, shortID:Number = -1)
Creates a new instance of the Storyboard class. | Storyboard | ||
clone(sbid:String = null):Storyboard
Returns a copy of the object. | Storyboard | ||
fromXML(source:XML):Storyboard [static]
Returns a new instance of the Storyboard class based on the data contained in the XML object. | Storyboard | ||
toString():String
Returns the string representation of the specified object. | Storyboard | ||
toXML():XML
Returns an Impression-format XML object containing all the data from the object. | Storyboard | ||
| children | property |
children:ChildElementCollection [read-only] The object's ChildElementCollection.
The object itself is read-only; the data contained in the collection is read-write.
public function get children():ChildElementCollection| classification | property |
public var classification:StringThe classification level of the object.
The default value is the empty string ("").
| identifier | property |
public var identifier:StringThe human-readable identification code for the object.
Unlike sbid, identifier is typically used as human-readable code to uniquely identify a
storyboard object within a lesson when the title property is not sufficiently unique.
The default value is the empty string ("").
| properties | property |
properties:PersistedPropertiesCollection [read-only] The object's persisted properties collection.
The object itself is read-only; the data contained in the collection is read-write.
public function get properties():PersistedPropertiesCollection| sbid | property |
sbid:String [read-only] The unique identifier of the object.
sbid is an abbreviation of "StoryboardID". This value is typically
a GUID string but can be any value.
The Storyboard class does not enforce the uniqueness of the sbid property.
The default value is A String generated by the .newGUID method of the impression.utilities.GUID class
public function get sbid():StringSee also
| sbType | property |
public var sbType:StringThe storyboard type.
The default value is the empty string ("").
| shortID | property |
public var shortID:Number = -1The object's unique position within its parent collection's original XML file.
shortID values are useful when the user needs storyboard references storage but has limited
storage space. The value usually comes from the storyboard XML.
The Impression CCT regenerates shortID values each time a storyboard collection is
exported. This means that shortID values are guaranteed to be consistent across multiple playback
sessions of the same content only. The same lesson content re-exported from the CCT will most likely have different
shortID values for each storyboard.
To ensure that you are working with the same document between sessions, you should store and compare
the lesson object's documentID property.
The Storyboard class does not enforce the uniqueness of the shortID
property.
The default value is -1.
| title | property |
public var title:String = New StoryboardThe title of the storyboard.
| Storyboard | () | Constructor |
public function Storyboard(sbid:String = null, title:String = null, identifier:String = null, sbType:String = null, shortID:Number = -1)Creates a new instance of the Storyboard class.
The constructor does not ensure the uniqueness of either the sbid or shortID parameters.
If any parameter value is null, the default value will be used.
sbid:String (default = null) | |
title:String (default = null) | |
identifier:String (default = null) | |
sbType:String (default = null) | |
shortID:Number (default = -1) |
| clone | () | method |
public function clone(sbid:String = null):StoryboardReturns a copy of the object.
If the sbid parameter is null, the current sbid property value
is used. If the sbid parameter is not null, the parameter value is used.
The storyboard's children are copied by invoking the internal ChildElementCollection object's
clone method with the deep parameter set to true.
Parameters
sbid:String (default = null)sbid property of the copied object.
|
Storyboard — A copy of the object.
|
See also
| fromXML | () | method |
public static function fromXML(source:XML):StoryboardReturns a new instance of the Storyboard class based on the data contained in the XML object.
If source is null, an empty Storyboard object is returned.
If the source.name property is not "storyboard", an error is thrown.
The XML format of a Storyboard object is:
If a matching properties or children XML node is not found, the returned storyboard will have an empty properties or
children collection. Additional XML nodes are ignored.
Parameters
source:XML — The object containing the data to use.
|
Storyboard — A Storyboard object containing the data from the source XML object.
|
ArgumentError — node is not a <storyboard> element (ArgumentError).
|
See also
| toString | () | method |
public function toString():StringReturns the string representation of the specified object.
ReturnsString — The string representation of the specified object.
|
| toXML | () | method |
public function toXML():XMLReturns an Impression-format XML object containing all the data from the object.
ReturnsXML — An XML object containing all the data from the object.
|
See also