Package org.gnome.gtk

Class BuilderListItemFactory

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ListItemFactory

org.gnome.gtk.BuilderListItemFactory

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class BuilderListItemFactory
extends ListItemFactory

Creates widgets by instantiating GtkBuilder UI templates.

The templates must extend the class that the parent widget expects. For example, a factory provided to Gtk.ListView:factory must have a template that extends ListItem.

Templates typically use Expression to obtain data from the items in the model.

Example:

  <interface>
     <template class="GtkListItem">
       <property name="child">
         <object class="GtkLabel">
           <property name="xalign">0</property>
           <binding name="label">
             <lookup name="name" type="SettingsKey">
               <lookup name="item">GtkListItem</lookup>
             </lookup>
           </binding>
         </object>
       </property>
     </template>
   </interface>
 

A common approach is to embed such templates as CDATA marked sections into a surrounding UI file. Note that if you use this approach, extracting translatable strings with xgettext will not work for strings inside the marked section.

Nested Class Summary

Nested Classes

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

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

ListItemFactory.ListItemFactoryClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
BuilderListItemFactory()	Creates a new BuilderListItemFactory.
BuilderListItemFactory(MemorySegment address)	Create a BuilderListItemFactory proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected BuilderListItemFactory	asParent()	Returns this instance as if it were its parent type.
static BuilderListItemFactory.Builder<? extends BuilderListItemFactory.Builder>	builder()	A BuilderListItemFactory.Builder object constructs a BuilderListItemFactory with the specified properties.
static ListItemFactory	fromBytes(@Nullable BuilderScope scope, byte[] bytes)	Creates a new GtkBuilderListItemFactory that instantiates widgets using bytes as the data to pass to GtkBuilder.
static ListItemFactory	fromResource(@Nullable BuilderScope scope, String resourcePath)	Creates a new GtkBuilderListItemFactory that instantiates widgets using data read from the given resourcePath to pass to GtkBuilder.
byte[]	getBytes()	Gets the data used as the GtkBuilder UI template for constructing listitems.
@Nullable String	getResource()	If the data references a resource, gets the path of that resource.
@Nullable BuilderScope	getScope()	Gets the scope used when constructing listitems.
static @Nullable Type	getType()	Get the GType of the BuilderListItemFactory class

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, 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

Constructor Details

BuilderListItemFactory

public BuilderListItemFactory(MemorySegment address)

Create a BuilderListItemFactory proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BuilderListItemFactory

public BuilderListItemFactory()

Creates a new BuilderListItemFactory.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BuilderListItemFactory class

Returns:

the GType

asParent

protected BuilderListItemFactory 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 ListItemFactory

fromBytes

public static ListItemFactory fromBytes(@Nullable BuilderScope scope,
 byte[] bytes)

Creates a new GtkBuilderListItemFactory that instantiates widgets using bytes as the data to pass to GtkBuilder.

Parameters:

scope - A scope to use when instantiating

bytes - the GBytes containing the UI definition to instantiate

Returns:

a new GtkBuilderListItemFactory

fromResource

public static ListItemFactory fromResource(@Nullable BuilderScope scope,
 String resourcePath)

Creates a new GtkBuilderListItemFactory that instantiates widgets using data read from the given resourcePath to pass to GtkBuilder.

Parameters:

scope - A scope to use when instantiating

resourcePath - valid path to a resource that contains the UI definition

Returns:

a new GtkBuilderListItemFactory

getBytes

public byte[] getBytes()

Gets the data used as the GtkBuilder UI template for constructing listitems.

Returns:

The GtkBuilder data

getResource

public @Nullable String getResource()

If the data references a resource, gets the path of that resource.

Returns:

The path to the resource

getScope

public @Nullable BuilderScope getScope()

Gets the scope used when constructing listitems.

Returns:

The scope used when constructing listitems

builder

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

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

Returns:

the builder object