Added in API level 1

MovementMethod

public interface MovementMethod

android.text.method.MovementMethod


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.

abstract void initialize(TextView widget, Spannable text)
abstract boolean onGenericMotionEvent(TextView widget, Spannable text, MotionEvent event)
abstract boolean onKeyDown(TextView widget, Spannable text, int keyCode, KeyEvent event)
abstract boolean onKeyOther(TextView view, Spannable text, KeyEvent event)

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

abstract boolean onKeyUp(TextView widget, Spannable text, int keyCode, KeyEvent event)
abstract void onTakeFocus(TextView widget, Spannable text, int direction)
abstract boolean onTouchEvent(TextView widget, Spannable text, MotionEvent event)
abstract boolean onTrackballEvent(TextView widget, Spannable text, MotionEvent event)

Public methods

canSelectArbitrarily

Added in API level 1
public 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.

Returns
boolean

initialize

Added in API level 1
public abstract void initialize (TextView widget, 
                Spannable text)

Parameters
widget TextView

text Spannable

onGenericMotionEvent

Added in API level 12
public abstract boolean onGenericMotionEvent (TextView widget, 
                Spannable text, 
                MotionEvent event)

Parameters
widget TextView

text Spannable

event MotionEvent

Returns
boolean

onKeyDown

Added in API level 1
public abstract boolean onKeyDown (TextView widget, 
                Spannable text, 
                int keyCode, 
                KeyEvent event)

Parameters
widget TextView

text Spannable

keyCode int

event KeyEvent

Returns
boolean

onKeyOther

Added in API level 3
public abstract boolean onKeyOther (TextView view, 
                Spannable text, 
                KeyEvent event)

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.

Parameters
view TextView

text Spannable

event KeyEvent

Returns
boolean

onKeyUp

Added in API level 1
public abstract boolean onKeyUp (TextView widget, 
                Spannable text, 
                int keyCode, 
                KeyEvent event)

Parameters
widget TextView

text Spannable

keyCode int

event KeyEvent

Returns
boolean

onTakeFocus

Added in API level 1
public abstract void onTakeFocus (TextView widget, 
                Spannable text, 
                int direction)

Parameters
widget TextView

text Spannable

direction int

onTouchEvent

Added in API level 1
public abstract boolean onTouchEvent (TextView widget, 
                Spannable text, 
                MotionEvent event)

Parameters
widget TextView

text Spannable

event MotionEvent

Returns
boolean

onTrackballEvent

Added in API level 1
public abstract boolean onTrackballEvent (TextView widget, 
                Spannable text, 
                MotionEvent event)

Parameters
widget TextView

text Spannable

event MotionEvent

Returns
boolean