Package org.gnome.adw

Class EntryRow

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.ListBoxRow

org.gnome.adw.PreferencesRow

org.gnome.adw.EntryRow

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Editable, Proxy

Direct Known Subclasses:

PasswordEntryRow

@Generated("io.github.jwharm.JavaGI")
public class EntryRow
extends PreferencesRow
implements Accessible, Actionable, Buildable, ConstraintTarget, Editable

A ListBoxRow with an embedded text entry.

AdwEntryRow has a title that doubles as placeholder text. It shows an icon indicating that it's editable and can receive additional widgets before or after the editable part.

If EntryRow:show-apply-button is set to TRUE, AdwEntryRow can show an apply button when editing its contents. This can be useful if changing its contents can result in an expensive operation, such as network activity.

AdwEntryRow provides only minimal API and should be used with the Editable API.

See also PasswordEntryRow.

AdwEntryRow as GtkBuildable
The AdwEntryRow implementation of the Buildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a <child> element.

It also supports adding a child as a prefix widget by specifying “prefix” as the “type” attribute of a <child> element.

CSS nodes
AdwEntryRow has a single CSS node with name row and the .entry style class.

Since:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntryRow.ApplyCallback	Functional interface declaration of the ApplyCallback callback.
static class	EntryRow.Builder<B extends EntryRow.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	EntryRow.EntryActivatedCallback	Functional interface declaration of the EntryActivatedCallback callback.
static class	EntryRow.EntryRowClass

Nested classes/interfaces inherited from class org.gnome.adw.PreferencesRow

PreferencesRow.PreferencesRowClass

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

ListBoxRow.ActivateCallback, ListBoxRow.ListBoxRowClass

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.Actionable

Actionable.Actionable$Impl, Actionable.ActionableInterface

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
EntryRow()	Creates a new EntryRow.
EntryRow(MemorySegment address)	Create a EntryRow proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addPrefix(Widget widget)	Adds a prefix widget to self.
void	addSuffix(Widget widget)	Adds a suffix widget to self.
protected EntryRow	asParent()	Returns this instance as if it were its parent type.
static EntryRow.Builder<? extends EntryRow.Builder>	builder()	A EntryRow.Builder object constructs a EntryRow with the specified properties.
void	emitApply()	Emits the "apply" signal.
void	emitEntryActivated()	Emits the "entry-activated" signal.
boolean	getActivatesDefault()	Gets whether activating the embedded entry can activate the default widget.
@Nullable AttrList	getAttributes()	Gets Pango attributes applied to the text of the embedded entry.
boolean	getEnableEmojiCompletion()	Gets whether to suggest emoji replacements on self.
Set<InputHints>	getInputHints()	Gets the additional input hints of self.
InputPurpose	getInputPurpose()	Gets the input purpose of self.
int	getMaxLength()	Retrieves the maximum length of the entry.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getShowApplyButton()	Gets whether this EntryRow can show the apply button.
int	getTextLength()	Retrieves the current length of the text in self.
static @Nullable Type	getType()	Get the GType of the EntryRow class
boolean	grabFocusWithoutSelecting()	Causes this EntryRow to have keyboard focus without selecting the text.
SignalConnection<EntryRow.ApplyCallback>	onApply(EntryRow.ApplyCallback handler)	Emitted when the apply button is pressed.
SignalConnection<EntryRow.EntryActivatedCallback>	onEntryActivated(EntryRow.EntryActivatedCallback handler)	Emitted when the embedded entry is activated.
void	remove(Widget widget)	Removes a child from self.
void	setActivatesDefault(boolean activates)	Sets whether activating the embedded entry can activate the default widget.
void	setAttributes(@Nullable AttrList attributes)	Sets Pango attributes to apply to the text of the embedded entry.
void	setEnableEmojiCompletion(boolean enableEmojiCompletion)	Sets whether to suggest emoji replacements on self.
void	setInputHints(Set<InputHints> hints)	Set additional input hints for self.
void	setInputHints(InputHints... hints)	Set additional input hints for self.
void	setInputPurpose(InputPurpose purpose)	Sets the input purpose of self.
void	setMaxLength(int maxLength)	Sets the maximum length of the entry.
void	setShowApplyButton(boolean showApplyButton)	Sets whether this EntryRow can show the apply button.

Methods inherited from class org.gnome.adw.PreferencesRow

getTitle, getTitleSelectable, getUseMarkup, getUseUnderline, setTitle, setTitleSelectable, setUseMarkup, setUseUnderline

Methods inherited from class org.gnome.gtk.ListBoxRow

activate, changed, emitActivate, getActivatable, getChild, getHeader, getIndex, getSelectable, isSelected, onActivate, setActivatable, setChild, setHeader, setSelectable

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

getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionName

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

EntryRow

public EntryRow(MemorySegment address)

Create a EntryRow proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EntryRow

public EntryRow()

