Package org.gnome.gtk

Enum Class AssistantPageType

java.lang.Object

java.lang.Enum<AssistantPageType>

org.gnome.gtk.AssistantPageType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AssistantPageType>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum AssistantPageType
extends Enum<AssistantPageType>
implements Enumeration

Determines the page role inside a GtkAssistant.

The role is used to handle buttons sensitivity and visibility.

Note that an assistant needs to end its page flow with a page of type CONFIRM, SUMMARY or PROGRESS to be correct.

The Cancel button will only be shown if the page isn’t “committed”. See gtk_assistant_commit() for details.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONFIRM	The page lets the user confirm or deny the changes.
CONTENT	The page has regular contents.
CUSTOM	Used for when other page types are not appropriate.
INTRO	The page contains an introduction to the assistant task.
PROGRESS	Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.
SUMMARY	The page informs the user of the changes done.

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the AssistantPageType class
int	getValue()	Get the numeric value of this enum
static AssistantPageType	of(int value)	Create a new AssistantPageType for the provided value
static AssistantPageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AssistantPageType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTENT

public static final AssistantPageType CONTENT

The page has regular contents. Both the Back and forward buttons will be shown.

INTRO

public static final AssistantPageType INTRO

The page contains an introduction to the assistant task. Only the Forward button will be shown if there is a next page.

CONFIRM

public static final AssistantPageType CONFIRM

The page lets the user confirm or deny the changes. The Back and Apply buttons will be shown.

SUMMARY

public static final AssistantPageType SUMMARY

The page informs the user of the changes done. Only the Close button will be shown.

PROGRESS

public static final AssistantPageType PROGRESS

Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. Only the back button will be shown.

CUSTOM

public static final AssistantPageType CUSTOM

Used for when other page types are not appropriate. No buttons will be shown, and the application must add its own buttons through gtk_assistant_add_action_widget().

Method Details

values

public static AssistantPageType[] 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 AssistantPageType 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

of

public static AssistantPageType of(int value)

Create a new AssistantPageType for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the AssistantPageType class

Returns:

the GType