Package org.gnome.webkit

Class OptionMenu

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.OptionMenu

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class OptionMenu
extends GObject

Represents the dropdown menu of a select element in a WebKitWebView.

When a select element in a WebKitWebView needs to display a dropdown menu, the signal WebKitWebView::show-option-menu is emitted, providing a WebKitOptionMenu with the WebKitOptionMenuItem<!-- -->s that should be displayed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptionMenu.Builder<B extends OptionMenu.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	OptionMenu.CloseCallback	Functional interface declaration of the CloseCallback callback.
static class	OptionMenu.OptionMenuClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	activateItem(int index)	Activates the WebKitOptionMenuItem at index in this OptionMenu.
protected OptionMenu	asParent()	Returns this instance as if it were its parent type.
static OptionMenu.Builder<? extends OptionMenu.Builder>	builder()	A OptionMenu.Builder object constructs a OptionMenu with the specified properties.
void	close()	Request to close a WebKitOptionMenu.
void	emitClose()	Emits the "close" signal.
Event	getEvent()	Gets the GdkEvent that triggered the dropdown menu.
OptionMenuItem	getItem(int index)	Returns the WebKitOptionMenuItem at index in this OptionMenu.
int	getNItems()	Gets the length of the this OptionMenu.
static Type	getType()	Get the GType of the OptionMenu class
SignalConnection<OptionMenu.CloseCallback>	onClose(OptionMenu.CloseCallback handler)	Emitted when closing a WebKitOptionMenu is requested.
void	selectItem(int index)	Selects the WebKitOptionMenuItem at index in this OptionMenu.

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, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, 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

OptionMenu

public OptionMenu(MemorySegment address)

Create a OptionMenu 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 OptionMenu class

Returns:

the GType

asParent

protected OptionMenu 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 GObject

activateItem

public void activateItem(int index)

Activates the WebKitOptionMenuItem at index in this OptionMenu.

Activating an item changes the value of the element making the item the active one. You are expected to close the menu with webkit_option_menu_close() after activating an item, calling this function again will have no effect.

Parameters:

index - the index of the item

close

public void close()

Request to close a WebKitOptionMenu.

This emits WebKitOptionMenu::close signal. This function should always be called to notify WebKit that the associated menu has been closed. If the menu is closed and neither webkit_option_menu_select_item() nor webkit_option_menu_activate_item() have been called, the element value remains unchanged.

getEvent

public Event getEvent()

Gets the GdkEvent that triggered the dropdown menu. If this OptionMenu was not triggered by a user interaction, like a mouse click, null is returned.

Returns:

the menu event or null.

getItem

public OptionMenuItem getItem(int index)

Returns the WebKitOptionMenuItem at index in this OptionMenu.

Parameters:

index - the index of the item

Returns:

a WebKitOptionMenuItem of this OptionMenu.

getNItems

public int getNItems()

Gets the length of the this OptionMenu.

Returns:

the number of WebKitOptionMenuItem<!-- -->s in this OptionMenu

selectItem

public void selectItem(int index)

Selects the WebKitOptionMenuItem at index in this OptionMenu.

Selecting an item changes the text shown by the combo button, but it doesn't change the value of the element. You need to explicitly activate the item with webkit_option_menu_select_item() or close the menu with webkit_option_menu_close() in which case the currently selected item will be activated.

Parameters:

index - the index of the item

onClose

public SignalConnection<OptionMenu.CloseCallback> onClose(OptionMenu.CloseCallback handler)

Emitted when closing a WebKitOptionMenu is requested. This can happen when the user explicitly calls webkit_option_menu_close() or when the element is detached from the current page.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• OptionMenu.CloseCallback.run()

emitClose

public void emitClose()

Emits the "close" signal. See onClose(org.gnome.webkit.OptionMenu.CloseCallback).

builder

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

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