Creates a new EntryRow.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EntryRow class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected EntryRow 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 PreferencesRow

addPrefix

public void addPrefix(Widget widget)

Adds a prefix widget to self.

Parameters:

widget - a widget

Since:

1.2

addSuffix

public void addSuffix(Widget widget)

Adds a suffix widget to self.

Parameters:

widget - a widget

Since:

1.2

getActivatesDefault

public boolean getActivatesDefault()

Gets whether activating the embedded entry can activate the default widget.

Returns:

whether to activate the default widget

Since:

1.2

getAttributes

public @Nullable AttrList getAttributes()

Gets Pango attributes applied to the text of the embedded entry.

Returns:

the list of attributes

Since:

1.2

getEnableEmojiCompletion

public boolean getEnableEmojiCompletion()

Gets whether to suggest emoji replacements on self.

Returns:

whether or not emoji completion is enabled

Since:

1.2

getInputHints

public Set<InputHints> getInputHints()

Gets the additional input hints of self.

Returns:

The input hints

Since:

1.2

getInputPurpose

public InputPurpose getInputPurpose()

Gets the input purpose of self.

Returns:

the input purpose

Since:

1.2

getMaxLength

public int getMaxLength()

Retrieves the maximum length of the entry.

Returns:

The maximum length of the entry.

Since:

1.6

getShowApplyButton

public boolean getShowApplyButton()

Gets whether this EntryRow can show the apply button.

Returns:

whether to show the apply button

Since:

1.2

getTextLength

public int getTextLength()

Retrieves the current length of the text in self.

Returns:

The current number of characters in self, or 0 if there are none.

Since:

1.5

grabFocusWithoutSelecting

public boolean grabFocusWithoutSelecting()

Causes this EntryRow to have keyboard focus without selecting the text.

See Text.grabFocusWithoutSelecting() for more information.

Returns:

whether the focus is now inside this EntryRow

Since:

1.3

remove

public void remove(Widget widget)

Removes a child from self.

Parameters:

widget - the child to be removed

Since:

1.2

setActivatesDefault

public void setActivatesDefault(boolean activates)

Sets whether activating the embedded entry can activate the default widget.

Parameters:

activates - whether to activate the default widget

Since:

1.2

setAttributes

public void setAttributes(@Nullable AttrList attributes)

Sets Pango attributes to apply to the text of the embedded entry.

The Pango.Attribute's start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.

Parameters:

attributes - a list of attributes

Since:

1.2

setEnableEmojiCompletion

public void setEnableEmojiCompletion(boolean enableEmojiCompletion)

Sets whether to suggest emoji replacements on self.

Emoji replacement is done with :-delimited names, like :heart:.

Parameters:

enableEmojiCompletion - Whether emoji completion should be enabled or not

Since:

1.2

setInputHints

public void setInputHints(Set<InputHints> hints)

Set additional input hints for self.

Input hints allow input methods to fine-tune their behavior.

See also: AdwEntryRow:input-purpose

Parameters:

hints - the hints

Since:

1.2

setInputHints

public void setInputHints(InputHints... hints)

Set additional input hints for self.

Input hints allow input methods to fine-tune their behavior.

See also: AdwEntryRow:input-purpose

Parameters:

hints - the hints

Since:

1.2

setInputPurpose

public void setInputPurpose(InputPurpose purpose)

Sets the input purpose of self.

The input purpose can be used by input methods to adjust their behavior.

Parameters:

purpose - the purpose

Since:

1.2

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum length of the entry.

Parameters:

maxLength - maximum length of the entry

Since:

1.6

setShowApplyButton

public void setShowApplyButton(boolean showApplyButton)

Sets whether this EntryRow can show the apply button.

When set to TRUE, typing text in the entry will reveal an apply button. Clicking it or pressing the Enter key will hide the button and emit the EntryRow::apply signal.

This is useful if changing the entry contents can trigger an expensive operation, e.g. network activity, to avoid triggering it after typing every character.

Parameters:

showApplyButton - whether to show the apply button

Since:

1.2

onApply

public SignalConnection<EntryRow.ApplyCallback> onApply(EntryRow.ApplyCallback handler)

Emitted when the apply button is pressed.

See EntryRow:show-apply-button.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.2

See Also:

• EntryRow.ApplyCallback.run()

emitApply

public void emitApply()

Emits the "apply" signal. See onApply(org.gnome.adw.EntryRow.ApplyCallback).

onEntryActivated

public SignalConnection<EntryRow.EntryActivatedCallback> onEntryActivated(EntryRow.EntryActivatedCallback handler)

Emitted when the embedded entry is activated.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.2

See Also:

• EntryRow.EntryActivatedCallback.run()

emitEntryActivated

public void emitEntryActivated()

Emits the "entry-activated" signal. See onEntryActivated(org.gnome.adw.EntryRow.EntryActivatedCallback).

builder

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

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

Returns:

the builder object