flashx.textLayout.utils

# NavigationUtil - AS3

Package | flashx.textLayout.utils
Class | public final class NavigationUtil
Inheritance | NavigationUtil Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Utilities for manipulating a TextRange The methods of this class are static and must be called using the syntax `NavigationUtil.method(parameter)`.

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
--- | --- | ---
|  | endOfDocument(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the end of the document. | NavigationUtil
|  | endOfLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the end of the line. | NavigationUtil
|  | endOfParagraph(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the end of the paragraph. | NavigationUtil
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | nextAtomPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int [static] Returns the absolute position of the next atom. | NavigationUtil
|  | nextCharacter(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange forward by one character. | NavigationUtil
|  | nextLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange down one line | NavigationUtil
|  | nextPage(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange down one page. | NavigationUtil
|  | nextWord(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange forward by one word. | NavigationUtil
|  | nextWordPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int [static] Returns the absolute position of the beginning of the next word. | NavigationUtil
|  | previousAtomPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int [static] Returns the absolute position of the previous atom. | NavigationUtil
|  | previousCharacter(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange backward by one character. | NavigationUtil
|  | previousLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange up one line. | NavigationUtil
|  | previousPage(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange up one page. | NavigationUtil
|  | previousWord(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange backward by one word. | NavigationUtil
|  | previousWordPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int [static] Returns absolute position of the beginning of the previous word. | NavigationUtil
|  | 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
|  | startOfDocument(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the beginning of the document. | NavigationUtil
|  | startOfLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the beginning of the line. | NavigationUtil
|  | startOfParagraph(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean [static] Sets the TextRange at the beginning of the paragraph. | NavigationUtil
|  | 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

Method Detail

### endOfDocument

()
method

`public static function endOfDocument(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the end of the document.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### endOfLine

()
method

`public static function endOfLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the end of the line.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### endOfParagraph

()
method

`public static function endOfParagraph(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the end of the paragraph.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### nextAtomPosition

()
method

`public static function nextAtomPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the absolute position of the next atom.

Parameters

| `flowRoot:flashx.textLayout.elements:TextFlow`
| `absolutePos:int`

Returns

| `int`

### nextCharacter

()
method

`public static function nextCharacter(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange forward by one character.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### nextLine

()
method

`public static function nextLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange down one line

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### nextPage

()
method

`public static function nextPage(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange down one page.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### nextWord

()
method

`public static function nextWord(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange forward by one word.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### nextWordPosition

()
method

`public static function nextWordPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the absolute position of the beginning of the next word.

Parameters

| `flowRoot:flashx.textLayout.elements:TextFlow`
| `absolutePos:int`

Returns

| `int`

### previousAtomPosition

()
method

`public static function previousAtomPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the absolute position of the previous atom.

Parameters

| `flowRoot:flashx.textLayout.elements:TextFlow`
| `absolutePos:int`

Returns

| `int`

### previousCharacter

()
method

`public static function previousCharacter(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange backward by one character.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### previousLine

()
method

`public static function previousLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange up one line.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### previousPage

()
method

`public static function previousPage(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange up one page.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### previousWord

()
method

`public static function previousWord(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange backward by one word.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### previousWordPosition

()
method

`public static function previousWordPosition(flowRoot:flashx.textLayout.elements:TextFlow, absolutePos:int):int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns absolute position of the beginning of the previous word.

Parameters

| `flowRoot:flashx.textLayout.elements:TextFlow`
| `absolutePos:int`

Returns

| `int`

### startOfDocument

()
method

`public static function startOfDocument(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the beginning of the document.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### startOfLine

()
method

`public static function startOfLine(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the beginning of the line.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

### startOfParagraph

()
method

`public static function startOfParagraph(range:flashx.textLayout.elements:TextRange, extendSelection:Boolean = false):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the TextRange at the beginning of the paragraph.

Parameters

| `range:flashx.textLayout.elements:TextRange` — Indicates that only activeIndex should move
| `extendSelection:Boolean` (default = `false`)``

Returns

| `Boolean` — true if selection changed.

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