spark.events

# ViewNavigatorEvent - AS3 Flex

Package | spark.events
Class | public class ViewNavigatorEvent
Inheritance | ViewNavigatorEvent Event Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

spark.components.View

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | action : String The navigation action committed by the view navigator that resulted in the event. | ViewNavigatorEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ViewNavigatorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, action:String = null) Constructor. | ViewNavigatorEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | REMOVING : String = "removing" [static] The ViewNavigatorEvent.REMOVING constant defines the value of the type property of the event object for an removing event. | ViewNavigatorEvent
|  | 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
|  | 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

### action

property

`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

### 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

### REMOVING

Constant

`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:

Property | Value
--- | ---
`action` | The navigation action committed by the view navigator that resulted in the event.
`bubbles` | false
`cancelable` | true
`returnValue` | null
`currentTarget` | The 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`.
`target` | The 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.
`Type` | ViewNavigatorEvent.SCREEN_REMOVING

### VIEW_ACTIVATE

Constant

`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:

Property | Value
--- | ---
`action` | The navigation action committed by the view navigator that resulted in the event.
`bubbles` | false
`cancelable` | false
`returnValue` | null
`currentTarget` | The 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`.
`target` | The 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.
`Type` | ViewNavigatorEvent.VIEW_ACTIVATE

### VIEW_DEACTIVATE

Constant

`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:

Property | Value
--- | ---
`action` | The navigation action committed by the view navigator that resulted in the event.
`bubbles` | false
`cancelable` | false
`returnValue` | null
`currentTarget` | The 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`.
`target` | The 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.
`Type` | ViewNavigatorEvent.VIEW_DEACTIVATE

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00