Package org.apache.juneau.console.widgets

Class FormDef.Section

java.lang.Object

org.apache.juneau.console.widgets.FormDef.Section

Enclosing class:

FormDef

@BeanType(properties="id,label,fields")
public static class FormDef.Section
extends Object

One labelled group of inputs inside a sectioned form: the multi-page dialog shape.

The client paints an ordered list of these as a ribbon-format strip above the form body, one visible pane at a time. Switching sections is visibility only — nothing is refetched and nothing is re-created, which is why a value typed into one section survives a trip through another, and why an inline validation error stays attached to the control that owns it rather than to whichever section happens to be showing.

A sectioned form is not a stack of dialogs. The strip opens no layer of its own, so a sectioned dialog consumes exactly one entry of the runtime's modal-depth budget, the same as a flat one.

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
List<FormDef.Input>	fields	This section's typed inputs in display order.
String	id	The section's stable id, used as the strip tab's identity.
String	label	The visible tab label, painted with textContent.

Constructor Summary

Constructors

Constructor	Description
Section()

Method Summary

Modifier and Type	Method	Description
FormDef.Section	field(FormDef.Input value)	Adds one typed input to this section.
static FormDef.Section	of(String id, String label)	Creates an empty section (add fields).

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

The section's stable id, used as the strip tab's identity. Must not be blank, and must be unique in the form.

label

public String label

The visible tab label, painted with textContent. Must not be blank.

fields

public List<FormDef.Input> fields

This section's typed inputs in display order. Must declare at least one.

Constructor Details

Section

public Section()

Method Details

of

public static FormDef.Section of(String id,
 String label)

Creates an empty section (add fields).

Parameters:

id - The section's stable id. Must not be null or blank.

label - The visible tab label. Must not be null or blank.

Returns:

A new FormDef.Section.

Throws:

IllegalArgumentException - If id or label is null or blank.

field

public FormDef.Section field(FormDef.Input value)

Adds one typed input to this section.

Parameters:

value - The input. Must not be null.

Returns:

This object.

Throws:

IllegalArgumentException - If value is null.