ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

LocationChangeEvent  - AS3

Packageflash.events
Classpublic class LocationChangeEvent
InheritanceLocationChangeEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

An HTMLLoader or StageWebView object dispatches a LocationChangeEvent object when a new page loads.

There are two types of LocationChangeEvent:

  • LocationChangeEvent.LOCATION_CHANGING: dispatched before a change initiated via the content displayed in a StageWebView object. Can be canceled.
  • LocationChangeEvent.LOCATION_CHANGE: dispatched after every location change. Cannot be canceled.

More examples

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
      location : String
The destination URL of the change.
LocationChangeEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    LocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null)
Creates a LocationChangeEvent object.
LocationChangeEvent
  
    clone():Event
[override]
LocationChangeEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
    toString():String
[override] Returns a string that contains all the properties of the LocationChangeEvent object.
LocationChangeEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      LOCATION_CHANGE : String = "locationChange"
[static] Dispatched after every location change.
LocationChangeEvent
      LOCATION_CHANGING : String = "locationChanging"
[static] The LOCATION_CHANGING constant defines the value of the type property LocationChangeEvent object dispatched before a change in page location.
LocationChangeEvent
Property Detail
    

location

property
location:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

The destination URL of the change.



Implementation
    public function get location():String
    public function set location(value:String):void
Constructor Detail
    

LocationChangeEvent

()Constructor
public function LocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null)

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

Creates a LocationChangeEvent object.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
location:String (default = null)
Method Detail

    clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

Returns
Event

    toString

()method 
override public function toString():String

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

Returns a string that contains all the properties of the LocationChangeEvent object. The string is in the following format:

[LocationChangeEvent type=value bubbles=value cancelable=value eventPhase=value location=value

Returns
String
Constant Detail
    

LOCATION_CHANGE

Constant
public static const LOCATION_CHANGE:String = "locationChange"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

Dispatched after every location change.

    

LOCATION_CHANGING

Constant 
public static const LOCATION_CHANGING:String = "locationChanging"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

The LOCATION_CHANGING constant defines the value of the type property LocationChangeEvent object dispatched before a change in page location.