Added in API level 1

ArrowKeyMovementMethod


open class ArrowKeyMovementMethod : BaseMovementMethod, MovementMethod
kotlin.Any
   ↳ android.text.method.BaseMovementMethod
   ↳ android.text.method.ArrowKeyMovementMethod

A movement method that provides cursor movement and selection. Supports displaying the context menu on DPad Center.

Summary

Public constructors

Public methods
open 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.

open static MovementMethod!

open Unit
initialize(widget: TextView!, text: Spannable!)

open Boolean
nextParagraph(widget: TextView, buffer: Spannable)

Performs a next paragraph movement action.

open Unit
onTakeFocus(view: TextView!, text: Spannable!, dir: Int)

open Boolean
onTouchEvent(widget: TextView!, buffer: Spannable!, event: MotionEvent!)

open Boolean

Performs a previous paragraph movement action.

Protected methods
open Boolean
bottom(widget: TextView!, buffer: Spannable!)

Performs a bottom movement action.

open Boolean
down(widget: TextView!, buffer: Spannable!)

Performs a down movement action.

open Boolean
end(widget: TextView!, buffer: Spannable!)

Performs an end movement action.

open Boolean
handleMovementKey(widget: TextView!, buffer: Spannable!, keyCode: Int, movementMetaState: Int, event: KeyEvent!)

Performs a movement key action.

open Boolean
home(widget: TextView!, buffer: Spannable!)

Performs a home movement action.

open Boolean
left(widget: TextView!, buffer: Spannable!)

Performs a left movement action.

open Boolean
lineEnd(widget: TextView!, buffer: Spannable!)

Performs a line-end movement action.

open Boolean
lineStart(widget: TextView!, buffer: Spannable!)

Performs a line-start movement action.

open Boolean
pageDown(widget: TextView!, buffer: Spannable!)

Performs a page-down movement action.

open Boolean
pageUp(widget: TextView!, buffer: Spannable!)

Performs a page-up movement action.

open Boolean
right(widget: TextView!, buffer: Spannable!)

Performs a right movement action.

open Boolean
top(widget: TextView!, buffer: Spannable!)

Performs a top movement action.

open Boolean
up(widget: TextView!, buffer: Spannable!)

Performs an up movement action.

Inherited functions

Public constructors

ArrowKeyMovementMethod

ArrowKeyMovementMethod()

Public methods

canSelectArbitrarily

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

getInstance

Added in API level 1
open static fun getInstance(): MovementMethod!

initialize

Added in API level 1
open fun initialize(
    widget: TextView!,
    text: Spannable!
): Unit

nextParagraph

Added in API level 34
open fun nextParagraph(
    widget: TextView,
    buffer: Spannable
): Boolean

Performs a next paragraph movement action.

Parameters
widget TextView: This value cannot be null.
buffer Spannable: This value cannot be null.
Return
Boolean true if the event was handled, otherwise false.

onTakeFocus

Added in API level 1
open fun onTakeFocus(
    view: TextView!,
    text: Spannable!,
    dir: Int
): Unit

onTouchEvent

Added in API level 1
open fun onTouchEvent(
    widget: TextView!,
    buffer: Spannable!,
    event: MotionEvent!
): Boolean

previousParagraph

Added in API level 34
open fun previousParagraph(
    widget: TextView,
    buffer: Spannable
): Boolean

Performs a previous paragraph movement action.

Parameters
widget TextView: This value cannot be null.
buffer Spannable: This value cannot be null.
Return
Boolean true if the event was handled, otherwise false.

Protected methods

bottom

Added in API level 11
protected open fun bottom(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a bottom movement action. Moves the cursor or scrolls to the bottom of the buffer.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

down

Added in API level 11
protected open fun down(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a down movement action. Moves the cursor or scrolls down by one line.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

end

Added in API level 11
protected open fun end(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs an end movement action. Moves the cursor or scrolls to the start of the line or to the top of the document depending on whether the insertion point is being moved or the document is being scrolled.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

handleMovementKey

Added in API level 11
protected open fun handleMovementKey(
    widget: TextView!,
    buffer: Spannable!,
    keyCode: Int,
    movementMetaState: Int,
    event: KeyEvent!
): Boolean

Performs a movement key action. The default implementation decodes the key down and invokes movement actions such as down and up. onKeyDown(android.widget.TextView,android.text.Spannable,int,android.view.KeyEvent) calls this method once to handle an KeyEvent.ACTION_DOWN. onKeyOther(android.widget.TextView,android.text.Spannable,android.view.KeyEvent) calls this method repeatedly to handle each repetition of an KeyEvent.ACTION_MULTIPLE.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
keyCode Int: The key code.
movementMetaState Int: The keyboard meta states used for movement.
event KeyEvent!: The key event.
Return
Boolean True if the event was handled.

home

Added in API level 11
protected open fun home(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a home movement action. Moves the cursor or scrolls to the start of the line or to the top of the document depending on whether the insertion point is being moved or the document is being scrolled.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

left

Added in API level 11
protected open fun left(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a left movement action. Moves the cursor or scrolls left by one character.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

lineEnd

Added in API level 11
protected open fun lineEnd(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a line-end movement action. Moves the cursor or scrolls to the end of the line.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

lineStart

Added in API level 11
protected open fun lineStart(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a line-start movement action. Moves the cursor or scrolls to the start of the line.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

pageDown

Added in API level 11
protected open fun pageDown(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a page-down movement action. Moves the cursor or scrolls down by one page.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

pageUp

Added in API level 11
protected open fun pageUp(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a page-up movement action. Moves the cursor or scrolls up by one page.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.
Added in API level 11
protected open fun right(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a right movement action. Moves the cursor or scrolls right by one character.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

top

Added in API level 11
protected open fun top(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs a top movement action. Moves the cursor or scrolls to the top of the buffer.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.

up

Added in API level 11
protected open fun up(
    widget: TextView!,
    buffer: Spannable!
): Boolean

Performs an up movement action. Moves the cursor or scrolls up by one line.

Parameters
widget TextView!: The text view.
buffer Spannable!: The text buffer.
Return
Boolean True if the event was handled.