Package org.gnome.webkit.jsc

Class Class

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.jsc.Class

All Implemented Interfaces:

Proxy

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

A JSSClass represents a custom JavaScript class registered by the user in a JSCContext. It allows to create new JavaScripts objects whose instances are created by the user using this API. It's possible to add constructors, properties and methods for a JSSClass by providing GCallback<!-- -->s to implement them.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Value	addConstructor(@Nullable String name, Callback callback, Type returnType, @Nullable Type[] parameterTypes)	Add a constructor to this Class.
Value	addConstructorVariadic(@Nullable String name, Callback callback, Type returnType)	Add a constructor to this Class.
void	addMethod(String name, Callback callback, Type returnType, @Nullable Type[] parameterTypes)	Add method with name to this Class.
void	addMethodVariadic(String name, Callback callback, Type returnType)	Add method with name to this Class.
void	addProperty(String name, Type propertyType, @Nullable Callback getter, @Nullable Callback setter)	Add a property with name to this Class.
protected Class	asParent()	Returns this instance as if it were its parent type.
static Class.Builder<? extends Class.Builder>	builder()	A Class.Builder object constructs a Class with the specified properties.
String	getName()	Get the class name of this Class
Class	getParent()	Get the parent class of this Class
static Type	getType()	Get the GType of the Class class

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, 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

Class

public Class(MemorySegment address)

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

Returns:

the GType

asParent

protected Class 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

addConstructorVariadic

public Value addConstructorVariadic(@Nullable
 @Nullable String name,
 Callback callback,
 Type returnType)

Add a constructor to this Class. If name is null, the class name will be used. When <function>new</function> is used with the constructor or jsc_value_constructor_call() is called, callback is invoked receiving a GPtrArray of JSCValue<!-- -->s as arguments and userData as the last parameter. When the constructor object is cleared in the JSCClass context, destroyNotify is called with userData as parameter.

This function creates the constructor, which needs to be added to an object as a property to be able to use it. Use jsc_context_set_value() to make the constructor available in the global object.

Note that the value returned by callback is adopted by this Class, and the GDestroyNotify passed to jsc_context_register_class() is responsible for disposing of it.

Parameters:

name - the constructor name or null

callback - a GCallback to be called to create an instance of this Class

returnType - the GType of the constructor return value

Returns:

a JSCValue representing the class constructor.

addConstructor

public Value addConstructor(@Nullable
 @Nullable String name,
 Callback callback,
 Type returnType,
 @Nullable
 @Nullable Type[] parameterTypes)

Add a constructor to this Class. If name is null, the class name will be used. When <function>new</function> is used with the constructor or jsc_value_constructor_call() is called, callback is invoked receiving the parameters and userData as the last parameter. When the constructor object is cleared in the JSCClass context, destroyNotify is called with userData as parameter.

This function creates the constructor, which needs to be added to an object as a property to be able to use it. Use jsc_context_set_value() to make the constructor available in the global object.

Note that the value returned by callback is adopted by this Class, and the GDestroyNotify passed to jsc_context_register_class() is responsible for disposing of it.

Parameters:

name - the constructor name or null

callback - a GCallback to be called to create an instance of this Class

returnType - the GType of the constructor return value

parameterTypes - a list of GType<!-- -->s, one for each parameter, or null

Returns:

a JSCValue representing the class constructor.

addMethodVariadic

public void addMethodVariadic(String name,
 Callback callback,
 Type returnType)

Add method with name to this Class. When the method is called by JavaScript or jsc_value_object_invoke_method(), callback is called receiving the class instance as first parameter, followed by a GPtrArray of JSCValue<!-- -->s with the method arguments and then userData as last parameter. When the method is cleared in the JSCClass context, destroyNotify is called with userData as parameter.

Note that the value returned by callback must be transfer full. In case of non-refcounted boxed types, you should use G_TYPE_POINTER instead of the actual boxed GType to ensure that the instance owned by JSCClass is used. If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter.

Parameters:

name - the method name

callback - a GCallback to be called to invoke method name of this Class

returnType - the GType of the method return value, or G_TYPE_NONE if the method is void.

addMethod

public void addMethod(String name,
 Callback callback,
 Type returnType,
 @Nullable
 @Nullable Type[] parameterTypes)

Add method with name to this Class. When the method is called by JavaScript or jsc_value_object_invoke_method(), callback is called receiving the class instance as first parameter, followed by the method parameters and then userData as last parameter. When the method is cleared in the JSCClass context, destroyNotify is called with userData as parameter.

Note that the value returned by callback must be transfer full. In case of non-refcounted boxed types, you should use G_TYPE_POINTER instead of the actual boxed GType to ensure that the instance owned by JSCClass is used. If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter.

Parameters:

name - the method name

callback - a GCallback to be called to invoke method name of this Class

returnType - the GType of the method return value, or G_TYPE_NONE if the method is void.

parameterTypes - a list of GType<!-- -->s, one for each parameter, or null

addProperty

public void addProperty(String name,
 Type propertyType,
 @Nullable
 @Nullable Callback getter,
 @Nullable
 @Nullable Callback setter)

Add a property with name to this Class. When the property value needs to be getted, getter is called receiving the the class instance as first parameter and userData as last parameter. When the property value needs to be set, setter is called receiving the the class instance as first parameter, followed by the value to be set and then userData as the last parameter. When the property is cleared in the JSCClass context, destroyNotify is called with userData as parameter.

Note that the value returned by getter must be transfer full. In case of non-refcounted boxed types, you should use G_TYPE_POINTER instead of the actual boxed GType to ensure that the instance owned by JSCClass is used. If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created with jsc_value_new_object() that receives the copy as the instance parameter.

Parameters:

name - the property name

propertyType - the GType of the property value

getter - a GCallback to be called to get the property value

setter - a GCallback to be called to set the property value

getName

public String getName()

Get the class name of this Class

Returns:

the name of this Class

getParent

public Class getParent()

Get the parent class of this Class

Returns:

the parent class of this Class

builder

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

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