Package org.gnome.gtk

Class TextBuffer.Builder<B extends TextBuffer.Builder<B>>

java.lang.Object

org.javagi.gobject.Builder<B>

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

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Direct Known Subclasses:

Buffer.Builder

Enclosing class:

TextBuffer

public static class TextBuffer.Builder<B extends TextBuffer.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
TextBuffer	build()	Finish building the TextBuffer object.
B	onApplyTag(TextBuffer.ApplyTagCallback handler)	Emitted to apply a tag to a range of text in a GtkTextBuffer.
B	onBeginUserAction(TextBuffer.BeginUserActionCallback handler)	Emitted at the beginning of a single user-visible operation on a GtkTextBuffer.
B	onChanged(TextBuffer.ChangedCallback handler)	Emitted when the content of a GtkTextBuffer has changed.
B	onDeleteRange(TextBuffer.DeleteRangeCallback handler)	Emitted to delete a range from a GtkTextBuffer.
B	onEndUserAction(TextBuffer.EndUserActionCallback handler)	Emitted at the end of a single user-visible operation on the GtkTextBuffer.
B	onInsertChildAnchor(TextBuffer.InsertChildAnchorCallback handler)	Emitted to insert a GtkTextChildAnchor in a GtkTextBuffer.
B	onInsertPaintable(TextBuffer.InsertPaintableCallback handler)	Emitted to insert a GdkPaintable in a GtkTextBuffer.
B	onInsertText(TextBuffer.InsertTextCallback handler)	Emitted to insert text in a GtkTextBuffer.
B	onMarkDeleted(TextBuffer.MarkDeletedCallback handler)	Emitted as notification after a GtkTextMark is deleted.
B	onMarkSet(TextBuffer.MarkSetCallback handler)	Emitted as notification after a GtkTextMark is set.
B	onModifiedChanged(TextBuffer.ModifiedChangedCallback handler)	Emitted when the modified bit of a GtkTextBuffer flips.
B	onPasteDone(TextBuffer.PasteDoneCallback handler)	Emitted after paste operation has been completed.
B	onRedo(TextBuffer.RedoCallback handler)	Emitted when a request has been made to redo the previously undone operation.
B	onRemoveTag(TextBuffer.RemoveTagCallback handler)	Emitted to remove all occurrences of tag from a range of text in a GtkTextBuffer.
B	onUndo(TextBuffer.UndoCallback handler)	Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.
B	setEnableUndo(boolean enableUndo)	Denotes if support for undoing and redoing changes to the buffer is allowed.
B	setTagTable(TextTagTable tagTable)	The GtkTextTagTable for the buffer.
B	setText(String text)	The text content of the buffer.

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

onNotify

Methods inherited from class org.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 TextBuffer build()

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

Overrides:

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

Returns:

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

setEnableUndo

public B setEnableUndo(boolean enableUndo)

Denotes if support for undoing and redoing changes to the buffer is allowed.

Parameters:

enableUndo - the value for the enable-undo property

Returns:

the Builder instance is returned, to allow method chaining

setTagTable

public B setTagTable(TextTagTable tagTable)

The GtkTextTagTable for the buffer.

Parameters:

tagTable - the value for the tag-table property

Returns:

the Builder instance is returned, to allow method chaining

setText

public B setText(String text)

The text content of the buffer.

Without child widgets and images, see TextBuffer.getText(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, boolean) for more information.

Parameters:

text - the value for the text property

Returns:

the Builder instance is returned, to allow method chaining

onApplyTag

public B onApplyTag(TextBuffer.ApplyTagCallback handler)

Emitted to apply a tag to a range of text in a GtkTextBuffer.

Applying actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them).

See also: TextBuffer.applyTag(org.gnome.gtk.TextTag, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter), TextBuffer.insertWithTags(org.gnome.gtk.TextIter, java.lang.String, int, org.gnome.gtk.TextTag, java.lang.Object...), TextBuffer.insertRange(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.ApplyTagCallback.run(org.gnome.gtk.TextTag, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter)

onBeginUserAction

public B onBeginUserAction(TextBuffer.BeginUserActionCallback handler)

Emitted at the beginning of a single user-visible operation on a GtkTextBuffer.

See also: TextBuffer.beginUserAction(), TextBuffer.insertInteractive(org.gnome.gtk.TextIter, java.lang.String, int, boolean), TextBuffer.insertRangeInteractive(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, boolean), TextBuffer.deleteInteractive(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, boolean), TextBuffer.backspace(org.gnome.gtk.TextIter, boolean, boolean), TextBuffer.deleteSelection(boolean, boolean).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.BeginUserActionCallback.run()

onChanged

public B onChanged(TextBuffer.ChangedCallback handler)

Emitted when the content of a GtkTextBuffer has changed.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.ChangedCallback.run()

onDeleteRange

public B onDeleteRange(TextBuffer.DeleteRangeCallback handler)

Emitted to delete a range from a GtkTextBuffer.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them). The default signal handler revalidates the start and end iters to both point to the location where text was deleted. Handlers which run after the default handler (see g_signal_connect_after()) do not have access to the deleted text.

