Enum Class SnapshotOptions

java.lang.Object

java.lang.Enum<SnapshotOptions>

org.webkitgtk.SnapshotOptions

All Implemented Interfaces:

Serializable, Comparable<SnapshotOptions>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum SnapshotOptions
extends Enum<SnapshotOptions>
implements Enumeration

Enum values used to specify options when taking a snapshot from a WebKitWebView.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCLUDE_SELECTION_HIGHLIGHTING	Whether to include in the snapshot the highlight of the selected content.
NONE	Do not include any special options.
TRANSPARENT_BACKGROUND	Do not fill the background with white before rendering the snapshot.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the SnapshotOptions class.
int	getValue()	Get the numeric value of this enum
static Set<SnapshotOptions>	of(int flags)	Create a new EnumSet<SnapshotOptions> for the provided bitfield
static Set<SnapshotOptions>	of(MemorySegment address)	Create a new EnumSet<SnapshotOptions> for the bitfield in the provided memory address.
static SnapshotOptions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SnapshotOptions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SnapshotOptions NONE

Do not include any special options.

INCLUDE_SELECTION_HIGHLIGHTING

public static final SnapshotOptions INCLUDE_SELECTION_HIGHLIGHTING

Whether to include in the snapshot the highlight of the selected content.

TRANSPARENT_BACKGROUND

public static final SnapshotOptions TRANSPARENT_BACKGROUND

Do not fill the background with white before rendering the snapshot. Since 2.8

Method Details

values

public static SnapshotOptions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SnapshotOptions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<SnapshotOptions> of(int flags)

Create a new EnumSet<SnapshotOptions> for the provided bitfield

Parameters:

flags - the SnapshotOptions bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<SnapshotOptions> of(MemorySegment address)

Create a new EnumSet<SnapshotOptions> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the SnapshotOptions class.

Returns:

the GType