Packageimpression.events
Classpublic class LocationChangeRequestEvent
InheritanceLocationChangeRequestEvent Inheritance StoryboardEvent Inheritance flash.events.Event

An object dispatches a LocationChangeRequestEvent object when a location change request action occurs.



Public Properties
 PropertyDefined By
  destination : LocationData
[read-only] The location to change to.
LocationChangeRequestEvent
  requestType : String
[read-only] The type of change request.
LocationChangeRequestEvent
 Inheritedsb : Storyboard
[read-only] The Storyboard object assigned to the target.
StoryboardEvent
Public Methods
 MethodDefined By
  
LocationChangeRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, destination:LocationData = null, requestType:String = null)
Creates a new instance of a LocationChangeRequestEvent object.
LocationChangeRequestEvent
  
clone():Event
[override] Duplicates an instance of the event object.
LocationChangeRequestEvent
  
toString():String
[override] Returns a string containing all the properties of the LocationChangeRequestEvent object.
LocationChangeRequestEvent
Public Constants
 ConstantDefined By
 InheritedCOMPLETE : String = complete
[static] The StoryboardEvent.COMPLETE constant defines the value of the type property of a complete event object.
StoryboardEvent
 InheritedCONTENT_LOAD_BEGIN : String = contentLoadBegin
[static] The StoryboardEvent.CONTENT_LOAD_BEGIN constant defines the value of the type property of a content load begin event object.
StoryboardEvent
 InheritedCONTENT_LOAD_END : String = contentLoadEnd
[static] The StoryboardEvent.CONTENT_LOAD_END constant defines the value of the type property of a content load end event object.
StoryboardEvent
 InheritedINITIALIZE : String = initialize
[static] The StoryboardEvent.INITIALIZE constant defines the value of the type property of a initialize event object.
StoryboardEvent
 InheritedLOAD_COMPLETE : String = loadComplete
[static] The StoryboardEvent.LOAD_COMPLETE constant defines the value of the type property of a load event object.
StoryboardEvent
 InheritedLOAD_START : String = loadStart
[static] The StoryboardEvent.LOAD_START constant defines the value of the type property of an load start event object.
StoryboardEvent
  LOCATION_CHANGE_REQUEST : String = locationChangeRequest
[static] The LocationChangeRequestEvent.LOCATION_CHANGE_REQUEST constant defines the value of the type property of a location change request event object.
LocationChangeRequestEvent
 InheritedUNLOAD : String = unload
[static] The StoryboardEvent.UNLOAD constant defines the value of the type property of an unload event object.
StoryboardEvent
Property Detail
destinationproperty
destination:LocationData  [read-only]

The location to change to.


Implementation
    public function get destination():LocationData
requestTypeproperty 
requestType:String  [read-only]

The type of change request. When dispatched from an object defined in the Base Class Framework, this value will be a LocationChangeRequestTypes constant value.


Implementation
    public function get requestType():String

See also

Constructor Detail
LocationChangeRequestEvent()Constructor
public function LocationChangeRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, destination:LocationData = null, requestType:String = null)

Creates a new instance of a LocationChangeRequestEvent 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.
 
sb:Storyboard (default = null) — The Storyboard object assigned to the target. Event listeners can access this information through the inherited sb property.
 
destination:LocationData (default = null) — The location to change to. Event listeners can access this information through the destination property.
 
requestType:String (default = null) — The type of change request. Event listeners can access this information through the requestType property.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new LocationChangeRequestEvent object that is a copy of the original instance of the LocationChangeRequestEvent 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 LocationChangeRequestEvent object that is identical to the original.
toString()method 
override public function toString():String

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

[LocationChangeRequestEvent type=value bubbles=value cancelable=value eventPhase=value sb=value destination=value requestType=value]

Returns
String — A string containing all the properties of the LocationChangeRequestEvent object.
Constant Detail
LOCATION_CHANGE_REQUESTConstant
public static const LOCATION_CHANGE_REQUEST:String = locationChangeRequest

The LocationChangeRequestEvent.LOCATION_CHANGE_REQUEST constant defines the value of the type property of a location change 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.
sbThe Storyboard object assigned to the target.
destinationThe location to change to.
requestType