See also: TextBuffer.delete(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.DeleteRangeCallback.run(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter)

onEndUserAction

public B onEndUserAction(TextBuffer.EndUserActionCallback handler)

Emitted at the end of a single user-visible operation on the GtkTextBuffer.

See also: TextBuffer.endUserAction(), TextBuffer.insertInteractive(org.gnome.gtk.TextIter, java.lang.String, int, boolean), TextBuffer.insertRangeInteractive(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, boolean), TextBuffer.deleteInteractive(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, boolean), TextBuffer.backspace(org.gnome.gtk.TextIter, boolean, boolean), TextBuffer.deleteSelection(boolean, boolean), TextBuffer.backspace(org.gnome.gtk.TextIter, boolean, boolean).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.EndUserActionCallback.run()

onInsertChildAnchor

public B onInsertChildAnchor(TextBuffer.InsertChildAnchorCallback handler)

Emitted to insert a GtkTextChildAnchor in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted anchor.

See also: TextBuffer.insertChildAnchor(org.gnome.gtk.TextIter, org.gnome.gtk.TextChildAnchor).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.InsertChildAnchorCallback.run(org.gnome.gtk.TextIter, org.gnome.gtk.TextChildAnchor)

onInsertPaintable

public B onInsertPaintable(TextBuffer.InsertPaintableCallback handler)

Emitted to insert a GdkPaintable in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted paintable.

See also: TextBuffer.insertPaintable(org.gnome.gtk.TextIter, org.gnome.gdk.Paintable).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.InsertPaintableCallback.run(org.gnome.gtk.TextIter, org.gnome.gdk.Paintable)

onInsertText

public B onInsertText(TextBuffer.InsertTextCallback handler)

Emitted to insert text in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to point to the end of the inserted text.

See also: TextBuffer.insert(org.gnome.gtk.TextIter, java.lang.String, int), TextBuffer.insertRange(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.InsertTextCallback.run(org.gnome.gtk.TextIter, java.lang.String, int)

onMarkDeleted

public B onMarkDeleted(TextBuffer.MarkDeletedCallback handler)

Emitted as notification after a GtkTextMark is deleted.

See also: TextBuffer.deleteMark(org.gnome.gtk.TextMark).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.MarkDeletedCallback.run(org.gnome.gtk.TextMark)

onMarkSet

public B onMarkSet(TextBuffer.MarkSetCallback handler)

Emitted as notification after a GtkTextMark is set.

See also: TextBuffer.createMark(java.lang.String, org.gnome.gtk.TextIter, boolean), TextBuffer.moveMark(org.gnome.gtk.TextMark, org.gnome.gtk.TextIter).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.MarkSetCallback.run(org.gnome.gtk.TextIter, org.gnome.gtk.TextMark)

onModifiedChanged

public B onModifiedChanged(TextBuffer.ModifiedChangedCallback handler)

Emitted when the modified bit of a GtkTextBuffer flips.

See also: TextBuffer.setModified(boolean).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.ModifiedChangedCallback.run()

onPasteDone

public B onPasteDone(TextBuffer.PasteDoneCallback handler)

Emitted after paste operation has been completed.

This is useful to properly scroll the view to the end of the pasted text. See TextBuffer.pasteClipboard(org.gnome.gdk.Clipboard, org.gnome.gtk.TextIter, boolean) for more details.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.PasteDoneCallback.run(org.gnome.gdk.Clipboard)

onRedo

public B onRedo(TextBuffer.RedoCallback handler)

Emitted when a request has been made to redo the previously undone operation.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.RedoCallback.run()

onRemoveTag

public B onRemoveTag(TextBuffer.RemoveTagCallback handler)

Emitted to remove all occurrences of tag from a range of text in a GtkTextBuffer.

Removal actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them).

See also: TextBuffer.removeTag(org.gnome.gtk.TextTag, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.RemoveTagCallback.run(org.gnome.gtk.TextTag, org.gnome.gtk.TextIter, org.gnome.gtk.TextIter)

onUndo

public B onUndo(TextBuffer.UndoCallback handler)

Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• TextBuffer.UndoCallback.run()