S > Selection (object)

 

Selection (object)

The Selection object lets you set and control in which text field the cursor is located in a Flash movie. The text field that is said to have "focus" is the field in which the cursor is currently located. Selection-span indexes are zero-based (for example, the first position is 0, the second position is 1, and so on).

There is no constructor method for the Selection object, as there can only be one currently focused field at a time.

 
Method summary for the Selection object

Method

Description

Selection.addListener

Registers an object to receive notification when the onSetFocus method is invoked.

Selection.getBeginIndex

Returns the index at the beginning of selection span. Returns -1 if there is no index or currently selected field.

Selection.getCaretIndex

Returns the current caret position in the currently focused selection span. Returns -1 if there is no caret position or currently focused selection span.

Selection.getEndIndex

Returns the index at the end of the selection span. Returns -1 if there is no index or currently selected field.

Selection.getFocus

Returns the name of the variable for the currently focused text field. Returns null if there is no currently focused text field.

Selection.removeListener

Removes an object that was registered with addListener.

Selection.setFocus

Focuses the text field associated with the variable specified in the parameter.

Selection.setSelection

Sets the beginning and ending indexes of the selection span.


 
Listener summary for the Selection object

Method

Description

Selection.onSetFocus

Notified when the input focus changes.