| Package | impression.utilities |
| Class | public class LessonMapController |
| Inheritance | LessonMapController  flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| absoluteCount : Number [read-only]
The number of items in map. | LessonMapController | ||
| absolutePosition : Number [read-only]
The absolute position of currentStoryboard. | LessonMapController | ||
| currentStoryboard : Storyboard
The current storyboard. | LessonMapController | ||
| firstChild : Storyboard [read-only]
Returns the first child of currentStoryboard. | LessonMapController | ||
| firstSibling : Storyboard [read-only]
Returns the first sibling of currentStoryboard. | LessonMapController | ||
| firstStoryboard : Storyboard [read-only]
Returns the first storyboard in the map. | LessonMapController | ||
| lastChild : Storyboard [read-only]
Returns the last child of currentStoryboard. | LessonMapController | ||
| lastDescendant : Storyboard [read-only]
Returns the last descendant of currentStoryboard. | LessonMapController | ||
| lastSibling : Storyboard [read-only]
Returns the last sibling of currentStoryboard. | LessonMapController | ||
| lastStoryboard : Storyboard [read-only]
Returns the last storyboard in the map. | LessonMapController | ||
| map : LessonMap
The LessonMap object associated with the object. | LessonMapController | ||
| nextLinear : Storyboard [read-only]
Returns the next linear storyboard of currentStoryboard. | LessonMapController | ||
| nextSibling : Storyboard [read-only]
Returns the next sibling of currentStoryboard. | LessonMapController | ||
| parent : Storyboard [read-only]
Returns the parent of currentStoryboard. | LessonMapController | ||
| previousLinear : Storyboard [read-only]
Returns the previous linear storyboard of currentStoryboard. | LessonMapController | ||
| previousSibling : Storyboard [read-only]
Returns the previous sibling of currentStoryboard. | LessonMapController | ||
| relativeCount : Number [read-only]
The number of siblings of currentStoryboard. | LessonMapController | ||
| relativePath : String [read-only]
The dot-separated list of relative positions of currentStoryboard and its ancestors. | LessonMapController | ||
| relativePosition : Number [read-only]
The relative position of currentStoryboard. | LessonMapController | ||
| storyboards : StoryboardCollection
The StoryboardCollection object associated with the object. | LessonMapController | ||
| topAncestor : Storyboard [read-only]
Returns the top ancestor of currentStoryboard. | LessonMapController | ||
| Method | Defined By | ||
|---|---|---|---|
LessonMapController(map:LessonMap = null, storyboards:StoryboardCollection = null, current:* = null)
Creates a new instance of the LessonMapController class. | LessonMapController | ||
Returns a copy of the object. | LessonMapController | ||
Returns the first child of an item. | LessonMapController | ||
Returns the first sibling of an item. | LessonMapController | ||
Returns a copy of map without hierarchical data. | LessonMapController | ||
getLocationStatus(location:LocationData):String
Returns the aggregate status of a location. | LessonMapController | ||
getMapFromCollection(appendMissing:Boolean = false):LessonMap
Returns a LessonMap object based on the collection. | LessonMapController | ||
Returns a LessonMap object based on the location. | LessonMapController | ||
Returns a LessonMap object containing the ancestors of currentStoryboard. | LessonMapController | ||
getMapOfChildren(deep:Boolean = true):LessonMap
Returns a LessonMap object containing the descendants of currentStoryboard. | LessonMapController | ||
Returns a LessonMap object containing the descendants of currentStoryboard. | LessonMapController | ||
getRelative(relativeLocation:String):Storyboard
Returns the relative of currentStoryboard. | LessonMapController | ||
labelMap(label:String = %TITLE_OR_SBID%, attribute:String = label):void
Adds a label to each item in the map. | LessonMapController | ||
Returns the last child of an item. | LessonMapController | ||
Returns the last descendant of an item. | LessonMapController | ||
Returns the last sibling of an item. | LessonMapController | ||
Returns the next linear storyboard of an item. | LessonMapController | ||
Returns the next sibling of an item. | LessonMapController | ||
Returns the parent of an item. | LessonMapController | ||
Returns the previous linear storyboard of an item. | LessonMapController | ||
Returns the previous sibling of an item. | LessonMapController | ||
Returns the relative of an item. | LessonMapController | ||
Returns a resolved version of a LocationData object. | LessonMapController | ||
setCurrent(item:*):void
Sets the currentStoryboard to the storyboard specified by item. | LessonMapController | ||
Returns the top ancestor of an item. | LessonMapController | ||
toSBIDArray():Array
Returns an array of sbid references in map. | LessonMapController | ||
toStoryboardArray():Array
Returns an array of Storyboard objects referenced in map and present in storyboards. | LessonMapController | ||
Returns a StoryboardCollection object containing the storyboards referenced in map and present in storyboards. | LessonMapController | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the value of currentStoryboard has changed. | LessonMapController | |||
| Constant | Defined By | ||
|---|---|---|---|
| ABSCOUNT : String = %ABSCOUNT% [static]
The number of storyboards in the map. | LessonMapController | ||
| ABSPOS : String = %ABSPOS% [static]
The absolute position of the storyboard in the map. | LessonMapController | ||
| IDENTIFIER : String = %IDENTIFIER% [static]
The identifier of the storyboard. | LessonMapController | ||
| RELCOUNT : String = %RELCOUNT% [static]
The number of siblings of the storyboard in the map. | LessonMapController | ||
| RELPATH : String = %RELPATH% [static]
The dot-seperated list of relative positions for the storyboard in the map. | LessonMapController | ||
| RELPOS : String = %RELPOS% [static]
The relative position of the storyboard in the map. | LessonMapController | ||
| SBID : String = %SBID% [static]
The sbid of the storyboard. | LessonMapController | ||
| TITLE : String = %TITLE% [static]
The title of the storyboard. | LessonMapController | ||
| TITLE_OR_SBID : String = %TITLE_OR_SBID% [static]
The title of the storyboard, or its sbid if the title is blank. | LessonMapController | ||
| absoluteCount | property |
absoluteCount:Number [read-only]
The number of items in map.
If map is null, -1 is returned.
public function get absoluteCount():NumberSee also
| absolutePosition | property |
absolutePosition:Number [read-only]
The absolute position of currentStoryboard.
If map is null, -1 is returned.
public function get absolutePosition():NumberSee also
| currentStoryboard | property |
currentStoryboard:StoryboardThe current storyboard.
Setting this value will cause the LessonMapControllerEvent.CHANGE event to be dispatched.
public function get currentStoryboard():Storyboard public function set currentStoryboard(value:Storyboard):voidSee also
| firstChild | property |
firstChild:Storyboard [read-only]
Returns the first child of currentStoryboard.
public function get firstChild():StoryboardSee also
| firstSibling | property |
firstSibling:Storyboard [read-only]
Returns the first sibling of currentStoryboard.
public function get firstSibling():StoryboardSee also
| firstStoryboard | property |
firstStoryboard:Storyboard [read-only] Returns the first storyboard in the map.
public function get firstStoryboard():StoryboardSee also
| lastChild | property |
lastChild:Storyboard [read-only]
Returns the last child of currentStoryboard.
public function get lastChild():StoryboardSee also
| lastDescendant | property |
lastDescendant:Storyboard [read-only]
Returns the last descendant of currentStoryboard.
public function get lastDescendant():StoryboardSee also
| lastSibling | property |
lastSibling:Storyboard [read-only]
Returns the last sibling of currentStoryboard.
public function get lastSibling():StoryboardSee also
| lastStoryboard | property |
lastStoryboard:Storyboard [read-only] Returns the last storyboard in the map.
public function get lastStoryboard():StoryboardSee also
| map | property |
map:LessonMapThe LessonMap object associated with the object.
public function get map():LessonMap public function set map(value:LessonMap):void| nextLinear | property |
nextLinear:Storyboard [read-only]
Returns the next linear storyboard of currentStoryboard.
public function get nextLinear():StoryboardSee also
| nextSibling | property |
nextSibling:Storyboard [read-only]
Returns the next sibling of currentStoryboard.
public function get nextSibling():StoryboardSee also
| parent | property |
parent:Storyboard [read-only]
Returns the parent of currentStoryboard.
public function get parent():StoryboardSee also
| previousLinear | property |
previousLinear:Storyboard [read-only]
Returns the previous linear storyboard of currentStoryboard.
public function get previousLinear():StoryboardSee also
| previousSibling | property |
previousSibling:Storyboard [read-only]
Returns the previous sibling of currentStoryboard.
public function get previousSibling():StoryboardSee also
| relativeCount | property |
relativeCount:Number [read-only]
The number of siblings of currentStoryboard.
If map is null, -1 is returned.
public function get relativeCount():NumberSee also
| relativePath | property |
relativePath:String [read-only]
The dot-separated list of relative positions of currentStoryboard and its ancestors.
If map is null, the empty string ("") is returned.
public function get relativePath():StringSee also
| relativePosition | property |
relativePosition:Number [read-only]
The relative position of currentStoryboard.
If map is null, -1 is returned.
public function get relativePosition():NumberSee also
| storyboards | property |
storyboards:StoryboardCollectionThe StoryboardCollection object associated with the object.
public function get storyboards():StoryboardCollection public function set storyboards(value:StoryboardCollection):void| topAncestor | property |
topAncestor:Storyboard [read-only]
Returns the top ancestor of currentStoryboard.
public function get topAncestor():StoryboardSee also
| LessonMapController | () | Constructor |
public function LessonMapController(map:LessonMap = null, storyboards:StoryboardCollection = null, current:* = null)Creates a new instance of the LessonMapController class.
Parametersmap:LessonMap (default = null) | |
storyboards:StoryboardCollection (default = null) | |
current:* (default = null) |
See also
| clone | () | method |
public function clone():LessonMapControllerReturns a copy of the object.
ReturnsLessonMapController — A copy of the object.
|
| firstChildOf | () | method |
public function firstChildOf(sb:Storyboard):StoryboardReturns the first child of an item.
Parameters
sb:Storyboard — The storyboard to return the first child of.
|
Storyboard — The first child of sb, or null if one cannot be found.
|
See also
| firstSiblingOf | () | method |
public function firstSiblingOf(sb:Storyboard):StoryboardReturns the first sibling of an item.
Parameters
sb:Storyboard — The storyboard to return the first sibling of.
|
Storyboard — The first sibling of sb, or null if one cannot be found.
|
See also
| getLinearMap | () | method |
public function getLinearMap():LessonMap
Returns a copy of map without hierarchical data. If map is null,
an empty map is returned.
LessonMap — A copy of the map without hierarchical data.
|
See also
| getLocationStatus | () | method |
public function getLocationStatus(location:LocationData):StringReturns the aggregate status of a location.
This method returns the result of invoking the getLocationStatus() method on the object's associated
LessonMap object using the location parameter and the currentStoryboard property value.
If the map property value is null, LocationStatusTypes.UNKNOWN is returned.
Parameters
location:LocationData — The location to return the aggregate status of.
|
String — A LocationStatusTypes value identifying the aggregate status of the storyboards.
|
See also
| getMapFromCollection | () | method |
public function getMapFromCollection(appendMissing:Boolean = false):LessonMapReturns a LessonMap object based on the collection.
This method returns the result of invoking the getMapFromCollection() method on the object's associated
LessonMap object using the storyboards property value and the appendMissing parameter.
If the map property value is null, an empty map is returned.
If the appendMissing parameter value is true, any storyboards in the collection but not referenced
in the current map are appended to the end of the map in no defined order. If the parameter value is false, any
unreferenced storyboards in the collection are ignored.
Parameters
appendMissing:Boolean (default = false) |
LessonMap — A LessonMap object containing the subset of this map that includes storyboards contained in the collection.
|
See also
| getMapFromLocation | () | method |
public function getMapFromLocation(location:LocationData):LessonMapReturns a LessonMap object based on the location.
This method returns the result of invoking the getMapFromLocation() method on the object's associated
LessonMap object using the location parameter and the currentStoryboard property value.
If the map property value is null, an empty map is returned.
Parameters
location:LocationData — The location to build a map of.
|
LessonMap — A LessonMap object containing the subset of this map that falls within the location.
|
See also
| getMapOfAncestors | () | method |
public function getMapOfAncestors():LessonMap
Returns a LessonMap object containing the ancestors of currentStoryboard.
This method returns the result of invoking the getMapOfAncestors() method on the object's associated
LessonMap object using the currentStoryboard property value. If the map property value
is null, an empty map is returned.
LessonMap — A LessonMap object containing the ancestors of currentStoryboard.
|
See also
| getMapOfChildren | () | method |
public function getMapOfChildren(deep:Boolean = true):LessonMap
Returns a LessonMap object containing the descendants of currentStoryboard.
If deep is false, only direct children of the current storyboard will be added to the
returned LessonMap object. If deep is true, all descendants will be added to the returned
object. In this case, invoking this method is the same as invoking getMapOfDescendants().
This method returns the result of invoking the getMapOfChildren() method on the object's associated
LessonMap object using the currentStoryboard property value and the deep parameter. If
the map property value is null, an empty map is returned.
Parameters
deep:Boolean (default = true) |
LessonMap — A LessonMap object containing the children of currentStoryboard.
|
See also
| getMapOfDescendants | () | method |
public function getMapOfDescendants():LessonMap
Returns a LessonMap object containing the descendants of currentStoryboard.
This method returns the result of invoking the getMapOfDescendants() method on the object's associated
LessonMap object using the currentStoryboard property value. If the map property value
is null, an empty map is returned.
LessonMap — A LessonMap object containing the descendants of currentStoryboard.
|
See also
| getRelative | () | method |
public function getRelative(relativeLocation:String):Storyboard
Returns the relative of currentStoryboard.
Parameters
relativeLocation:String — The relative location to retrieve the value of. This should be one of the RelativeLocations constant values.
|
Storyboard — The Storyboard object that is the relative of currentStoryboard, or null if no relative can be found.
|
See also
| labelMap | () | method |
public function labelMap(label:String = %TITLE_OR_SBID%, attribute:String = label):voidAdds a label to each item in the map.
The label is added as an attribute to each XML node. In addition, an attribute is added to the map root; this attribute contains the name of the map.
Note that the LessonMapViewer object invokes this method before loading a map into the TreeView.
Parameters
label:String (default = %TITLE_OR_SBID%)label contains any of the constant values
defined in this class, the constant value is replaced by the data from the actual item, if available.
| |
attribute:String (default = label) |
ArgumentError — Cannot use 'sbid' as map label (ArgumentError).
|
| lastChildOf | () | method |
public function lastChildOf(sb:Storyboard):StoryboardReturns the last child of an item.
Parameters
sb:Storyboard — The storyboard to return the last child of.
|
Storyboard — The last child of sb, or null if one cannot be found.
|
See also
| lastDescendantOf | () | method |
public function lastDescendantOf(sb:Storyboard):StoryboardReturns the last descendant of an item.
Parameters
sb:Storyboard — The storyboard to return the last descendant of.
|
Storyboard — The last descendant of sb, or null if one cannot be found.
|
See also
| lastSiblingOf | () | method |
public function lastSiblingOf(sb:Storyboard):StoryboardReturns the last sibling of an item.
Parameters
sb:Storyboard — The storyboard to return the last sibling of.
|
Storyboard — The last sibling of sb, or null if one cannot be found.
|
See also
| nextLinearOf | () | method |
public function nextLinearOf(sb:Storyboard):StoryboardReturns the next linear storyboard of an item.
Parameters
sb:Storyboard — The storyboard to return the next linear item of.
|
Storyboard — The next linear item of sb, or null if one cannot be found.
|
See also
| nextSiblingOf | () | method |
public function nextSiblingOf(sb:Storyboard):StoryboardReturns the next sibling of an item.
Parameters
sb:Storyboard — The storyboard to return the next sibling of.
|
Storyboard — The next sibling of sb, or null if one cannot be found.
|
See also
| parentOf | () | method |
public function parentOf(sb:Storyboard):StoryboardReturns the parent of an item.
Parameters
sb:Storyboard — The storyboard to return the parent of.
|
Storyboard — The parent of sb, or null if one cannot be found.
|
See also
| previousLinearOf | () | method |
public function previousLinearOf(sb:Storyboard):StoryboardReturns the previous linear storyboard of an item.
Parameters
sb:Storyboard — The storyboard to return the previous linear item of.
|
Storyboard — The previous linear item of sb, or null if one cannot be found.
|
See also
| previousSiblingOf | () | method |
public function previousSiblingOf(sb:Storyboard):StoryboardReturns the previous sibling of an item.
Parameters
sb:Storyboard — The storyboard to return the previous sibling of.
|
Storyboard — The previous sibling of sb, or null if one cannot be found.
|
See also
| relativeOf | () | method |
public function relativeOf(sb:Storyboard, relativeLocation:String):StoryboardReturns the relative of an item.
Parameters
sb:Storyboard — The Storyboard object to retrieve the relative of.
| |
relativeLocation:String — The relative location to retrieve the value of. This should be one of the RelativeLocations constant values.
|
Storyboard — The Storyboard object that is the relative of item, or null if no relative can be found.
|
See also
| resolveLocation | () | method |
public function resolveLocation(location:LocationData):LocationDataReturns a resolved version of a LocationData object.
This method returns the result of invoking the resolveLocation() method on the object's associated
LessonMap object using the location parameter and the currentStoryboard property value.
If the map property value is null, location is returned without modification.
Parameters
location:LocationData — The object to resolve.
|
LocationData — The resolved version of the location parameter.
|
See also
| setCurrent | () | method |
public function setCurrent(item:*):void
Sets the currentStoryboard to the storyboard specified by item.
Note that, unlike setting the currentStoryboard property, invoking setCurrent() will
not cause the LessonMapControllerEvent.CHANGE event to be dispatched.
Parameters
item:* — An expression identifying the new value of currentStoryboard. item can be one of the following types:
|
ArgumentError — Invalid item passed to setCurrent() (ArgumentError).
|
See also
| topAncestorOf | () | method |
public function topAncestorOf(sb:Storyboard):StoryboardReturns the top ancestor of an item.
Parameters
sb:Storyboard — The storyboard to return the top ancestor of.
|
Storyboard — The top ancestor of sb, or null if one cannot be found.
|
See also
| toSBIDArray | () | method |
public function toSBIDArray():Array
Returns an array of sbid references in map. If map is null,
an empty array is returned.
The return value preserves the linear order of references in the map.
ReturnsArray — An array of sbid references in the map.
|
See also
| toStoryboardArray | () | method |
public function toStoryboardArray():Array
Returns an array of Storyboard objects referenced in map and present in storyboards.
If either map or storyboards is null, an empty array is returned.
Array — An array of storyboards.
|
See also
| toStoryboardCollection | () | method |
public function toStoryboardCollection():StoryboardCollection
Returns a StoryboardCollection object containing the storyboards referenced in map and present in storyboards.
If either map or storyboards is null, an empty collection is returned.
StoryboardCollection — A StoryboardCollection object containing the storyboards in the map.
|
See also
| controllerStoryboardChange | Event |
impression.events.LessonMapControllerEventimpression.events.LessonMapControllerEvent.CHANGE
Dispatched when the value of currentStoryboard has changed.
Note that this event is not dispatched if the setCurrent
method is used to change the current storyboard.
| 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. |
| ABSCOUNT | Constant |
public static const ABSCOUNT:String = %ABSCOUNT%The number of storyboards in the map.
| ABSPOS | Constant |
public static const ABSPOS:String = %ABSPOS%The absolute position of the storyboard in the map.
| IDENTIFIER | Constant |
public static const IDENTIFIER:String = %IDENTIFIER%
The identifier of the storyboard.
| RELCOUNT | Constant |
public static const RELCOUNT:String = %RELCOUNT%The number of siblings of the storyboard in the map.
| RELPATH | Constant |
public static const RELPATH:String = %RELPATH%The dot-seperated list of relative positions for the storyboard in the map.
| RELPOS | Constant |
public static const RELPOS:String = %RELPOS%The relative position of the storyboard in the map.
| SBID | Constant |
public static const SBID:String = %SBID%
The sbid of the storyboard.
| TITLE | Constant |
public static const TITLE:String = %TITLE%
The title of the storyboard.
| TITLE_OR_SBID | Constant |
public static const TITLE_OR_SBID:String = %TITLE_OR_SBID%
The title of the storyboard, or its sbid if the title is blank.