Package org.mozilla.geckoview

Class GeckoSession.SelectionActionDelegate.Selection

Object

org.mozilla.geckoview.GeckoSession.SelectionActionDelegate.Selection

Enclosing interface:

GeckoSession.SelectionActionDelegate

public static class GeckoSession.SelectionActionDelegate.Selection
extends Object

Represents attributes of a selection.

Field Summary

Fields

Modifier and Type	Field	Description
final Collection<String>	availableActions	Set of valid actions available through execute(String)
final RectF	clientRect	The bounds of the current selection in client coordinates.
final int	flags	Flags describing the current selection, as a bitwise combination of the FLAG_* constants.
final String	text	Text content of the current selection.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Selection()	Empty constructor for tests.

Method Summary

Modifier and Type	Method	Description
void	collapseToEnd()	Collapse the current selection to its end position.
void	collapseToStart()	Collapse the current selection to its start position.
void	copy()	Copy the selected content onto the clipboard.
void	cut()	Copy onto the clipboard then delete the selected content.
void	delete()	Delete the selected content.
void	execute(String action)	Execute an GeckoSession.SelectionActionDelegate action.
void	hide()	Hide selection actions and cause GeckoSession.SelectionActionDelegate.onHideAction(org.mozilla.geckoview.GeckoSession, int) to be called.
boolean	isActionAvailable(String action)	Checks if the passed action is available
void	paste()	Replace the selected content with the clipboard content.
void	pasteAsPlainText()	Replace the selected content with the clipboard content as plain text.
void	selectAll()	Select the entire content of the document or editor.
void	unselect()	Clear the current selection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

flags

public final int flags

Flags describing the current selection, as a bitwise combination of the FLAG_* constants.

text

@NonNull
public final String text

Text content of the current selection. An empty string indicates the selection is collapsed or the selection cannot be represented as plain text.

clientRect

@Nullable
public final RectF clientRect

The bounds of the current selection in client coordinates. Use GeckoSession.getClientToScreenMatrix(android.graphics.Matrix) to perform transformation to screen coordinates.

availableActions

@NonNull
public final Collection<String> availableActions

Set of valid actions available through execute(String)

Constructor Details

Selection

protected Selection()

Empty constructor for tests.

Method Details

isActionAvailable

@AnyThread
public boolean isActionAvailable(@NonNull
 String action)

Checks if the passed action is available

Parameters:

action - An GeckoSession.SelectionActionDelegate to perform

Returns:

True if the action is available.

execute

@AnyThread
public void execute(@NonNull
 String action)

Execute an GeckoSession.SelectionActionDelegate action.

Parameters:

action - A GeckoSession.SelectionActionDelegate action.

Throws:

IllegalStateException - If the action was not available.

hide

@AnyThread
public void hide()

Hide selection actions and cause GeckoSession.SelectionActionDelegate.onHideAction(org.mozilla.geckoview.GeckoSession, int) to be called.

Throws:

IllegalStateException - If the action was not available.

cut

@AnyThread
public void cut()

Copy onto the clipboard then delete the selected content.

Throws:

IllegalStateException - If the action was not available.

copy

@AnyThread
public void copy()

Copy the selected content onto the clipboard.

Throws:

IllegalStateException - If the action was not available.

delete

@AnyThread
public void delete()

Delete the selected content.

Throws:

IllegalStateException - If the action was not available.

paste

@AnyThread
public void paste()

Replace the selected content with the clipboard content.

Throws:

IllegalStateException - If the action was not available.

pasteAsPlainText

@AnyThread
public void pasteAsPlainText()

Replace the selected content with the clipboard content as plain text.

Throws:

IllegalStateException - If the action was not available.

selectAll

@AnyThread
public void selectAll()

Select the entire content of the document or editor.

Throws:

IllegalStateException - If the action was not available.

unselect

@AnyThread
public void unselect()

Clear the current selection.

Throws:

IllegalStateException - If the action was not available.

collapseToStart

@AnyThread
public void collapseToStart()

Collapse the current selection to its start position.

Throws:

IllegalStateException - If the action was not available.

collapseToEnd

@AnyThread
public void collapseToEnd()

Collapse the current selection to its end position.

Throws:

IllegalStateException - If the action was not available.