Packagespark.events
Classpublic class ViewNavigatorEvent
InheritanceViewNavigatorEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The ViewNavigatorEvent class represents event objects dispatched by the View class.

See also

spark.components.View

Public Properties
 PropertyDefined By
  AIR-only action : String
The navigation action committed by the view navigator that resulted in the event.
ViewNavigatorEvent
Public Methods
 MethodDefined By
  
AIR-only ViewNavigatorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, action:String = null)
Constructor.
ViewNavigatorEvent
Public Constants
 ConstantDefined By
  AIR-only REMOVING : String = removing
[static] The ViewNavigatorEvent.REMOVING constant defines the value of the type property of the event object for an removing event.
ViewNavigatorEvent
  AIR-only VIEW_ACTIVATE : String = viewActivate
[static] The ViewNavigatorEvent.VIEW_ACTIVATE constant defines the value of the type property of the event object for an viewActivate event.
ViewNavigatorEvent
  AIR-only VIEW_DEACTIVATE : String = viewDeactivate
[static] The ViewNavigatorEvent.VIEW_DEACTIVATE constant defines the value of the type property of the event object for an viewDeactivate event.
ViewNavigatorEvent
Property Detail
AIR-only actionproperty
public var action:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The navigation action committed by the view navigator that resulted in the event. Possible actions include a view being activated or deactivated.

Constructor Detail
AIR-only ViewNavigatorEvent()Constructor
public function ViewNavigatorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, action:String = null)

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
action:String (default = null) — The navigation action committed by the view navigator that resulted in the event.
Constant Detail
AIR-only REMOVINGConstant
public static const REMOVING:String = removing

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The ViewNavigatorEvent.REMOVING constant defines the value of the type property of the event object for an removing event. This event is dispatched when a screen is about to be replaced by another screen through a navigator action. If preventDefault() is called on this event, the view removal will be canceled.

The properties of the event object have the following values:

PropertyValue
actionThe navigation action committed by the view navigator that resulted in the event.
bubblesfalse
cancelabletrue
returnValuenull
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeViewNavigatorEvent.SCREEN_REMOVING

AIR-only VIEW_ACTIVATEConstant 
public static const VIEW_ACTIVATE:String = viewActivate

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The ViewNavigatorEvent.VIEW_ACTIVATE constant defines the value of the type property of the event object for an viewActivate event. This event is dispatched when a component is activated.

The properties of the event object have the following values:

PropertyValue
actionThe navigation action committed by the view navigator that resulted in the event.
bubblesfalse
cancelablefalse
returnValuenull
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeViewNavigatorEvent.VIEW_ACTIVATE

AIR-only VIEW_DEACTIVATEConstant 
public static const VIEW_DEACTIVATE:String = viewDeactivate

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The ViewNavigatorEvent.VIEW_DEACTIVATE constant defines the value of the type property of the event object for an viewDeactivate event. This event is dispatched when a component is deactivated.

The properties of the event object have the following values:

PropertyValue
actionThe navigation action committed by the view navigator that resulted in the event.
bubblesfalse
cancelablefalse
returnValuenull
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeViewNavigatorEvent.VIEW_DEACTIVATE




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00