Package org.gnome.adw

Class ViewStackPage

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.ViewStackPage

All Implemented Interfaces:

Proxy, Accessible

@Generated("io.github.jwharm.JavaGI")
public final class ViewStackPage
extends GObject
implements Accessible

An auxiliary class used by ViewStack.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ViewStackPage	asParent()	Returns this instance as if it were its parent type.
static ViewStackPage.Builder<? extends ViewStackPage.Builder>	builder()	A ViewStackPage.Builder object constructs a ViewStackPage with the specified properties.
int	getBadgeNumber()	Gets the badge number for this page.
Widget	getChild()	Gets the stack child to which this ViewStackPage belongs.
String	getIconName()	Gets the icon name of the page.
String	getName()	Gets the name of the page.
boolean	getNeedsAttention()	Gets whether the page requires the user attention.
String	getTitle()	Gets the page title.
static Type	getType()	Get the GType of the ViewStackPage class
boolean	getUseUnderline()	Gets whether underlines in the page title indicate mnemonics.
boolean	getVisible()	Gets whether this ViewStackPage is visible in its AdwViewStack.
void	setBadgeNumber(int badgeNumber)	Sets the badge number for this page.
void	setIconName(@Nullable String iconName)	Sets the icon name of the page.
void	setName(@Nullable String name)	Sets the name of the page.
void	setNeedsAttention(boolean needsAttention)	Sets whether the page requires the user attention.
void	setTitle(@Nullable String title)	Sets the page title.
void	setUseUnderline(boolean useUnderline)	Sets whether underlines in the page title indicate mnemonics.
void	setVisible(boolean visible)	Sets whether page is visible in its AdwViewStack.

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

ViewStackPage

public ViewStackPage(MemorySegment address)

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

Returns:

the GType

asParent

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

getBadgeNumber

public int getBadgeNumber()

Gets the badge number for this page.

Returns:

the badge number for this page

getChild

public Widget getChild()

Gets the stack child to which this ViewStackPage belongs.

Returns:

the child to which this ViewStackPage belongs

getIconName

public String getIconName()

Gets the icon name of the page.

Returns:

the icon name of the page

getName

public String getName()

Gets the name of the page.

Returns:

the name of the page

getNeedsAttention

public boolean getNeedsAttention()

Gets whether the page requires the user attention.

Returns:

whether the page needs attention

getTitle

public String getTitle()

Gets the page title.

Returns:

the page title

getUseUnderline

public boolean getUseUnderline()

Gets whether underlines in the page title indicate mnemonics.

Returns:

whether underlines in the page title indicate mnemonics

getVisible

public boolean getVisible()

Gets whether this ViewStackPage is visible in its AdwViewStack.

This is independent from the Gtk.Widget:visible property of its widget.

Returns:

whether this ViewStackPage is visible

setBadgeNumber

public void setBadgeNumber(int badgeNumber)

Sets the badge number for this page.

ViewSwitcher can display it as a badge next to the page icon. It is commonly used to display a number of unread items within the page.

It can be used together with ViewStack{age}:needs-attention.

Parameters:

badgeNumber - the new value to set

setIconName

public void setIconName(@Nullable
 @Nullable String iconName)

Sets the icon name of the page.

Parameters:

iconName - the icon name

setName

public void setName(@Nullable
 @Nullable String name)

Sets the name of the page.

Parameters:

name - the page name

setNeedsAttention

public void setNeedsAttention(boolean needsAttention)

Sets whether the page requires the user attention.

ViewSwitcher will display it as a dot next to the page icon.

Parameters:

needsAttention - the new value to set

setTitle

public void setTitle(@Nullable
 @Nullable String title)

Sets the page title.

Parameters:

title - the page title

setUseUnderline

public void setUseUnderline(boolean useUnderline)

Sets whether underlines in the page title indicate mnemonics.

Parameters:

useUnderline - the new value to set

setVisible

public void setVisible(boolean visible)

Sets whether page is visible in its AdwViewStack.

This is independent from the Gtk.Widget:visible property of ViewStackPage:child.

Parameters:

visible - whether this ViewStackPage is visible

builder

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

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