Class ActionRow
- All Implemented Interfaces:
Accessible,Actionable,Buildable,ConstraintTarget,Proxy
ListBoxRow used to present actions.
The AdwActionRow widget can have a title, a subtitle and an icon. The row
can receive additional widgets at its end, or prefix widgets at its start.
It is convenient to present a preference and its related actions.
AdwActionRow is unactivatable by default, giving it an activatable widget
will automatically make it activatable, but unsetting it won't change the
row's activatability.
AdwActionRow as GtkBuildable
The AdwActionRow 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
AdwActionRow has a main CSS node with name row.
It contains the subnode box.header for its main horizontal box, and
box.title for the vertical box containing the title and subtitle labels.
It contains subnodes label.title and label.subtitle representing
respectively the title label and subtitle label.
Style classes
AdwActionRow can use the .property
style class to emphasize the row subtitle instead of the row title, which is
useful for displaying read-only properties.
When used together with the .monospace style class, only the subtitle
becomes monospace, not the title or any extra widgets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic interfaceFunctional interface declaration of theActivatedCallbackcallback.static classActionRow.Builder<B extends ActionRow.Builder<B>>Inner class implementing a builder pattern to construct a GObject with properties.Nested classes/interfaces inherited from class org.gnome.adw.PreferencesRow
PreferencesRow.PreferencesRowClassNested classes/interfaces inherited from class org.gnome.gtk.ListBoxRow
ListBoxRow.ActivateCallback, ListBoxRow.ListBoxRowClassNested 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.WidgetClassNested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned
InitiallyUnowned.InitiallyUnownedClassNested classes/interfaces inherited from class org.gnome.gobject.GObject
GObject.NotifyCallback, GObject.ObjectClassNested classes/interfaces inherited from interface org.gnome.gtk.Accessible
Accessible.Accessible$Impl, Accessible.AccessibleInterfaceNested classes/interfaces inherited from interface org.gnome.gtk.Actionable
Actionable.Actionable$Impl, Actionable.ActionableInterfaceNested classes/interfaces inherited from interface org.gnome.gtk.Buildable
Buildable.Buildable$Impl, Buildable.BuildableIfaceNested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget
ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new ActionRow.ActionRow(MemorySegment address) Create a ActionRow proxy instance for the provided memory address. -
Method Summary
Modifier and TypeMethodDescriptionvoidactivate()Activatesself.voidAdds a prefix widget toself.voidAdds a suffix widget toself.protected ActionRowasParent()Returns this instance as if it were its parent type.static ActionRow.Builder<? extends ActionRow.Builder> builder()AActionRow.Builderobject constructs aActionRowwith the specified properties.voidEmits the "activated" signal.@Nullable WidgetGets the widget activated when this ActionRow is activated.@Nullable StringDeprecated.static MemoryLayoutThe memory layout of the native struct.@Nullable StringGets the subtitle forself.intGets the number of lines at the end of which the subtitle label will be ellipsized.booleanGets whether the user can copy the subtitle from the labelintGets the number of lines at the end of which the title label will be ellipsized.static @Nullable TypegetType()Get the GType of the ActionRow classonActivated(ActionRow.ActivatedCallback handler) This signal is emitted after the row has been activated.voidRemoves a child fromself.voidsetActivatableWidget(@Nullable Widget widget) Sets the widget to activate when this ActionRow is activated.voidsetIconName(@Nullable String iconName) Deprecated.UseaddPrefix(org.gnome.gtk.Widget)to add an icon.voidsetSubtitle(String subtitle) Sets the subtitle forself.voidsetSubtitleLines(int subtitleLines) Sets the number of lines at the end of which the subtitle label will be ellipsized.voidsetSubtitleSelectable(boolean subtitleSelectable) Sets whether the user can copy the subtitle from the labelvoidsetTitleLines(int titleLines) Sets the number of lines at the end of which the title label will be ellipsized.Methods inherited from class org.gnome.adw.PreferencesRow
getTitle, getTitleSelectable, getUseMarkup, getUseUnderline, setTitle, setTitleSelectable, setUseMarkup, setUseUnderlineMethods inherited from class org.gnome.gtk.ListBoxRow
changed, emitActivate, getActivatable, getChild, getHeader, getIndex, getSelectable, isSelected, onActivate, setActivatable, setChild, setHeader, setSelectableMethods 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, unsetStateFlagsMethods 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, withPropertiesMethods inherited from class org.gnome.gobject.TypeInstance
callParent, callParent, cast, getPrivate, readGClass, writeGClassMethods inherited from class org.javagi.base.ProxyInstance
equals, handle, hashCodeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gnome.gtk.Accessible
announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateStateMethods inherited from interface org.gnome.gtk.Actionable
getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionNameMethods inherited from interface org.gnome.gtk.Buildable
getBuildableId
-
Constructor Details
-
ActionRow
Create a ActionRow proxy instance for the provided memory address.- Parameters:
address- the memory address of the native object
-
ActionRow
public ActionRow()Creates a new ActionRow.
-
-
Method Details
-
getType
-
getMemoryLayout
The memory layout of the native struct.- Returns:
- the memory layout
-
asParent
Returns this instance as if it were its parent type. This is mostly synonymous to the Javasuperkeyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" withsuper.methodName()doesn't work, because it invokes the overridden function pointer again. To chain up, callasParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.- Overrides:
asParentin classPreferencesRow
-
activate
-
addPrefix
-
addSuffix
-
getActivatableWidget
Gets the widget activated when this ActionRow is activated.- Returns:
- the activatable widget for this ActionRow
-
getIconName
Deprecated.UseaddPrefix(org.gnome.gtk.Widget)to add an icon.Gets the icon name forself.- Returns:
- the icon name for this ActionRow
-
getSubtitle
Gets the subtitle forself.- Returns:
- the subtitle for this ActionRow
-
getSubtitleLines
public int getSubtitleLines()Gets the number of lines at the end of which the subtitle label will be ellipsized.- Returns:
- the number of lines at the end of which the subtitle label will be ellipsized
-
getSubtitleSelectable
public boolean getSubtitleSelectable()Gets whether the user can copy the subtitle from the label- Returns:
- whether the user can copy the subtitle from the label
- Since:
- 1.3
-
getTitleLines
public int getTitleLines()Gets the number of lines at the end of which the title label will be ellipsized.- Returns:
- the number of lines at the end of which the title label will be ellipsized
-
remove
Removes a child fromself.- Parameters:
widget- the child to be removed
-
setActivatableWidget
Sets the widget to activate when this ActionRow is activated.The row can be activated either by clicking on it, calling
activate(), or via mnemonics in the title. See thePreferencesRow:use-underlineproperty to enable mnemonics.The target widget will be activated by emitting the
Gtk.Widget::mnemonic-activatesignal on it.- Parameters:
widget- the target widget
-
setIconName
Deprecated.UseaddPrefix(org.gnome.gtk.Widget)to add an icon.Sets the icon name forself.- Parameters:
iconName- the icon name
-
setSubtitle
Sets the subtitle forself.The subtitle is interpreted as Pango markup unless
PreferencesRow:use-markupis set toFALSE.- Parameters:
subtitle- the subtitle
-
setSubtitleLines
public void setSubtitleLines(int subtitleLines) Sets the number of lines at the end of which the subtitle label will be ellipsized.If the value is 0, the number of lines won't be limited.
- Parameters:
subtitleLines- the number of lines at the end of which the subtitle label will be ellipsized
-
setSubtitleSelectable
public void setSubtitleSelectable(boolean subtitleSelectable) Sets whether the user can copy the subtitle from the labelSee also
Gtk.Label:selectable.- Parameters:
subtitleSelectable-TRUEif the user can copy the subtitle from the label- Since:
- 1.3
-
setTitleLines
public void setTitleLines(int titleLines) Sets the number of lines at the end of which the title label will be ellipsized.If the value is 0, the number of lines won't be limited.
- Parameters:
titleLines- the number of lines at the end of which the title label will be ellipsized
-
onActivated
public SignalConnection<ActionRow.ActivatedCallback> onActivated(ActionRow.ActivatedCallback handler) This signal is emitted after the row has been activated.- Parameters:
handler- the signal handler- Returns:
- a signal handler ID to keep track of the signal connection
- See Also:
-
emitActivated
public void emitActivated()Emits the "activated" signal. SeeonActivated(org.gnome.adw.ActionRow.ActivatedCallback). -
builder
AActionRow.Builderobject constructs aActionRowwith the specified properties. Use the variousset...()methods to set properties, and finish construction withActionRow.Builder.build().- Returns:
- the builder object
-
addPrefix(org.gnome.gtk.Widget)to add an icon.