Package su.onno.ui.divkit

Class SurfaceDivBuilder

java.lang.Object

su.onno.ui.divkit.SurfaceDivBuilder

public final class SurfaceDivBuilder
extends Object

Builds the per-surface DivKit content (catalog/document lists, document detail, register report) from the resolved metadata view + data rows. Returns a bare content div — DivKitController wraps it in the app shell. Composed only from native DivKit primitives so it renders on every official SDK with no custom code, keeping a future Flutter client cheap.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SurfaceDivBuilder.HeaderAction	form (may be empty): an action-form dialog's field descriptors — the client collects them in a modal before POSTing the action (see ActionSpec.ActionBuilder#form).

Method Summary

Modifier and Type	Method	Description
static List<Map<String,Object>>	actionItems(List<SurfaceDivBuilder.HeaderAction> items)	SurfaceDivBuilder.HeaderActions as the plain-JSON items the action-cluster island consumes (label / icon / url / tone / placement + optional form).
static Map<String,Object>	catalogDetail(Map<String,Object> meta, Map<String,Object> row, Map<String,List<Map<String,Object>>> relatedRows, List<SurfaceDivBuilder.HeaderAction> actions, Palette p)	Back-compat overload rendering the English chrome defaults (used by unit tests).
static Map<String,Object>	catalogDetail(Map<String,Object> meta, Map<String,Object> row, Map<String,List<Map<String,Object>>> relatedRows, List<SurfaceDivBuilder.HeaderAction> actions, Palette p, UiMessages msg)
static Map<String,Object>	catalogList(ResolvedListView view, List<Map<String,Object>> rows, String routeName, String newUrl, Palette p)
static List<Map<String,Object>>	catalogRows(ResolvedListView view, List<Map<String,Object>> rows, String routeName, Palette p)	The rows stack as a div-patch of onno-rows — a single replacement node re-carrying that id (see rowsPatch(java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.util.List<su.onno.ui.divkit.Components.Row>, su.onno.ui.divkit.Palette)).
static Map<String,Object>	documentDetail(Map<String,Object> meta, Map<String,Object> row, List<SurfaceDivBuilder.HeaderAction> actions, Palette p)	Back-compat overload for surfaces with no related-list panels (e.g.
static Map<String,Object>	documentDetail(Map<String,Object> meta, Map<String,Object> row, Map<String,List<Map<String,Object>>> relatedRows, List<SurfaceDivBuilder.HeaderAction> actions, Palette p)	Back-compat overload rendering the English chrome defaults (used by unit tests).
static Map<String,Object>	documentDetail(Map<String,Object> meta, Map<String,Object> row, Map<String,List<Map<String,Object>>> relatedRows, List<SurfaceDivBuilder.HeaderAction> actions, Palette p, UiMessages msg)	A document's detail surface: header (+ posting/record actions), a card of its visible system columns and attributes, then a table per tabular section and finally a read-only table per related-list panel.
static Map<String,Object>	documentList(ResolvedListView view, List<Map<String,Object>> rows, String routeName, String newUrl, Palette p)
static List<Map<String,Object>>	documentRows(ResolvedListView view, List<Map<String,Object>> rows, String routeName, Palette p)	The rows stack as a div-patch of onno-rows — a single replacement node re-carrying that id (see rowsPatch(java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.util.List<su.onno.ui.divkit.Components.Row>, su.onno.ui.divkit.Palette)).
static Map<String,Object>	entityForm(Map<String,Object> descriptor)	Emits the create/edit form as the portable onno-form custom component: a div-custom carrying a plain-JSON form descriptor (field metadata + the record's initial values + submit target).
static Map<String,Object>	listDescriptor(ResolvedListView view, String kind, String name, String newUrl, boolean canWrite, List<Map<String,Object>> actions, List<Map<String,Object>> inputs)	The onno-list descriptor (columns, sort, searchability, routes, actions, inputs) that the React island consumes — without the surface wrapping, so it can be embedded inside a page as an onno-list div-custom block (see PageBuilder.list).
static Map<String,Object>	listDescriptor(ResolvedListView view, String kind, String name, String newUrl, boolean canWrite, List<Map<String,Object>> actions, List<Map<String,Object>> inputs, boolean dynamicActions)
static Map<String,Object>	listSurface(ResolvedListView view, String kind, String name, String newUrl, boolean canWrite, List<Map<String,Object>> actions, List<Map<String,Object>> inputs)	A list surface as the onno-list React island: a single custom block carrying a descriptor (columns, sort, searchability, the open-route + New url).
static Map<String,Object>	listSurface(ResolvedListView view, String kind, String name, String newUrl, boolean canWrite, List<Map<String,Object>> actions, List<Map<String,Object>> inputs, boolean dynamicActions)
static Map<String,Object>	registerSurface(Map<String,Object> meta, String name, Palette p, UiMessages msg)	The register surface as an onno-register custom block: one or more named, paginated list views fed page-by-page from /api/list/registers/....
static Map<String,Object>	withComments(Map<String,Object> content, String kind, String name, String id)	Append the comments thread panel to a built record surface.

Methods inherited from class java.lang.Object

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

Method Details

listSurface

public static Map<String,Object> listSurface(ResolvedListView view,
 String kind,
 String name,
 String newUrl,
 boolean canWrite,
 List<Map<String,Object>> actions,
 List<Map<String,Object>> inputs)

A list surface as the onno-list React island: a single custom block carrying a descriptor (columns, sort, searchability, the open-route + New url). The island fetches pages from /api/list/... and virtualizes them, so a 10k-row entity never ships whole.

listSurface

public static Map<String,Object> listSurface(ResolvedListView view,
 String kind,
 String name,
 String newUrl,
 boolean canWrite,
 List<Map<String,Object>> actions,
 List<Map<String,Object>> inputs,
 boolean dynamicActions)

listDescriptor

public static Map<String,Object> listDescriptor(ResolvedListView view,
 String kind,
 String name,
 String newUrl,
 boolean canWrite,
 List<Map<String,Object>> actions,
 List<Map<String,Object>> inputs)

The onno-list descriptor (columns, sort, searchability, routes, actions, inputs) that the React island consumes — without the surface wrapping, so it can be embedded inside a page as an onno-list div-custom block (see PageBuilder.list).

listDescriptor

public static Map<String,Object> listDescriptor(ResolvedListView view,
 String kind,
 String name,
 String newUrl,
 boolean canWrite,
 List<Map<String,Object>> actions,
 List<Map<String,Object>> inputs,
 boolean dynamicActions)

catalogList

public static Map<String,Object> catalogList(ResolvedListView view,
 List<Map<String,Object>> rows,
 String routeName,
 String newUrl,
 Palette p)

catalogRows

public static List<Map<String,Object>> catalogRows(ResolvedListView view,
 List<Map<String,Object>> rows,
 String routeName,
 Palette p)

The rows stack as a div-patch of onno-rows — a single replacement node re-carrying that id (see rowsPatch(java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.util.List<su.onno.ui.divkit.Components.Row>, su.onno.ui.divkit.Palette)).

documentList

public static Map<String,Object> documentList(ResolvedListView view,
 List<Map<String,Object>> rows,
 String routeName,
 String newUrl,
 Palette p)

documentRows

public static List<Map<String,Object>> documentRows(ResolvedListView view,
 List<Map<String,Object>> rows,
 String routeName,
 Palette p)

The rows stack as a div-patch of onno-rows — a single replacement node re-carrying that id (see rowsPatch(java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.util.List<su.onno.ui.divkit.Components.Row>, su.onno.ui.divkit.Palette)).

documentDetail

public static Map<String,Object> documentDetail(Map<String,Object> meta,
 Map<String,Object> row,
 List<SurfaceDivBuilder.HeaderAction> actions,
 Palette p)

Back-compat overload for surfaces with no related-list panels (e.g. unit tests).

documentDetail

public static Map<String,Object> documentDetail(Map<String,Object> meta,
 Map<String,Object> row,
 Map<String,List<Map<String,Object>>> relatedRows,
 List<SurfaceDivBuilder.HeaderAction> actions,
 Palette p)

Back-compat overload rendering the English chrome defaults (used by unit tests).

documentDetail

public static Map<String,Object> documentDetail(Map<String,Object> meta,
 Map<String,Object> row,
 Map<String,List<Map<String,Object>>> relatedRows,
 List<SurfaceDivBuilder.HeaderAction> actions,
 Palette p,
 UiMessages msg)

A document's detail surface: header (+ posting/record actions), a card of its visible system columns and attributes, then a table per tabular section and finally a read-only table per related-list panel. The related-list panels are the document-side parity with the catalog detail (see catalogDetail(java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.util.List<java.util.Map<java.lang.String, java.lang.Object>>>, java.util.List<su.onno.ui.divkit.SurfaceDivBuilder.HeaderAction>, su.onno.ui.divkit.Palette)) — a booking can surface its guests (the reverse side of a Booking↔Client junction) without entering edit mode (see #110).

relatedRows maps each panel's name to its preloaded junction rows; a panel renders iff it is showInDetail and present in that map (the caller omits panels the user may not read). Empty map → no panels.

catalogDetail

public static Map<String,Object> catalogDetail(Map<String,Object> meta,
 Map<String,Object> row,
 Map<String,List<Map<String,Object>>> relatedRows,
 List<SurfaceDivBuilder.HeaderAction> actions,
 Palette p)

Back-compat overload rendering the English chrome defaults (used by unit tests).

catalogDetail

public static Map<String,Object> catalogDetail(Map<String,Object> meta,
 Map<String,Object> row,
 Map<String,List<Map<String,Object>>> relatedRows,
 List<SurfaceDivBuilder.HeaderAction> actions,
 Palette p,
 UiMessages msg)

entityForm

public static Map<String,Object> entityForm(Map<String,Object> descriptor)

Emits the create/edit form as the portable onno-form custom component: a div-custom carrying a plain-JSON form descriptor (field metadata + the record's initial values + submit target). Rich controls — styled dropdowns, a calendar picker, a ref picker that can jump to the target catalog's form — need native widgets a DivKit document can't express, so this is deliberately a custom component: every client implements onno-form from the same descriptor (the web client renders it in React today; a Flutter client renders its own form later).

registerSurface

public static Map<String,Object> registerSurface(Map<String,Object> meta,
 String name,
 Palette p,
 UiMessages msg)

The register surface as an onno-register custom block: one or more named, paginated list views fed page-by-page from /api/list/registers/.... A BALANCE register carries a Balance + a Movements view; a TURNOVER register just Movements. The view switch is a plain React toggle (no DivKit tabs) — React owns which list is mounted, so switching can never blank the surface, and there's no animation. This replaces the old fully-server-rendered table: a packed register no longer streams its whole movement log into one DivKit document.

withComments

public static Map<String,Object> withComments(Map<String,Object> content,
 String kind,
 String name,
 String id)

Append the comments thread panel to a built record surface. The panel is an onno-comments div-custom carrying the entity's (kind, name, id) triple; the React bridge loads and posts the thread itself from /api/comments/.... Returns the same content map (its items replaced with an extended copy), so callers can chain it onto entityForm(java.util.Map<java.lang.String, java.lang.Object>) (the combined record surface) without that method knowing about comments. A no-op if the content has no items list (defensive).

actionItems

public static List<Map<String,Object>> actionItems(List<SurfaceDivBuilder.HeaderAction> items)

SurfaceDivBuilder.HeaderActions as the plain-JSON items the action-cluster island consumes (label / icon / url / tone / placement + optional form). Shared by the onno-actions-menu block and the entity-form descriptor's actions — the combined record surface renders the same cluster from the same shape.