MovementMethod

Kotlin |Java

interface MovementMethod

android.text.method.MovementMethod

Known Direct Subclasses

ArrowKeyMovementMethod, BaseMovementMethod, ScrollingMovementMethod

ArrowKeyMovementMethod	A movement method that provides cursor movement and selection.
BaseMovementMethod	Base classes for movement methods.
ScrollingMovementMethod	A movement method that interprets movement keys by scrolling the text buffer.

Known Indirect Subclasses

ArrowKeyMovementMethod, LinkMovementMethod, LinkMovementMethod, ScrollingMovementMethod

ArrowKeyMovementMethod	A movement method that provides cursor movement and selection.
LinkMovementMethod	A movement method that traverses links in the text buffer and scrolls if necessary.
LinkMovementMethod	A movement method that traverses links in the text buffer and scrolls if necessary.
ScrollingMovementMethod	A movement method that interprets movement keys by scrolling the text buffer.

Provides cursor positioning, scrolling and text selection functionality in a TextView.

The TextView delegates handling of key events, trackball motions and touches to the movement method for purposes of content navigation. The framework automatically selects an appropriate movement method based on the content of the TextView.

This interface is intended for use by the framework; it should not be implemented directly by applications.

Summary

Public methods
abstract Boolean	`canSelectArbitrarily()` Returns true if this movement method allows arbitrary selection of any text; false if it has no selection (like a movement method that only scrolls) or a constrained selection (for example limited to links. The "Select All" menu item is disabled if arbitrary selection is not allowed.
abstract Unit	`initialize(widget: TextView!, text: Spannable!)`
abstract Boolean	`onGenericMotionEvent(widget: TextView!, text: Spannable!, event: MotionEvent!)`
abstract Boolean	`onKeyDown(widget: TextView!, text: Spannable!, keyCode: Int, event: KeyEvent!)`
abstract Boolean	`onKeyOther(view: TextView!, text: Spannable!, event: KeyEvent!)` If the key listener wants to other kinds of key events, return true, otherwise return false and the caller (i.e. the widget host) will handle the key.
abstract Boolean	`onKeyUp(widget: TextView!, text: Spannable!, keyCode: Int, event: KeyEvent!)`
abstract Unit	`onTakeFocus(widget: TextView!, text: Spannable!, direction: Int)`
abstract Boolean	`onTouchEvent(widget: TextView!, text: Spannable!, event: MotionEvent!)`
abstract Boolean	`onTrackballEvent(widget: TextView!, text: Spannable!, event: MotionEvent!)`

Public methods

canSelectArbitrarily

Added in API level 1

abstract fun canSelectArbitrarily(): Boolean

Returns true if this movement method allows arbitrary selection of any text; false if it has no selection (like a movement method that only scrolls) or a constrained selection (for example limited to links. The "Select All" menu item is disabled if arbitrary selection is not allowed.

initialize

Added in API level 1

abstract fun initialize(
    widget: TextView!, 
    text: Spannable!
): Unit

onGenericMotionEvent

Added in API level 12

abstract fun onGenericMotionEvent(
    widget: TextView!, 
    text: Spannable!, 
    event: MotionEvent!
): Boolean

onKeyDown

Added in API level 1

abstract fun onKeyDown(
    widget: TextView!, 
    text: Spannable!, 
    keyCode: Int, 
    event: KeyEvent!
): Boolean

onKeyOther

Added in API level 3

abstract fun onKeyOther(
    view: TextView!, 
    text: Spannable!, 
    event: KeyEvent!
): Boolean

If the key listener wants to other kinds of key events, return true, otherwise return false and the caller (i.e. the widget host) will handle the key.

onKeyUp

Added in API level 1

abstract fun onKeyUp(
    widget: TextView!, 
    text: Spannable!, 
    keyCode: Int, 
    event: KeyEvent!
): Boolean

onTakeFocus

Added in API level 1

abstract fun onTakeFocus(
    widget: TextView!, 
    text: Spannable!, 
    direction: Int
): Unit

onTouchEvent

Added in API level 1

abstract fun onTouchEvent(
    widget: TextView!, 
    text: Spannable!, 
    event: MotionEvent!
): Boolean

onTrackballEvent

Added in API level 1

abstract fun onTrackballEvent(
    widget: TextView!, 
    text: Spannable!, 
    event: MotionEvent!
): Boolean