LinkMovementMethod

Kotlin |Java

open class LinkMovementMethod : ScrollingMovementMethod

kotlin.Any
↳	android.text.method.BaseMovementMethod
	↳	android.text.method.ScrollingMovementMethod
		↳	android.text.method.LinkMovementMethod

A movement method that traverses links in the text buffer and scrolls if necessary. Supports clicking on links with DPad Center or Enter.

Summary

Public constructors
`LinkMovementMethod()`

Public methods
open 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.
open static MovementMethod!	`getInstance()`
open Unit	`initialize(widget: TextView!, text: Spannable!)`
open Unit	`onTakeFocus(view: TextView!, text: Spannable!, dir: Int)`
open Boolean	`onTouchEvent(widget: TextView!, buffer: Spannable!, event: MotionEvent!)`

Protected methods
open Boolean	`down(widget: TextView!, buffer: Spannable!)` Performs a down movement action.
open Boolean	`handleMovementKey(widget: TextView!, buffer: Spannable!, keyCode: Int, movementMetaState: Int, event: KeyEvent!)` Performs a movement key action.
open Boolean	`left(widget: TextView!, buffer: Spannable!)` Performs a left movement action.
open Boolean	`right(widget: TextView!, buffer: Spannable!)` Performs a right movement action.
open Boolean	`up(widget: TextView!, buffer: Spannable!)` Performs an up movement action.

Inherited functions

From class ScrollingMovementMethod

`Boolean`	`bottom(widget: TextView!, buffer: Spannable!)` Performs a bottom movement action. Moves the cursor or scrolls to the bottom of the buffer.
`Boolean`	`end(widget: TextView!, buffer: Spannable!)` 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.
`Boolean`	`home(widget: TextView!, buffer: Spannable!)` 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.
`Boolean`	`lineEnd(widget: TextView!, buffer: Spannable!)` Performs a line-end movement action. Moves the cursor or scrolls to the end of the line.
`Boolean`	`lineStart(widget: TextView!, buffer: Spannable!)` Performs a line-start movement action. Moves the cursor or scrolls to the start of the line.
`Boolean`	`pageDown(widget: TextView!, buffer: Spannable!)` Performs a page-down movement action. Moves the cursor or scrolls down by one page.
`Boolean`	`pageUp(widget: TextView!, buffer: Spannable!)` Performs a page-up movement action. Moves the cursor or scrolls up by one page.
`Boolean`	`top(widget: TextView!, buffer: Spannable!)` Performs a top movement action. Moves the cursor or scrolls to the top of the buffer.

From class BaseMovementMethod

`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.
`Int`	`getMovementMetaState(buffer: Spannable!, event: KeyEvent!)` Gets the meta state used for movement using the modifiers tracked by the text buffer as well as those present in the key event. The movement meta state excludes the state of locked modifiers or the SHIFT key since they are not used by movement actions (but they may be used for selection).
`Boolean`	`handleMovementKey(widget: TextView!, buffer: Spannable!, keyCode: Int, movementMetaState: Int, event: KeyEvent!)` 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`.
`Unit`	`initialize(widget: TextView!, text: Spannable!)`
`Boolean`	`nextParagraph(widget: TextView, buffer: Spannable)` Performs a next paragraph movement action.
`Boolean`	`onGenericMotionEvent(widget: TextView!, text: Spannable!, event: MotionEvent!)`
`Boolean`	`onKeyDown(widget: TextView!, text: Spannable!, keyCode: Int, event: KeyEvent!)`
`Boolean`	`onKeyOther(widget: 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.
`Boolean`	`onKeyUp(widget: TextView!, text: Spannable!, keyCode: Int, event: KeyEvent!)`
`Boolean`	`onTrackballEvent(widget: TextView!, text: Spannable!, event: MotionEvent!)`
`Boolean`	`previousParagraph(widget: TextView, buffer: Spannable)` Performs a previous paragraph movement action.

Public constructors

LinkMovementMethod

LinkMovementMethod()

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

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

Protected methods

down

Added in API level 1

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.

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.

left

Added in API level 1

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.

right

Added in API level 1

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.

up

Added in API level 1

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.