Package org.gnome.gtk

Enum Class AccessibleRelation

java.lang.Object

java.lang.Enum<AccessibleRelation>

org.gnome.gtk.AccessibleRelation

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AccessibleRelation>, Constable

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

The possible accessible relations of a Accessible.

Accessible relations can be references to other widgets, integers or strings.

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
ACTIVE_DESCENDANT	Identifies the currently active element when focus is on a composite widget, combobox, textbox, group, or application.
COL_COUNT	Defines the total number of columns in a table, grid, or treegrid.
COL_INDEX	Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
COL_INDEX_TEXT	Defines a human readable text alternative of COL_INDEX.
COL_SPAN	Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
CONTROLS	Identifies the element (or elements) whose contents or presence are controlled by the current element.
DESCRIBED_BY	Identifies the element (or elements) that describes the object.
DETAILS	Identifies the element (or elements) that provide additional information related to the object.
ERROR_MESSAGE	Identifies the element (or elements) that provide an error message for an object.
FLOW_TO	Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
LABELLED_BY	Identifies the element (or elements) that labels the current element.
OWNS	Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between elements where the widget hierarchy cannot be used to represent the relationship.
POS_IN_SET	Defines an element's number or position in the current set of listitems or treeitems.
ROW_COUNT	Defines the total number of rows in a table, grid, or treegrid.
ROW_INDEX	Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
ROW_INDEX_TEXT	Defines a human readable text alternative of aria-rowindex.
ROW_SPAN	Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
SET_SIZE	Defines the number of items in the current set of listitems or treeitems.

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the AccessibleRelation class
int	getValue()	Get the numeric value of this enum
void	initValue(Value value)	Initializes value with the appropriate type for the this AccessibleRelation.
static AccessibleRelation	of(int value)	Create a new AccessibleRelation for the provided value
static AccessibleRelation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AccessibleRelation[]	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

ACTIVE_DESCENDANT

public static final AccessibleRelation ACTIVE_DESCENDANT

Identifies the currently active element when focus is on a composite widget, combobox, textbox, group, or application. Value type: reference

COL_COUNT

public static final AccessibleRelation COL_COUNT

Defines the total number of columns in a table, grid, or treegrid. Value type: integer

COL_INDEX

public static final AccessibleRelation COL_INDEX

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. Value type: integer

COL_INDEX_TEXT

public static final AccessibleRelation COL_INDEX_TEXT

Defines a human readable text alternative of COL_INDEX. Value type: string

COL_SPAN

public static final AccessibleRelation COL_SPAN

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. Value type: integer

CONTROLS

public static final AccessibleRelation CONTROLS

Identifies the element (or elements) whose contents or presence are controlled by the current element. Value type: reference

DESCRIBED_BY

public static final AccessibleRelation DESCRIBED_BY

Identifies the element (or elements) that describes the object. Value type: reference

DETAILS

public static final AccessibleRelation DETAILS

Identifies the element (or elements) that provide additional information related to the object. Value type: reference

ERROR_MESSAGE

public static final AccessibleRelation ERROR_MESSAGE

Identifies the element (or elements) that provide an error message for an object. Value type: reference

FLOW_TO

public static final AccessibleRelation FLOW_TO

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. Value type: reference

LABELLED_BY

public static final AccessibleRelation LABELLED_BY

Identifies the element (or elements) that labels the current element. Value type: reference

OWNS

public static final AccessibleRelation OWNS

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between elements where the widget hierarchy cannot be used to represent the relationship. Value type: reference

POS_IN_SET

public static final AccessibleRelation POS_IN_SET

Defines an element's number or position in the current set of listitems or treeitems. Value type: integer

ROW_COUNT

public static final AccessibleRelation ROW_COUNT

Defines the total number of rows in a table, grid, or treegrid. Value type: integer

ROW_INDEX

public static final AccessibleRelation ROW_INDEX

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. Value type: integer

ROW_INDEX_TEXT

public static final AccessibleRelation ROW_INDEX_TEXT

Defines a human readable text alternative of aria-rowindex. Value type: string

ROW_SPAN

public static final AccessibleRelation ROW_SPAN

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. Value type: integer

SET_SIZE

public static final AccessibleRelation SET_SIZE

Defines the number of items in the current set of listitems or treeitems. Value type: integer

Method Details

values

public static AccessibleRelation[] 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 AccessibleRelation 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 AccessibleRelation of(int value)

Create a new AccessibleRelation 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 AccessibleRelation class

Returns:

the GType

initValue

public void initValue(Value value)

Initializes value with the appropriate type for the this AccessibleRelation.

This function is mostly meant for language bindings, in conjunction with gtk_accessible_update_relation_value().

Parameters:

value - an uninitialized GValue