Package org.gnome.gtk

Class Viewport

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.Viewport

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Scrollable, Proxy

@Generated("io.github.jwharm.JavaGI")
public class Viewport
extends Widget
implements Accessible, Buildable, ConstraintTarget, Scrollable

Implements scrollability for widgets that don't support scrolling on their own.

Use GtkViewport to scroll child widgets such as GtkGrid, GtkBox, and so on.

The GtkViewport will start scrolling content only if allocated less than the child widget’s minimum size in a given orientation.

CSS nodes
GtkViewport has a single CSS node with name viewport.

Accessibility
Until GTK 4.10, GtkViewport used the Gtk.AccessibleRole.group role.

Starting from GTK 4.12, GtkViewport uses the Gtk.AccessibleRole.generic role.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

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

InitiallyUnowned.InitiallyUnownedClass

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.Accessible$Impl, Accessible.AccessibleInterface

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

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

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

Scrollable.Scrollable$Impl, Scrollable.ScrollableInterface

Constructor Summary

Constructors

Constructor	Description
Viewport()	Creates a new Viewport.
Viewport(MemorySegment address)	Create a Viewport proxy instance for the provided memory address.
Viewport(@Nullable Adjustment hadjustment, @Nullable Adjustment vadjustment)	Creates a new GtkViewport.

Method Summary

Modifier and Type	Method	Description
protected Viewport	asParent()	Returns this instance as if it were its parent type.
static Viewport.Builder<? extends Viewport.Builder>	builder()	A Viewport.Builder object constructs a Viewport with the specified properties.
@Nullable Widget	getChild()	Gets the child widget of viewport.
boolean	getScrollToFocus()	Gets whether the viewport is scrolling to keep the focused child in view.
static @Nullable Type	getType()	Get the GType of the Viewport class
void	scrollTo(Widget descendant, @Nullable ScrollInfo scroll)	Scrolls a descendant of the viewport into view.
void	setChild(@Nullable Widget child)	Sets the child widget of viewport.
void	setScrollToFocus(boolean scrollToFocus)	Sets whether the viewport should automatically scroll to keep the focused child in view.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.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, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.Scrollable

getBorder, getHadjustment, getHscrollPolicy, getVadjustment, getVscrollPolicy, setHadjustment, setHscrollPolicy, setVadjustment, setVscrollPolicy

Constructor Details

Viewport

public Viewport(MemorySegment address)

Create a Viewport proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Viewport

public Viewport(@Nullable Adjustment hadjustment,
 @Nullable Adjustment vadjustment)

Creates a new GtkViewport.

The new viewport uses the given adjustments, or default adjustments if none are given.

Parameters:

hadjustment - horizontal adjustment

vadjustment - vertical adjustment

Viewport

public Viewport()

Creates a new Viewport.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Viewport class

Returns:

the GType

asParent

protected Viewport 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 Widget

getChild

public @Nullable Widget getChild()

Gets the child widget of viewport.

Returns:

the child widget of this Viewport

getScrollToFocus

public boolean getScrollToFocus()

Gets whether the viewport is scrolling to keep the focused child in view.

Returns:

true if the viewport keeps the focus child scrolled to view

scrollTo

public void scrollTo(Widget descendant,
 @Nullable ScrollInfo scroll)

Scrolls a descendant of the viewport into view.

The viewport and the descendant must be visible and mapped for this function to work, otherwise no scrolling will be performed.

Parameters:

descendant - a descendant widget of the viewport

scroll - details of how to perform the scroll operation or NULL to scroll into view

Since:

4.12

setChild

public void setChild(@Nullable Widget child)

Sets the child widget of viewport.

Parameters:

child - the child widget

setScrollToFocus

public void setScrollToFocus(boolean scrollToFocus)

Sets whether the viewport should automatically scroll to keep the focused child in view.

Parameters:

scrollToFocus - whether to keep the focus widget scrolled to view

builder

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

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

Returns:

the builder object