qnx.events.ExtendedLocationChangeEvent

ExtendedLocationChangeEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class ExtendedLocationChangeEvent
InheritanceExtendedLocationChangeEvent Inheritance flash.events.LocationChangeEvent

A QNXStageWebView object dispatches an ExtendedLocationChangeEvent object when a new page loads. This object is similar to the LocationChangeEvent except that a reason for the location change is included in the event.

There are two types of ExtendedLocationChangeEvent:

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


Class information:
PlayBook Tablet OS Version:   1.0.6

See also

QNXStageWebView



Public Properties

 PropertyDefined By
  reason : String
Determines the reason for the change.
ExtendedLocationChangeEvent

Public Methods

 MethodDefined By
  
ExtendedLocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null, reason:String = null)
Creates an ExtendedLocationChangeEvent object.
ExtendedLocationChangeEvent
  
clone():Event
[override] Duplicates an instance of an Event subclass.
ExtendedLocationChangeEvent
  
toString():String
[override] Returns a String that contains all the properties of the ExtendedLocationChangeEvent object.
ExtendedLocationChangeEvent

Public Constants

 ConstantDefined By
  REASON_BACK_FORWARD : String = ReasonBackForward
[static] Indicates that the back or forward button was clicked.
ExtendedLocationChangeEvent
  REASON_FORM_RESUBMITTED : String = ReasonFormResubmitted
[static] Indicates that the form was resubmitted.
ExtendedLocationChangeEvent
  REASON_FORM_SUBMITTED : String = ReasonFormSubmitted
[static] Indicates that a form was submitted.
ExtendedLocationChangeEvent
  REASON_LINK_CLICKED : String = ReasonLinkClicked
[static] Indicates that a link was clicked.
ExtendedLocationChangeEvent
  REASON_OTHER : String = ReasonOther
[static] The location change occurred for some unknown reason.
ExtendedLocationChangeEvent
  REASON_RELOAD : String = ReasonReload
[static] Indicates that the page was reloaded.
ExtendedLocationChangeEvent

Property Detail

reason


reason:String

Determines the reason for the change.


Implementation

public function get reason():String
public function set reason(value:String):void

Constructor Detail

ExtendedLocationChangeEvent()


public function ExtendedLocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null, reason:String = null)

Creates an ExtendedLocationChangeEvent object.

Parameters

type:String
bubbles:Boolean (default = false)
cancelable:Boolean (default = false)
location:String (default = null)
reason:String (default = null)

Method Detail

clone()


override public function clone():Event

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event 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.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

Returns

Event

toString()


override public function toString():String

Returns a String that contains all the properties of the ExtendedLocationChangeEvent object.

The String is in the following format:

[ExtendedLocationChangeEvent type=value bubbles=value cancelable=value eventPhase=value location=value reason=value

Returns

String

Constant Detail

REASON_BACK_FORWARD


public static const REASON_BACK_FORWARD:String = ReasonBackForward

Indicates that the back or forward button was clicked.

REASON_FORM_RESUBMITTED


public static const REASON_FORM_RESUBMITTED:String = ReasonFormResubmitted

Indicates that the form was resubmitted.

REASON_FORM_SUBMITTED


public static const REASON_FORM_SUBMITTED:String = ReasonFormSubmitted

Indicates that a form was submitted.

REASON_LINK_CLICKED


public static const REASON_LINK_CLICKED:String = ReasonLinkClicked

Indicates that a link was clicked.

REASON_OTHER


public static const REASON_OTHER:String = ReasonOther

The location change occurred for some unknown reason.

REASON_RELOAD


public static const REASON_RELOAD:String = ReasonReload

Indicates that the page was reloaded.