Package com.axelor.meta.headless

Interface FormStep

All Known Implementing Classes:

FormStep.Add, FormStep.Click, FormStep.Commit, FormStep.Remove, FormStep.Run, FormStep.Save, FormStep.Set

public sealed interface FormStep
permits FormStep.Set, FormStep.Add, FormStep.Remove, FormStep.Click, FormStep.Run, FormStep.Commit, FormStep.Save

An operation on a form's record tree. Each runs the chains the form declares for it, in the context of the node it acts on.

Nodes are FormPaths; a field of a node is written after its path ( items[-1].product). The factories take paths as text.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	FormStep.Add	Adds a line: the line's defaults, its onNew in the line's context, then the seed.
static final record	FormStep.Click	Asks a button's prompt as a question, then runs its onClick.
static final record	FormStep.Commit	Commits a line into its collection: the collection's onChange, in the parent's context.
static final record	FormStep.Remove	Takes a line out of its collection; the collection's onChange runs straight away.
static final record	FormStep.Run	Runs a chain the form declares for the node — a hook, a field's onChange, a button's onClick — and nothing else.
static final record	FormStep.Save	Saves the root with its lines: commits the open lines, runs onSave, saves, reads the root back, runs onLoad.
static final record	FormStep.Set	Writes values into their nodes, in order, each followed by its field's onChange in that node's context.

Method Summary

Static Methods

Modifier and Type	Method	Description
static FormStep	add(String collection)
static FormStep	add(String collection, Map<String,Object> seed)
static FormStep	click(String button)
static FormStep	click(String node, String button)
static FormStep	commit(String line)
static FormStep	remove(String line)
static FormStep	run(String node, String chain)
static FormStep	save()
static FormStep	set(String key, Object value)
static FormStep	set(Map<String,Object> values)

Method Details

set

static FormStep set(Map<String,Object> values)

set

static FormStep set(String key,
 Object value)

add

static FormStep add(String collection,
 Map<String,Object> seed)

Parameters:

collection - the collection, after its node's path: items, items[-1].subTasks

add

static FormStep add(String collection)

remove

static FormStep remove(String line)

click

static FormStep click(String button)

click

static FormStep click(String node,
 String button)

run

static FormStep run(String node,
 String chain)

commit

static FormStep commit(String line)

save

static FormStep save()