Package su.onno.ui

Class ActionSpec.ActionBuilder

java.lang.Object

su.onno.ui.ActionSpec.ActionBuilder

Enclosing class:

ActionSpec

public static final class ActionSpec.ActionBuilder
extends Object

Fluent builder for one action; setters may be called in any order.

Method Summary

Modifier and Type	Method	Description
ActionSpec.ActionBuilder	color(String color)	Optional CSS color hint for compact action renderers, especially row-menu status swatches.
ActionSpec.ActionBuilder	enabledWhen(Predicate<ActionRow> enabled)	Enable this action only on records where the predicate holds — disabled (greyed) elsewhere (ActionScope.ROW/ActionScope.DETAIL actions).
ActionSpec.ActionBuilder	form(Consumer<InputSpec> form)	Collect input from the user before the handler runs: clicking the button opens a modal dialog with the fields declared here (same builder as toolbar inputs — text, textarea, date, number, select; .required() gates submit).
ActionSpec.ActionBuilder	formDefaults(Function<ActionContext,ActionSpec.FormDefaults> defaults)	Compute the form's opening values server-side each time the dialog opens — the dynamic counterpart of the static InputSpec.InputBuilder.value(String) default.
ActionSpec.ActionBuilder	handler(Function<ActionContext,ActionResult> handler)	Run arbitrary server logic when clicked.
ActionSpec.ActionBuilder	icon(String icon)	A kebab-case lucide icon name (e.g.
ActionSpec.ActionBuilder	icon(Function<ActionRow,String> icon)	Pick the icon per record (ActionScope.ROW/ActionScope.DETAIL actions) — e.g.
ActionSpec.ActionBuilder	label(String label)	Set the fixed human-facing label.
ActionSpec.ActionBuilder	label(Function<ActionRow,String> label)	Pick the label per record (ActionScope.ROW/ActionScope.DETAIL actions).
ActionSpec.ActionBuilder	logo(String logo)	An image URL or app-static path shown instead of the lucide icon(String) — e.g.
ActionSpec.ActionBuilder	menu(String submenuLabel)	Put this ActionScope.ROW action into the row's right-click context menu under a submenu with the given label, instead of rendering it as an inline row icon button.
ActionSpec.ActionBuilder	navigate(String url)	Route the client to url when clicked ({id} is filled with the record id).
ActionSpec.ActionBuilder	roles(String... roles)	Restrict this action to callers holding any of the given roles (ADMIN always passes, like entity @AccessControl).
ActionSpec.ActionBuilder	scope(ActionScope scope)
ActionSpec.ActionBuilder	visibleWhen(Predicate<ActionRow> visible)	Show this action only on records where the predicate holds (ActionScope.ROW/ActionScope.DETAIL actions).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

label

public ActionSpec.ActionBuilder label(String label)

Set the fixed human-facing label. Surfaces without a record context, including the batch menu and batch progress messages, use this value; it is also the fallback for a dynamic label(Function). If omitted, the fixed label defaults to the action key.

icon

public ActionSpec.ActionBuilder icon(String icon)

A kebab-case lucide icon name (e.g. "archive", "download").

logo

public ActionSpec.ActionBuilder logo(String logo)

An image URL or app-static path shown instead of the lucide icon(String) — e.g. a brand logo for a "Connect with X" button (.logo("https://cdn/github.svg")).

color

public ActionSpec.ActionBuilder color(String color)

Optional CSS color hint for compact action renderers, especially row-menu status swatches.

scope

public ActionSpec.ActionBuilder scope(ActionScope scope)

menu

public ActionSpec.ActionBuilder menu(String submenuLabel)

Put this ActionScope.ROW action into the row's right-click context menu under a submenu with the given label, instead of rendering it as an inline row icon button. Actions sharing a label land in the same submenu, in declaration order — e.g. one action per status under .menu("Change status"). The per-row functions (label(row -> …), visibleWhen, enabledWhen) still apply to the menu entries. Ignored on non-ROW scopes.

handler

public ActionSpec.ActionBuilder handler(Function<ActionContext,ActionResult> handler)

Run arbitrary server logic when clicked.

form

public ActionSpec.ActionBuilder form(Consumer<InputSpec> form)

Collect input from the user before the handler runs: clicking the button opens a modal dialog with the fields declared here (same builder as toolbar inputs — text, textarea, date, number, select; .required() gates submit). The submitted scalar values reach the handler as ActionContext.input(String). The form may also declare repeatable row groups (a transient tabular grid), read back via ActionContext.inputRows(String). Server actions only — a navigation action has no handler to hand the values to.

formDefaults

public ActionSpec.ActionBuilder formDefaults(Function<ActionContext,ActionSpec.FormDefaults> defaults)

Compute the form's opening values server-side each time the dialog opens — the dynamic counterpart of the static InputSpec.InputBuilder.value(String) default. The client fetches GET /api/actions/{kind}/{name}/{key}/form?id=… when the modal opens and seeds the scalar inputs from ActionSpec.FormDefaults.values() and the row groups from ActionSpec.FormDefaults.rows() (replacing the single blank row). The function receives an ActionContext carrying the surface kind/name, the record id (when opened from a row/detail; null for toolbar/page opens) and the caller — its inputs/rows are empty.

Must be read-only — it runs on a GET and may be called any number of times. It is not invoked for batch runs (no single record to compute against); a thrown exception is logged and the dialog falls back to the static defaults. Requires a form.

 a.action("startPrint").form(f -> f.group("prints", …))
  .formDefaults(ctx -> FormDefaults.ofRows("prints", freePrinters(ctx.id())))
  .handler(this::startPrint);
 

roles

public ActionSpec.ActionBuilder roles(String... roles)

Restrict this action to callers holding any of the given roles (ADMIN always passes, like entity @AccessControl). The server rejects a caller without a matching role, and page-action buttons the caller can't run are hidden from the rendered page. Unset (the default) means any caller the surface already admits — for an entity action that's the entity's write roles; for a page action, any authenticated user.

navigate

public ActionSpec.ActionBuilder navigate(String url)

Route the client to url when clicked ({id} is filled with the record id).

icon

public ActionSpec.ActionBuilder icon(Function<ActionRow,String> icon)

Pick the icon per record (ActionScope.ROW/ActionScope.DETAIL actions) — e.g. play vs pause by the record's state. Overrides the fixed icon(String) on records it resolves.

label

public ActionSpec.ActionBuilder label(Function<ActionRow,String> label)

Pick the label per record (ActionScope.ROW/ActionScope.DETAIL actions). Overrides the fixed label(String). For a server row action exposed to batch selection, also set a fixed human-facing label because batch surfaces have no single record context.

visibleWhen

public ActionSpec.ActionBuilder visibleWhen(Predicate<ActionRow> visible)

Show this action only on records where the predicate holds (ActionScope.ROW/ActionScope.DETAIL actions).

enabledWhen

public ActionSpec.ActionBuilder enabledWhen(Predicate<ActionRow> enabled)

Enable this action only on records where the predicate holds — disabled (greyed) elsewhere (ActionScope.ROW/ActionScope.DETAIL actions).