Package org.gnome.gtk

Class IMContext.Builder<B extends IMContext.Builder<B>>

java.lang.Object

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

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

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Direct Known Subclasses:

IMContextSimple.Builder, IMMulticontext.Builder, VimIMContext.Builder

Enclosing class:

IMContext

public static class IMContext.Builder<B extends IMContext.Builder<B>>
extends GObject.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
IMContext	build()	Finish building the IMContext object.
B	onCommit(IMContext.CommitCallback handler)	The ::commit signal is emitted when a complete input sequence has been entered by the user.
B	onDeleteSurrounding(IMContext.DeleteSurroundingCallback handler)	The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.
B	onPreeditChanged(IMContext.PreeditChangedCallback handler)	The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.
B	onPreeditEnd(IMContext.PreeditEndCallback handler)	The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.
B	onPreeditStart(IMContext.PreeditStartCallback handler)	The ::preedit-start signal is emitted when a new preediting sequence starts.
B	onRetrieveSurrounding(IMContext.RetrieveSurroundingCallback handler)	The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.
B	setInputHints(Set<InputHints> inputHints)	Additional hints that allow input methods to fine-tune their behaviour.
B	setInputHints(InputHints... inputHints)	Additional hints that allow input methods to fine-tune their behaviour.
B	setInputPurpose(InputPurpose inputPurpose)	The purpose of the text field that the `GtkIMContext is connected to.

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

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public IMContext build()

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

Overrides:

build in class GObject.Builder<B extends IMContext.Builder<B>>

Returns:

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

setInputHints

public B setInputHints(Set<InputHints> inputHints)

Additional hints that allow input methods to fine-tune their behaviour.

Parameters:

inputHints - the value for the input-hints property

Returns:

the Builder instance is returned, to allow method chaining

setInputPurpose

public B setInputPurpose(InputPurpose inputPurpose)

The purpose of the text field that the `GtkIMContext is connected to.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Parameters:

inputPurpose - the value for the input-purpose property

Returns:

the Builder instance is returned, to allow method chaining

setInputHints

public B setInputHints(InputHints... inputHints)

Additional hints that allow input methods to fine-tune their behaviour.

Parameters:

inputHints - the value for the input-hints property

Returns:

the Builder instance is returned, to allow method chaining

onCommit

public B onCommit(IMContext.CommitCallback handler)

The ::commit signal is emitted when a complete input sequence has been entered by the user.

If the commit comes after a preediting sequence, the ::commit signal is emitted after ::preedit-end.

This can be a single character immediately after a key press or the final result of preediting.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.CommitCallback.run(java.lang.String)

onDeleteSurrounding

public B onDeleteSurrounding(IMContext.DeleteSurroundingCallback handler)

The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.DeleteSurroundingCallback.run(int, int)

onPreeditChanged

public B onPreeditChanged(IMContext.PreeditChangedCallback handler)

The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.

It is also emitted at the end of a preedit sequence, in which case IMContext.getPreeditString(io.github.jwharm.javagi.base.Out<java.lang.String>, io.github.jwharm.javagi.base.Out<org.gnome.pango.AttrList>, io.github.jwharm.javagi.base.Out<java.lang.Integer>) returns the empty string.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.PreeditChangedCallback.run()

onPreeditEnd

public B onPreeditEnd(IMContext.PreeditEndCallback handler)

The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.PreeditEndCallback.run()

onPreeditStart

public B onPreeditStart(IMContext.PreeditStartCallback handler)

The ::preedit-start signal is emitted when a new preediting sequence starts.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.PreeditStartCallback.run()

onRetrieveSurrounding

public B onRetrieveSurrounding(IMContext.RetrieveSurroundingCallback handler)

The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.

The callback should set the input method surrounding context by calling the IMContext.setSurrounding(java.lang.String, int, int) method.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• IMContext.RetrieveSurroundingCallback.run()