Package org.gnome.gtk

Class Paned.Builder<B extends Paned.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.Paned.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>, Orientable.Builder<B>

Enclosing class:

Paned

public static class Paned.Builder<B extends Paned.Builder<B>>
extends Widget.Builder<B>
implements Accessible.Builder<B>, Orientable.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
Paned	build()	Finish building the Paned object.
B	onAcceptPosition(Paned.AcceptPositionCallback handler)	Emitted to accept the current position of the handle when moving it using key bindings.
B	onCancelPosition(Paned.CancelPositionCallback handler)	Emitted to cancel moving the position of the handle using key bindings.
B	onCycleChildFocus(Paned.CycleChildFocusCallback handler)	Emitted to cycle the focus between the children of the paned.
B	onCycleHandleFocus(Paned.CycleHandleFocusCallback handler)	Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.
B	onMoveHandle(Paned.MoveHandleCallback handler)	Emitted to move the handle with key bindings.
B	onToggleHandleFocus(Paned.ToggleHandleFocusCallback handler)	Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.
B	setEndChild(Widget endChild)	The second child.
B	setPosition(int position)	Position of the separator in pixels, from the left/top.
B	setPositionSet(boolean positionSet)	Whether the Gtk.Paned:position property has been set.
B	setResizeEndChild(boolean resizeEndChild)	Determines whether the second child expands and shrinks along with the paned widget.
B	setResizeStartChild(boolean resizeStartChild)	Determines whether the first child expands and shrinks along with the paned widget.
B	setShrinkEndChild(boolean shrinkEndChild)	Determines whether the second child can be made smaller than its requisition.
B	setShrinkStartChild(boolean shrinkStartChild)	Determines whether the first child can be made smaller than its requisition.
B	setStartChild(Widget startChild)	The first child.
B	setWideHandle(boolean wideHandle)	Whether the GtkPaned should provide a stronger visual separation.

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

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

setOrientation

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public Paned build()

Finish building the Paned 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 Paned.

Overrides:

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

Returns:

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

setEndChild

public B setEndChild(Widget endChild)

The second child.

Parameters:

endChild - the value for the end-child property

Returns:

the Builder instance is returned, to allow method chaining

setPosition

public B setPosition(int position)

Position of the separator in pixels, from the left/top.

Parameters:

position - the value for the position property

Returns:

the Builder instance is returned, to allow method chaining

setPositionSet

public B setPositionSet(boolean positionSet)

Whether the Gtk.Paned:position property has been set.

Parameters:

positionSet - the value for the position-set property

Returns:

the Builder instance is returned, to allow method chaining

setResizeEndChild

public B setResizeEndChild(boolean resizeEndChild)

Determines whether the second child expands and shrinks along with the paned widget.

Parameters:

resizeEndChild - the value for the resize-end-child property

Returns:

the Builder instance is returned, to allow method chaining

setResizeStartChild

public B setResizeStartChild(boolean resizeStartChild)

Determines whether the first child expands and shrinks along with the paned widget.

Parameters:

resizeStartChild - the value for the resize-start-child property

Returns:

the Builder instance is returned, to allow method chaining

setShrinkEndChild

public B setShrinkEndChild(boolean shrinkEndChild)

Determines whether the second child can be made smaller than its requisition.

Parameters:

shrinkEndChild - the value for the shrink-end-child property

Returns:

the Builder instance is returned, to allow method chaining

setShrinkStartChild

public B setShrinkStartChild(boolean shrinkStartChild)

Determines whether the first child can be made smaller than its requisition.

Parameters:

shrinkStartChild - the value for the shrink-start-child property

Returns:

the Builder instance is returned, to allow method chaining

setStartChild

public B setStartChild(Widget startChild)

The first child.

Parameters:

startChild - the value for the start-child property

Returns:

the Builder instance is returned, to allow method chaining

setWideHandle

public B setWideHandle(boolean wideHandle)

Whether the GtkPaned should provide a stronger visual separation.

For example, this could be set when a paned contains two Notebooks, whose tab rows would otherwise merge visually.

Parameters:

wideHandle - the value for the wide-handle property

Returns:

the Builder instance is returned, to allow method chaining

onAcceptPosition

public B onAcceptPosition(Paned.AcceptPositionCallback handler)

Emitted to accept the current position of the handle when moving it using key bindings.

This is a keybinding signal.

The default binding for this signal is Return or Space.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.AcceptPositionCallback.run()

onCancelPosition

public B onCancelPosition(Paned.CancelPositionCallback handler)

Emitted to cancel moving the position of the handle using key bindings.

The position of the handle will be reset to the value prior to moving it.

This is a keybinding signal.

The default binding for this signal is Escape.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.CancelPositionCallback.run()

onCycleChildFocus

public B onCycleChildFocus(Paned.CycleChildFocusCallback handler)

Emitted to cycle the focus between the children of the paned.

This is a keybinding signal.

The default binding is F6.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.CycleChildFocusCallback.run(boolean)

onCycleHandleFocus

public B onCycleHandleFocus(Paned.CycleHandleFocusCallback handler)

Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.

This is a keybinding signal.

The default binding for this signal is F8.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.CycleHandleFocusCallback.run(boolean)

onMoveHandle

public B onMoveHandle(Paned.MoveHandleCallback handler)

Emitted to move the handle with key bindings.

This is a keybinding signal.

The default bindings for this signal are Ctrl+←, ←, Ctrl+→, →, Ctrl+↑, ↑, Ctrl+↓, ↓, PgUp, PgDn, Home, End.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.MoveHandleCallback.run(org.gnome.gtk.ScrollType)

onToggleHandleFocus

public B onToggleHandleFocus(Paned.ToggleHandleFocusCallback handler)

Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.

This is a keybinding signal.

The default binding is Tab.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Paned.ToggleHandleFocusCallback.run()