Package su.onno.ui

Class InputSpec

java.lang.Object

su.onno.ui.InputSpec

public final class InputSpec
extends Object

Declares custom input fields for an entity's list toolbar, from EntityView.inputs(InputSpec), and the fields of an action-form modal (ActionSpec.ActionBuilder.form).

An input sits in the toolbar next to the custom action buttons. It doesn't filter the list on its own — instead its current value is handed to the ActionSpec handlers via ActionContext.input(String) when a button is clicked. So you might add an "As of" date and a "Reason" text field, then a "Generate report" button whose handler reads both.

 public void inputs(InputSpec in) {
     in.input("asOf").label("As of").type(InputType.DATE);
     in.input("currency").label("Currency").type(InputType.SELECT).options("USD", "EUR").value("USD");
     in.input("reason").label("Reason").type(InputType.TEXT).placeholder("optional");
 }
 

Inside an action form (not a toolbar), an input may also be a repeatable row group — a small tabular grid the user adds/removes rows in, each row a set of typed columns (a transient analogue of a document @TabularSection). The handler reads the collected rows via ActionContext.inputRows(String):

 a.action("receive").label("Receive shipment").scope(ActionScope.TOOLBAR)
  .form(f -> f
      .input("note").label("Note")
      .group("lines", g -> g.label("Lines").required()
          .column("product", c -> c.label("Product").required())
          .column("qty", c -> c.label("Qty").type(InputType.NUMBER).required())))
  .handler(ctx -> {
      for (var row : ctx.inputRows("lines")) receive(row.get("product"), row.get("qty"));
      return ActionResult.refresh(ActionToast.success("Received"));
  });
 

Groups are an action-form feature only; a list toolbar renders scalar inputs and ignores any declared groups. In the modal, scalar fields render first, then the row groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	InputSpec.ActionFormDialog	Presentation metadata for an action-form dialog.
static final class	InputSpec.GroupBuilder	Fluent builder for a repeatable row group.
static final class	InputSpec.InputBuilder	Fluent builder for one input; setters may be called in any order.
static final record	InputSpec.InputField	A resolved toolbar (or action-form) input field.
static final record	InputSpec.InputGroup	A resolved action-form row group: a repeatable row of columns.

Constructor Summary

Constructors

Constructor	Description
InputSpec()

Method Summary

Modifier and Type	Method	Description
InputSpec	cancelLabel(String cancelLabel)
InputSpec	description(String description)	Supporting copy shown beneath the action-form dialog title.
InputSpec	group(String key, Consumer<InputSpec.GroupBuilder> body)	Declare a repeatable row group (action forms only) with the given unique key — the modal renders an add/remove grid of the columns configured in body, and the handler reads the rows via ActionContext.inputRows(String).
List<InputSpec.InputGroup>	groups()	The declared row groups (action forms only), in declaration order.
InputSpec	icon(String icon)
InputSpec.InputBuilder	input(String key)	Start declaring an input with the given unique key (how the handler reads its value).
List<InputSpec.InputField>	inputs()
InputSpec	size(DialogSize size)
InputSpec	submitLabel(String submitLabel)
InputSpec	title(String title)	Action-form dialog title.
InputSpec	tone(ActionSeverity tone)

Methods inherited from class java.lang.Object

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

Constructor Details

InputSpec

public InputSpec()

Method Details

title

public InputSpec title(String title)

Action-form dialog title. Has no effect when this spec is used for list-toolbar inputs.

description

public InputSpec description(String description)

Supporting copy shown beneath the action-form dialog title.

submitLabel

public InputSpec submitLabel(String submitLabel)

cancelLabel

public InputSpec cancelLabel(String cancelLabel)

icon

public InputSpec icon(String icon)

tone

public InputSpec tone(ActionSeverity tone)

size

public InputSpec size(DialogSize size)

input

public InputSpec.InputBuilder input(String key)

Start declaring an input with the given unique key (how the handler reads its value).

group

public InputSpec group(String key,
 Consumer<InputSpec.GroupBuilder> body)

Declare a repeatable row group (action forms only) with the given unique key — the modal renders an add/remove grid of the columns configured in body, and the handler reads the rows via ActionContext.inputRows(String). Ignored by a list toolbar, which has no grid widget.

inputs

public List<InputSpec.InputField> inputs()

groups

public List<InputSpec.InputGroup> groups()

The declared row groups (action forms only), in declaration order.