org.mozilla.geckoview

Class WebExtension.Action

Object

org.mozilla.geckoview.WebExtension.Action

Enclosing class:

WebExtension

@AnyThread
public static class WebExtension.Action
extends Object

Represents either a Browser Action or a Page Action from the WebExtension API. Instances of this class may represent the default Action which applies to all WebExtension tabs or a tab-specific override. To reconstruct the full Action object, you can use withDefault(org.mozilla.geckoview.WebExtension.Action). Tab specific overrides can be obtained by registering a delegate using WebExtension.SessionController.setActionDelegate(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.WebExtension.ActionDelegate), while default values can be obtained by registering a delegate using WebExtension.setActionDelegate(org.mozilla.geckoview.WebExtension.ActionDelegate).
See also

• WebExtensions/API/browserAction
• WebExtensions/API/pageAction

Field Summary

Fields

Modifier and Type	Field and Description
Integer	badgeBackgroundColor Background color for the badge for this Action.
String	badgeText Badge text for this action.
Integer	badgeTextColor Text color for the badge for this Action.
Boolean	enabled Whether this action is enabled and should be visible.
WebExtension.Icon	icon Icon for this Action.
String	title Title of this Action.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Action()

Method Summary

Modifier and Type	Method and Description
void	click() Notifies the extension that the user has clicked on this Action.
String	toString()
WebExtension.Action	withDefault(WebExtension.Action defaultValue) Merges values from this Action with the default Action.

Methods inherited from class Object

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

Field Detail

title

@Nullable
public final String title

Title of this Action. See also: pageAction/getTitle, browserAction/getTitle

icon

@Nullable
public final WebExtension.Icon icon

Icon for this Action. See also: pageAction/setIcon, browserAction/setIcon

enabled

@Nullable
public final Boolean enabled

Whether this action is enabled and should be visible. Note: for page action, this is true when the extension calls pageAction.show and false when the extension calls pageAction.hide. See also: pageAction/show, browserAction/enabled

badgeText

@Nullable
public final String badgeText

Badge text for this action. See also: browserAction/getBadgeText

badgeBackgroundColor

@Nullable
public final Integer badgeBackgroundColor

Background color for the badge for this Action. This method will return an Android color int that can be used in View.setBackgroundColor(int) and similar methods. See also: browserAction/getBadgeBackgroundColor

badgeTextColor

@Nullable
public final Integer badgeTextColor

Text color for the badge for this Action. This method will return an Android color int that can be used in TextView.setTextColor(int) and similar methods. See also: browserAction/getBadgeTextColor

Constructor Detail

Action

protected Action()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

withDefault

@NonNull
public WebExtension.Action withDefault(@NonNull
                                                WebExtension.Action defaultValue)

Merges values from this Action with the default Action.

Parameters:

defaultValue - the default Action as received from WebExtension.ActionDelegate.onBrowserAction(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.WebExtension.Action) or WebExtension.ActionDelegate.onPageAction(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.WebExtension.Action).

Returns:

an WebExtension.Action where all null values from this instance are replaced with values from defaultValue.

Throws:

IllegalArgumentException - if defaultValue is not of the same type, e.g. if this Action is a Page Action and default value is a Browser Action.

click

@UiThread
public void click()

Notifies the extension that the user has clicked on this Action.