spark.core

# NavigationUnit - AS3 Flex

Package | spark.core
Class | public final class NavigationUnit
Inheritance | NavigationUnit Object

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The NavigationUnit class defines the possible values for the `getVerticalScrollPositionDelta()` and `getHorizontalScrollPositionDelta()` methods of the IViewport class.

All of these constants have the same values as their flash.ui.Keyboard counterparts, except PAGE_LEFT and PAGE_RIGHT, for which no keyboard key equivalents exist.

Related API Elements

flash.ui.Keyboard
IViewport.getVerticalScrollPositionDelta
IViewport.getHorizontalScrollPositionDelta

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isNavigationUnit(keyCode:uint):Boolean [static] Returns true if the keyCode maps directly to a NavigationUnit enum value. | NavigationUnit
|  | 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
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants

| Constant | Defined By
--- | --- | ---
|  | DOWN : uint = 40 [static] Navigate one line or "step" downwards. | NavigationUnit
|  | END : uint = 35 [static] Navigate to the end of the document. | NavigationUnit
|  | HOME : uint = 36 [static] Navigate to the origin of the document. | NavigationUnit
|  | LEFT : uint = 37 [static] Navigate one line or "step" to the left. | NavigationUnit
|  | PAGE_DOWN : uint = 34 [static] Navigate one page downwards. | NavigationUnit
|  | PAGE_LEFT : uint = 0x2397 [static] Navigate one page to the left. | NavigationUnit
|  | PAGE_RIGHT : uint = 0x2398 [static] Navigate one page to the right. | NavigationUnit
|  | PAGE_UP : uint = 33 [static] Navigate one page upwards. | NavigationUnit
|  | RIGHT : uint = 39 [static] Navigate one line or "step" to the right. | NavigationUnit
|  | UP : uint = 38 [static] Navigate one line or "step" upwards. | NavigationUnit

Method Detail

### isNavigationUnit

()
method

`public static function isNavigationUnit(keyCode:uint):Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns `true` if the `keyCode` maps directly to a NavigationUnit enum value.

Parameters

| `keyCode:uint` — A key code value.

Returns

| `Boolean` — `true` if the `keyCode` maps directly to a NavigationUnit enum value.

Constant Detail

### DOWN

Constant

`public static const DOWN:uint = 40`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one line or "step" downwards.

### END

Constant

`public static const END:uint = 35`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate to the end of the document.

### HOME

Constant

`public static const HOME:uint = 36`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate to the origin of the document.

### LEFT

Constant

`public static const LEFT:uint = 37`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one line or "step" to the left.

### PAGE_DOWN

Constant

`public static const PAGE_DOWN:uint = 34`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one page downwards.

### PAGE_LEFT

Constant

`public static const PAGE_LEFT:uint = 0x2397`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one page to the left. The value of this constant, 0x2397, is the same as the Unicode "previous page" character.

### PAGE_RIGHT

Constant

`public static const PAGE_RIGHT:uint = 0x2398`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one page to the right. The value of this constant, 0x2398, is the same as the Unicode "next page" character.

### PAGE_UP

Constant

`public static const PAGE_UP:uint = 33`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one page upwards.

### RIGHT

Constant

`public static const RIGHT:uint = 39`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one line or "step" to the right.

### UP

Constant

`public static const UP:uint = 38`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Navigate one line or "step" upwards.

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