Package org.gnome.gtk

Class EditableLabel

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.EditableLabel

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Editable, Proxy

@Generated("io.github.jwharm.JavaGI")
public class EditableLabel
extends Widget
implements Accessible, Buildable, ConstraintTarget, Editable

Allows users to edit the displayed text by switching to an “edit mode”.

GtkEditableLabel does not have API of its own, but it implements the Editable interface.

The default bindings for activating the edit mode is to click or press the Enter key. The default bindings for leaving the edit mode are the Enter key (to save the results) or the Escape key (to cancel the editing).

Shortcuts and Gestures
GtkEditableLabel supports the following keyboard shortcuts:

• Enter starts editing.
• Escape stops editing.

Actions
GtkEditableLabel defines a set of built-in actions:

• editing.starts switches the widget into editing mode.
• editing.stop switches the widget out of editing mode.

CSS nodes

 editablelabel[.editing]
 ╰── stack
     ├── label
     ╰── text
 

GtkEditableLabel has a main node with the name editablelabel. When the entry is in editing mode, it gets the .editing style class.

For all the subnodes added to the text node in various situations, see Text.

Nested Class Summary

Nested Classes

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

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

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Editable

Editable.ChangedCallback, Editable.DeleteTextCallback, Editable.Editable$Impl, Editable.EditableInterface, Editable.InsertTextCallback

Constructor Summary

Constructors

Constructor	Description
EditableLabel()	Creates a new EditableLabel.
EditableLabel(MemorySegment address)	Create a EditableLabel proxy instance for the provided memory address.
EditableLabel(String str)	Creates a new GtkEditableLabel widget.

Method Summary

Modifier and Type	Method	Description
protected EditableLabel	asParent()	Returns this instance as if it were its parent type.
static EditableLabel.Builder<? extends EditableLabel.Builder>	builder()	A EditableLabel.Builder object constructs a EditableLabel with the specified properties.
boolean	getEditing()	Returns whether the label is currently in “editing mode”.
static @Nullable Type	getType()	Get the GType of the EditableLabel class
void	startEditing()	Switches the label into “editing mode”.
void	stopEditing(boolean commit)	Switches the label out of “editing mode”.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Editable

delegateGetAccessiblePlatformState, deleteSelection, deleteText, emitChanged, emitDeleteText, emitInsertText, finishDelegate, getAlignment, getChars, getDelegate, getEditable, getEnableUndo, getMaxWidthChars, getPosition, getSelectionBounds, getText, getWidthChars, initDelegate, insertText, onChanged, onDeleteText, onInsertText, selectRegion, setAlignment, setEditable, setEnableUndo, setMaxWidthChars, setPosition, setText, setWidthChars

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

EditableLabel

public EditableLabel(MemorySegment address)

Create a EditableLabel proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EditableLabel

public EditableLabel(String str)

Creates a new GtkEditableLabel widget.

Parameters:

str - the text for the label

EditableLabel

public EditableLabel()

Creates a new EditableLabel.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EditableLabel class

Returns:

the GType

asParent

protected EditableLabel 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 Widget

getEditing

public boolean getEditing()

Returns whether the label is currently in “editing mode”.

Returns:

true if this EditableLabel is currently in editing mode

startEditing

public void startEditing()

Switches the label into “editing mode”.

stopEditing

public void stopEditing(boolean commit)

Switches the label out of “editing mode”.

If commit is true, the resulting text is kept as the Gtk.Editable:text property value, otherwise the resulting text is discarded and the label will keep its previous Gtk.Editable:text property value.

Parameters:

commit - whether to set the edited text on the label

builder

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

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

Returns:

the builder object