Packageimpression.events
Classpublic class LessonMapViewerRequestEvent
InheritanceLessonMapViewerRequestEvent Inheritance TreeViewRequestEvent Inheritance flash.events.Event

The LessonMapViewer object dispatches a LessonMapViewerRequestEvent object before a selection change occurs.



Public Properties
 PropertyDefined By
  newNode : TreeNode
[override] The new node to select.
LessonMapViewerRequestEvent
  newSB : Storyboard
The Storyboard object associated with the new node to select.
LessonMapViewerRequestEvent
  newSBID : String
[read-only] The sbid of the new storyboard.
LessonMapViewerRequestEvent
 InheritedoldNode : TreeNode
[read-only] The currently selected node.
TreeViewRequestEvent
  oldSB : Storyboard
[read-only] The Storyboard object associated with the currently selected node.
LessonMapViewerRequestEvent
  oldSBID : String
[read-only] The sbid of the Storyboard object associated with the currently selected node.
LessonMapViewerRequestEvent
  reason : String
[override] [read-only] Indicates why the event occurred.
LessonMapViewerRequestEvent
Public Methods
 MethodDefined By
  
LessonMapViewerRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null, oldNode:TreeNode = null, newNode:TreeNode = null, oldSB:Storyboard = null, newSB:Storyboard = null)
Creates a new instance of a LocationStatusRequestEvent object.
LessonMapViewerRequestEvent
  
clone():Event
[override] Duplicates an instance of the event object.
LessonMapViewerRequestEvent
  
toString():String
[override] Returns a string containing all the properties of the LessonMapViewerRequestEvent object.
LessonMapViewerRequestEvent
Public Constants
 ConstantDefined By
  SELECT_REQUEST : String = lessonMapViewerSelectRequest
[static] The LessonMapViewerRequestEvent.SELECT_REQUEST constant defines the value of the type property of a select request event object.
LessonMapViewerRequestEvent
Property Detail
newNodeproperty
newNode:TreeNode[override]

The new node to select. In the LessonMapViewerRequestEvent, this property is read-only. Use the newSB property instead to specify the item that should be selected when the event returns to the caller.


Implementation
    public function get newNode():TreeNode
    public function set newNode(value:TreeNode):void

Throws
IllegalOperationError — property is read-only in this class (IllegalOperationError).
newSBproperty 
newSB:Storyboard

The Storyboard object associated with the new node to select.

The LessonMapViewer object ignores the newNode property value and uses the newSB property value to determine the node to select when execution returns to the LessonMapViewer.


Implementation
    public function get newSB():Storyboard
    public function set newSB(value:Storyboard):void
newSBIDproperty 
newSBID:String  [read-only]

The sbid of the new storyboard.


Implementation
    public function get newSBID():String
oldSBproperty 
oldSB:Storyboard  [read-only]

The Storyboard object associated with the currently selected node.


Implementation
    public function get oldSB():Storyboard
oldSBIDproperty 
oldSBID:String  [read-only]

The sbid of the Storyboard object associated with the currently selected node.


Implementation
    public function get oldSBID():String
reasonproperty 
reason:String  [read-only] [override]

Indicates why the event occurred. When dispatched by the LessonMapViewer, this value will be a LessonMapViewerEventReasons constant value.


Implementation
    public function get reason():String

See also

Constructor Detail
LessonMapViewerRequestEvent()Constructor
public function LessonMapViewerRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null, oldNode:TreeNode = null, newNode:TreeNode = null, oldSB:Storyboard = null, newSB:Storyboard = null)

Creates a new instance of a LocationStatusRequestEvent object.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inheritied bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
reason:String (default = null) — Indicates why the event occurred. Event listeners can access this information through the inherited reason property.
 
oldNode:TreeNode (default = null) — The currently selected node. Event listeners can access this information through the inherited oldNode property.
 
newNode:TreeNode (default = null) — The new node to select. Event listeners can access this information through the inherited newNode property.
 
oldSB:Storyboard (default = null) — The Storyboard object associated with the currently selected node. Event listeners can access this information through the oldSB property.
 
newSB:Storyboard (default = null) — The Storyboard object associated with the new node to select. Event listeners can access this information through the newSB property.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new LessonMapViewerRequestEvent object that is a copy of the original instance of the LessonMapViewerRequestEvent object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event--that is, when you call dispatchEvent(event) from a handler that is handling event.

Returns
Event — A new LessonMapViewerRequestEvent object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the LessonMapViewerRequestEvent object. The string is in the following format:

[LessonMapViewerRequestEvent type=value bubbles=value cancelable=value eventPhase=value reason=value oldNode=value newNode=value oldSB=value newSB=value]

Returns
String — A string containing all the properties of the LessonMapViewerRequestEvent object.
Constant Detail
SELECT_REQUESTConstant
public static const SELECT_REQUEST:String = lessonMapViewerSelectRequest

The LessonMapViewerRequestEvent.SELECT_REQUEST constant defines the value of the type property of a select request event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
reason
oldNode
newNode
oldSBThe Storyboard object associated with the currently selected node.
newSBThe Storyboard object associated with the new node to select.