Package org.gnome.webkit

Class ContextMenuItem

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.webkit.ContextMenuItem

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class ContextMenuItem
extends InitiallyUnowned

One item of a WebKitContextMenu.

The WebKitContextMenu is composed of WebKitContextMenuItem<!-- -->s. These items can be created from a GtkAction, from a WebKitContextMenuAction or from a WebKitContextMenuAction and a label. These WebKitContextMenuAction<!-- -->s denote stock actions for the items. You can also create separators and submenus.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContextMenuItem.Builder<B extends ContextMenuItem.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ContextMenuItem.ContextMenuItemClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
ContextMenuItem(MemorySegment address)	Create a ContextMenuItem proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ContextMenuItem	asParent()	Returns this instance as if it were its parent type.
static ContextMenuItem.Builder<? extends ContextMenuItem.Builder>	builder()	A ContextMenuItem.Builder object constructs a ContextMenuItem with the specified properties.
static ContextMenuItem	fromGaction(Action action, String label, @Nullable Variant target)	Creates a new WebKitContextMenuItem for the given action and label.
static ContextMenuItem	fromStockAction(ContextMenuAction action)	Creates a new WebKitContextMenuItem for the given stock action.
static ContextMenuItem	fromStockActionWithLabel(ContextMenuAction action, String label)	Creates a new WebKitContextMenuItem for the given stock action using the given label.
Action	getGaction()	Gets the action associated to this ContextMenuItem as a GAction.
ContextMenuAction	getStockAction()	Gets the WebKitContextMenuAction of this ContextMenuItem.
ContextMenu	getSubmenu()	Gets the submenu of this ContextMenuItem.
static Type	getType()	Get the GType of the ContextMenuItem class
boolean	isSeparator()	Checks whether this ContextMenuItem is a separator.
static ContextMenuItem	separator()	Creates a new WebKitContextMenuItem representing a separator.
void	setSubmenu(@Nullable ContextMenu submenu)	Sets or replaces the this ContextMenuItem submenu.
static ContextMenuItem	withSubmenu(String label, ContextMenu submenu)	Creates a new WebKitContextMenuItem using the given label with a submenu.

Methods inherited from class org.gnome.gobject.InitiallyUnowned

getMemoryLayout

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

ContextMenuItem

public ContextMenuItem(MemorySegment address)

Create a ContextMenuItem proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ContextMenuItem class

Returns:

the GType

asParent

protected ContextMenuItem asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class InitiallyUnowned

fromGaction

public static ContextMenuItem fromGaction(Action action,
 String label,
 @Nullable
 @Nullable Variant target)

Creates a new WebKitContextMenuItem for the given action and label.

On activation target will be passed as parameter to the callback.

Parameters:

action - a GAction

label - the menu item label text

target - a GVariant to use as the action target

Returns:

the newly created WebKitContextMenuItem object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

fromStockAction

public static ContextMenuItem fromStockAction(ContextMenuAction action)

Creates a new WebKitContextMenuItem for the given stock action.

Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a ContextMenuAction.STOP is activated the action associated will be handled by WebKit and the current load operation will be stopped. You can get the GAction of a WebKitContextMenuItem created with a WebKitContextMenuAction with webkit_context_menu_item_get_gaction() and connect to the GSimpleAction::activate signal to be notified when the item is activated, but you can't prevent the associated action from being performed.

Parameters:

action - a WebKitContextMenuAction stock action

Returns:

the newly created WebKitContextMenuItem object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

fromStockActionWithLabel

public static ContextMenuItem fromStockActionWithLabel(ContextMenuAction action,
 String label)

Creates a new WebKitContextMenuItem for the given stock action using the given label.

Stock actions have a predefined label, this method can be used to create a WebKitContextMenuItem for a WebKitContextMenuAction but using a custom label.

Parameters:

action - a WebKitContextMenuAction stock action

label - a custom label text to use instead of the predefined one

Returns:

the newly created WebKitContextMenuItem object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

separator

public static ContextMenuItem separator()

Creates a new WebKitContextMenuItem representing a separator.

Returns:

the newly created WebKitContextMenuItem object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

withSubmenu

public static ContextMenuItem withSubmenu(String label,
 ContextMenu submenu)

Creates a new WebKitContextMenuItem using the given label with a submenu.

Parameters:

label - the menu item label text

submenu - a WebKitContextMenu to set

Returns:

the newly created WebKitContextMenuItem object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getGaction

public Action getGaction()

Gets the action associated to this ContextMenuItem as a GAction.

Returns:

the GAction associated to the WebKitContextMenuItem, or null if this ContextMenuItem is a separator.

getStockAction

public ContextMenuAction getStockAction()

Gets the WebKitContextMenuAction of this ContextMenuItem.

If the WebKitContextMenuItem was not created for a stock action ContextMenuAction.CUSTOM will be returned. If the WebKitContextMenuItem is a separator ContextMenuAction.NO_ACTION will be returned.

Returns:

the WebKitContextMenuAction of this ContextMenuItem

getSubmenu

public ContextMenu getSubmenu()

Gets the submenu of this ContextMenuItem.

Returns:

the WebKitContextMenu representing the submenu of this ContextMenuItem or null if this ContextMenuItem doesn't have a submenu.

isSeparator

public boolean isSeparator()

Checks whether this ContextMenuItem is a separator.

Returns:

true is this ContextMenuItem is a separator or false otherwise

setSubmenu

public void setSubmenu(@Nullable
 @Nullable ContextMenu submenu)

Sets or replaces the this ContextMenuItem submenu.

If submenu is null the current submenu of this ContextMenuItem is removed.

Parameters:

submenu - a WebKitContextMenu

builder

public static ContextMenuItem.Builder<? extends ContextMenuItem.Builder> builder()

A ContextMenuItem.Builder object constructs a ContextMenuItem with the specified properties. Use the various set...() methods to set properties, and finish construction with ContextMenuItem.Builder.build().