Package org.apache.juneau.console.freemarker

Class SwitcherDef

java.lang.Object

org.apache.juneau.console.freemarker.SwitcherDef

public final class SwitcherDef
extends Object

Builder for a switcher card: one card slot that shows one of several named views, each holding one card or a strip of sections that each hold a card.

A view with a single section that has the default id and no model block serializes as a plain card; any other view serializes as sections. A switcher cannot hold another switcher. Validation runs in toCardSpec() and is shared with SwitcherCardType through validate(String, Map), so both paths report the same messages.

Example:

CardSpec c = SwitcherDef.create("revenue-sw").title("Revenue") .view("chart", "Chart", v -> v.section(ChartDef.line("revenue-chart").src("/console/store/stats/revenue").toCardSpec())) .view("data", "Data", v -> v.section("all", "All", CardSpec.of("html", "d1")).section("open", "Open", CardSpec.of("html", "d2"))) .initialView("chart") .toCardSpec();

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SwitcherDef.Section	One section of a switcher view.
static final class	SwitcherDef.View	One view of a switcher.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STYLE_SLIDER	The segmented-control style: a pill track with a sliding thumb.
static final String	STYLE_TABS	The default switcher style: a folder-tab strip joined to the display.

Method Summary

Modifier and Type	Method	Description
static SwitcherDef	create(String id)
SwitcherDef	initialView(String viewId)
SwitcherDef	style(String v)
SwitcherDef	title(String v)
CardSpec	toCardSpec()	Builds the switcher card entry.
static void	validate(String id, Map<String,?> body)	Validates a switcher body: the shape the builder emits and the page-contract JSON carries.
static void	validateStyle(String id, Object v)	Validates a switcher style token.
SwitcherDef	view(String viewId, String label, Consumer<SwitcherDef.View> config)	Adds a view.

Methods inherited from class java.lang.Object

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

Field Details

STYLE_TABS

public static final String STYLE_TABS

The default switcher style: a folder-tab strip joined to the display.

See Also:

• Constant Field Values

STYLE_SLIDER

public static final String STYLE_SLIDER

The segmented-control style: a pill track with a sliding thumb.

See Also:

• Constant Field Values

Method Details

create

public static SwitcherDef create(String id)

Parameters:

id - The card id. @return A new switcher.

title

public SwitcherDef title(String v)

Parameters:

v - The card title. @return This object.

style

public SwitcherDef style(String v)

Parameters:

v - The switcher style, STYLE_TABS (default) or STYLE_SLIDER. @return This object.

validateStyle

public static void validateStyle(String id,
 Object v)

Validates a switcher style token.

Parameters:

id - The switcher id, used in the message.

v - The style, or null for the default.

Throws:

IllegalArgumentException - If the value is neither STYLE_TABS nor STYLE_SLIDER.

initialView

public SwitcherDef initialView(String viewId)

Parameters:

viewId - The id of the view shown first when nothing else decides. @return This object.

view

public SwitcherDef view(String viewId,
 String label,
 Consumer<SwitcherDef.View> config)

Adds a view.

Parameters:

viewId - The view id, matching [A-Za-z][A-Za-z0-9_-]{0,63}.

label - The tab label.

config - Fills in the view's sections and model block.

Returns:

This object.

toCardSpec

public CardSpec toCardSpec()

Builds the switcher card entry.

Returns:

The card.

Throws:

IllegalArgumentException - If the switcher is invalid.

validate

public static void validate(String id,
 Map<String,?> body)

Validates a switcher body: the shape the builder emits and the page-contract JSON carries.

Parameters:

id - The switcher id, used in messages.

body - The body holding views and optionally initialView.

Throws:

IllegalArgumentException - On the first problem found.