Packageflashx.textLayout.utils
Classpublic final class NavigationUtil
InheritanceNavigationUtil Inheritance 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 Methods
 MethodDefined By
  
endOfDocument(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the end of the document.
NavigationUtil
  
endOfLine(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the end of the line.
NavigationUtil
  
endOfParagraph(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the end of the paragraph.
NavigationUtil
  
nextAtomPosition(flowRoot:TextFlow, absolutePos:int):int
[static] Returns the absolute position of the next atom.
NavigationUtil
  
nextCharacter(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange forward by one character.
NavigationUtil
  
nextLine(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange down one line
NavigationUtil
  
nextPage(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange down one page.
NavigationUtil
  
nextWord(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange forward by one word.
NavigationUtil
  
nextWordPosition(flowRoot:TextFlow, absolutePos:int):int
[static] Returns the absolute position of the beginning of the next word.
NavigationUtil
  
previousAtomPosition(flowRoot:TextFlow, absolutePos:int):int
[static] Returns the absolute position of the previous atom.
NavigationUtil
  
previousCharacter(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange backward by one character.
NavigationUtil
  
previousLine(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange up one line.
NavigationUtil
  
previousPage(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange up one page.
NavigationUtil
  
previousWord(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange backward by one word.
NavigationUtil
  
previousWordPosition(flowRoot:TextFlow, absolutePos:int):int
[static] Returns absolute position of the beginning of the previous word.
NavigationUtil
  
startOfDocument(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the beginning of the document.
NavigationUtil
  
startOfLine(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the beginning of the line.
NavigationUtil
  
startOfParagraph(range:TextRange, extendSelection:Boolean = false):Boolean
[static] Sets the TextRange at the beginning of the paragraph.
NavigationUtil
Method Detail
endOfDocument()method
public static function endOfDocument(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
endOfLine()method 
public static function endOfLine(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
endOfParagraph()method 
public static function endOfParagraph(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
nextAtomPosition()method 
public static function nextAtomPosition(flowRoot: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:TextFlow
 
absolutePos:int

Returns
int
nextCharacter()method 
public static function nextCharacter(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
nextLine()method 
public static function nextLine(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
nextPage()method 
public static function nextPage(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
nextWord()method 
public static function nextWord(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
nextWordPosition()method 
public static function nextWordPosition(flowRoot: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:TextFlow
 
absolutePos:int

Returns
int
previousAtomPosition()method 
public static function previousAtomPosition(flowRoot: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:TextFlow
 
absolutePos:int

Returns
int
previousCharacter()method 
public static function previousCharacter(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
previousLine()method 
public static function previousLine(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
previousPage()method 
public static function previousPage(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
previousWord()method 
public static function previousWord(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
previousWordPosition()method 
public static function previousWordPosition(flowRoot: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:TextFlow
 
absolutePos:int

Returns
int
startOfDocument()method 
public static function startOfDocument(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
startOfLine()method 
public static function startOfLine(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.
startOfParagraph()method 
public static function startOfParagraph(range: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:TextRange — Indicates that only activeIndex should move
 
extendSelection:Boolean (default = false)

Returns
Boolean — true if selection changed.



The Apache Software Foundation

Wed Mar 25 2015, 07:57 PM +01:00