to top
Android APIs
public class

Selection

extends Object
java.lang.Object
   ↳ android.text.Selection

Class Overview

Utility class for manipulating cursors and selections in CharSequences. A cursor is a selection where the start and end are at the same offset.

Summary

Fields
public static final Object SELECTION_END
public static final Object SELECTION_START
Public Methods
static boolean extendDown(Spannable text, Layout layout)
Move the selection end to the buffer offset physically below the current selection end.
static boolean extendLeft(Spannable text, Layout layout)
Move the selection end to the buffer offset physically to the left of the current selection end.
static boolean extendRight(Spannable text, Layout layout)
Move the selection end to the buffer offset physically to the right of the current selection end.
final static void extendSelection(Spannable text, int index)
Move the selection edge to offset index.
static boolean extendToLeftEdge(Spannable text, Layout layout)
static boolean extendToRightEdge(Spannable text, Layout layout)
static boolean extendUp(Spannable text, Layout layout)
Move the selection end to the buffer offset physically above the current selection end.
final static int getSelectionEnd(CharSequence text)
Return the offset of the selection edge or cursor, or -1 if there is no selection or cursor.
final static int getSelectionStart(CharSequence text)
Return the offset of the selection anchor or cursor, or -1 if there is no selection or cursor.
static boolean moveDown(Spannable text, Layout layout)
Move the cursor to the buffer offset physically below the current offset, or return false if the cursor is already on the bottom line.
static boolean moveLeft(Spannable text, Layout layout)
Move the cursor to the buffer offset physically to the left of the current offset, or return false if the cursor is already at the left edge of the line and there is not another line to move it to.
static boolean moveRight(Spannable text, Layout layout)
Move the cursor to the buffer offset physically to the right of the current offset, or return false if the cursor is already at at the right edge of the line and there is not another line to move it to.
static boolean moveToLeftEdge(Spannable text, Layout layout)
static boolean moveToRightEdge(Spannable text, Layout layout)
static boolean moveUp(Spannable text, Layout layout)
Move the cursor to the buffer offset physically above the current offset, or return false if the cursor is already on the top line.
final static void removeSelection(Spannable text)
Remove the selection or cursor, if any, from the text.
final static void selectAll(Spannable text)
Select the entire text.
final static void setSelection(Spannable text, int index)
Move the cursor to offset index.
static void setSelection(Spannable text, int start, int stop)
Set the selection anchor to start and the selection edge to stop.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final Object SELECTION_END

Since: API Level 1

public static final Object SELECTION_START

Since: API Level 1

Public Methods

public static boolean extendDown (Spannable text, Layout layout)

Since: API Level 1

Move the selection end to the buffer offset physically below the current selection end.

public static boolean extendLeft (Spannable text, Layout layout)

Since: API Level 1

Move the selection end to the buffer offset physically to the left of the current selection end.

public static boolean extendRight (Spannable text, Layout layout)

Since: API Level 1

Move the selection end to the buffer offset physically to the right of the current selection end.

public static final void extendSelection (Spannable text, int index)

Since: API Level 1

Move the selection edge to offset index.

public static boolean extendToLeftEdge (Spannable text, Layout layout)

Since: API Level 1

public static boolean extendToRightEdge (Spannable text, Layout layout)

Since: API Level 1

public static boolean extendUp (Spannable text, Layout layout)

Since: API Level 1

Move the selection end to the buffer offset physically above the current selection end.

public static final int getSelectionEnd (CharSequence text)

Since: API Level 1

Return the offset of the selection edge or cursor, or -1 if there is no selection or cursor.

public static final int getSelectionStart (CharSequence text)

Since: API Level 1

Return the offset of the selection anchor or cursor, or -1 if there is no selection or cursor.

public static boolean moveDown (Spannable text, Layout layout)

Since: API Level 1

Move the cursor to the buffer offset physically below the current offset, or return false if the cursor is already on the bottom line.

public static boolean moveLeft (Spannable text, Layout layout)

Since: API Level 1

Move the cursor to the buffer offset physically to the left of the current offset, or return false if the cursor is already at the left edge of the line and there is not another line to move it to.

public static boolean moveRight (Spannable text, Layout layout)

Since: API Level 1

Move the cursor to the buffer offset physically to the right of the current offset, or return false if the cursor is already at at the right edge of the line and there is not another line to move it to.

public static boolean moveToLeftEdge (Spannable text, Layout layout)

Since: API Level 1

public static boolean moveToRightEdge (Spannable text, Layout layout)

Since: API Level 1

public static boolean moveUp (Spannable text, Layout layout)

Since: API Level 1

Move the cursor to the buffer offset physically above the current offset, or return false if the cursor is already on the top line.

public static final void removeSelection (Spannable text)

Since: API Level 1

Remove the selection or cursor, if any, from the text.

public static final void selectAll (Spannable text)

Since: API Level 1

Select the entire text.

public static final void setSelection (Spannable text, int index)

Since: API Level 1

Move the cursor to offset index.

public static void setSelection (Spannable text, int start, int stop)

Since: API Level 1

Set the selection anchor to start and the selection edge to stop.