Package org.gnome.gtk

Class Image.Builder<B extends Image.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gobject.InitiallyUnowned.Builder<B>

org.gnome.gtk.Widget.Builder<B>

org.gnome.gtk.Image.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>

Enclosing class:

Image

public static class Image.Builder<B extends Image.Builder<B>>
extends Widget.Builder<B>
implements Accessible.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
Image	build()	Finish building the Image object.
B	setFile(String file)	A path to the file to display.
B	setGicon(Icon gicon)	The GIcon displayed in the GtkImage.
B	setIconName(String iconName)	The name of the icon in the icon theme.
B	setIconSize(IconSize iconSize)	The symbolic size to display icons at.
B	setPaintable(Paintable paintable)	The GdkPaintable to display.
B	setPixelSize(int pixelSize)	The size in pixels to display icons at.
B	setResource(String resource)	A path to a resource file to display.
B	setUseFallback(boolean useFallback)	Whether the icon displayed in the GtkImage will use standard icon names fallback.

Methods inherited from class org.gnome.gtk.Widget.Builder

onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, setCanFocus, setCanTarget, setCssClasses, setCssName, setCursor, setFocusable, setFocusOnClick, setHalign, setHasTooltip, setHeightRequest, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setReceivesDefault, setSensitive, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidthRequest

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible.Builder

setAccessibleRole

Methods inherited from interface io.github.jwharm.javagi.gobject.BuilderInterface

addBuilderProperty, connect, connect, getArena

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public Image build()

Finish building the Image object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to Image.

Overrides:

build in class Widget.Builder<B extends Image.Builder<B>>

Returns:

a new instance of Image with the properties that were set in the Builder object.

setFile

public B setFile(String file)

A path to the file to display.

Parameters:

file - the value for the file property

Returns:

the Builder instance is returned, to allow method chaining

setGicon

public B setGicon(Icon gicon)

The GIcon displayed in the GtkImage.

For themed icons, If the icon theme is changed, the image will be updated automatically.

Parameters:

gicon - the value for the gicon property

Returns:

the Builder instance is returned, to allow method chaining

setIconName

public B setIconName(String iconName)

The name of the icon in the icon theme.

If the icon theme is changed, the image will be updated automatically.

Parameters:

iconName - the value for the icon-name property

Returns:

the Builder instance is returned, to allow method chaining

setIconSize

public B setIconSize(IconSize iconSize)

The symbolic size to display icons at.

Parameters:

iconSize - the value for the icon-size property

Returns:

the Builder instance is returned, to allow method chaining

setPaintable

public B setPaintable(Paintable paintable)

The GdkPaintable to display.

Parameters:

paintable - the value for the paintable property

Returns:

the Builder instance is returned, to allow method chaining

setPixelSize

public B setPixelSize(int pixelSize)

The size in pixels to display icons at.

If set to a value != -1, this property overrides the Gtk.Image:icon-size property for images of type GTK_IMAGE_ICON_NAME.

Parameters:

pixelSize - the value for the pixel-size property

Returns:

the Builder instance is returned, to allow method chaining

setResource

public B setResource(String resource)

A path to a resource file to display.

Parameters:

resource - the value for the resource property

Returns:

the Builder instance is returned, to allow method chaining

setUseFallback

public B setUseFallback(boolean useFallback)

Whether the icon displayed in the GtkImage will use standard icon names fallback.

The value of this property is only relevant for images of type ImageType.ICON_NAME and ImageType.GICON.

Parameters:

useFallback - the value for the use-fallback property

Returns:

the Builder instance is returned, to allow method chaining