Package org.apache.juneau.console.views

Class ViewTable

java.lang.Object

org.apache.juneau.console.views.ViewTable

public class ViewTable
extends Object

Public DOM/CSS contract for a data-juneau-view table.

Table authoring is FTL <@card type="datatables"> (JSON5 catalog). This type is the stable set of marker attributes and class names the runtime and consumer chrome still stamp or select: CSRF on a shell ancestor, layout hint, selection/bulk markers, row-detail template attributes, and the named overflow class. It is not a Java page-authoring factory.

See Also:

• ViewsMixin
• SelectionDef
• BulkMutateDef

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BULK_ATTR	Marker attribute stamped when a BulkMutateDef is declared; pairs with the BULK_SIDECAR_ID_PREFIX sidecar carrying the actual bulk-action list.
static final String	BULK_SIDECAR_ID_PREFIX	Prefix of the bulk-actions sidecar <script> element id: juneau-view-bulk:<viewId>.
static final String	CELL_WRAP_CLASS	Per-cell opt-out from the clip/ellipsis default: .juneau-view-table td.juneau-cell-wrap restores the pre-10.0 wrapping behavior.
static final String	CSRF_ATTR	Attribute the CSRF token is stamped into on a shell ancestor (typically <main>) so juneau-views.js can attach it to mutating requests.
static final String	DETAIL_ACTION_ATTR	Attribute carrying an ActionRef id on a write button.
static final String	DETAIL_ACTION_DESC_ATTR	Attribute on the hidden node a gated action's disabled reason is painted into, carrying that action's id.
static final String	DETAIL_ACTION_RULES_ATTR	Attribute carrying an ActionRef's row-state rules as a JSON array, in the author's declared order.
static final String	DETAIL_CONTRACT_ATTR	Attribute carrying the row-detail contract version on the row-detail template.
static final String	DETAIL_CONTROL_CLASS	CSS class on the dedicated row-expand body cell (and the DataTables column className).
static final String	DETAIL_FIELD_ATTR	Marker on a client-painted field-grid value slot (fieldGrid catalog data key).
static final String	DETAIL_FIELD_FORMAT_ATTR	Attribute carrying a FieldFormat wire token.
static final String	DETAIL_FIELD_RENDER_ATTR	Attribute carrying a field-grid render id.
static final String	DETAIL_FIELD_RENDER_HREF_ATTR	Attribute carrying a field-grid href template.
static final String	DETAIL_FIELD_RENDER_META_ATTR	Attribute carrying JSON-encoded Render.meta.
static final String	DETAIL_HEADER_ATTR	Marker on the optional detail-panel header (title + header actions).
static final String	DETAIL_ICON_ATTR	Attribute carrying the header icon registry name.
static final String	DETAIL_SAFE_ATTR	Attribute carrying a SafeAction.wire() token.
static final String	DETAIL_SECTION_ATTR	Historical section-id marker; no longer emitted (row-detail bodies are one region).
static final String	DETAIL_TEMPLATE_ATTR	Marker attribute on the row-detail <template> sibling of the view table.
static final String	DETAIL_TH_CLASS	CSS class on the dedicated row-expand header cell so the expander glyph never shares the first data column.
static final String	DETAIL_TITLE_ATTR	Marker on the header title element filled from a {field} template.
static final String	DETAIL_TITLE_FIELDS_ATTR	Comma-separated RegionDef.titleFields allowlist stamped on the row-detail <template>.
static final String	DETAIL_TITLE_TEMPLATE_ATTR	Attribute carrying the header title template (placeholders filled at expand time).
static final String	DETAIL_URL_ATTR	Attribute carrying the server-stamped expand GET path template on the row-detail template.
static final String	LAYOUT_ATTR	Full-real-estate layout hint.
static final String	LAYOUT_WIDE	The only LAYOUT_ATTR value in v1: request full horizontal real estate for the wrapper's content.
static final String	MARKER_ATTR	Marker attribute the juneau-views.js runtime looks for to auto-initialize a view table.
static final String	NESTED_ATTR	Marker attribute on the nested-table wrapper <div> (value "1").
static final String	NESTED_CONTRACT_ATTR	Attribute carrying the nested-table contract version on the nested-table wrapper.
static final String	NESTED_META_ATTR	Attribute on the nested VIEW_META sidecar <script>, carrying the nested view id.
static final String	NESTED_SCOPE_PARAM_ATTR	Attribute carrying the nested-table parent-scope query parameter name on the nested-table wrapper.
static final String	ROW_ID_FIELD_ATTR	Attribute carrying SelectionDef.rowIdField() — the row-data key the runtime stamps as each row's stable id.
static final String	SELECT_ALL_ATTR	Attribute carrying "1"/"0" for SelectionDef.selectAll().
static final String	SELECT_ATTR	Marker attribute stamped when a SelectionDef is declared.
static final String	SIDECAR_ID_PREFIX	Prefix of the sidecar <script> element id: juneau-view:<viewId>.
static final String	TABLE_CLASS	Class stamped on every emitted <table> — top-level and nested alike — and the anchor of the toolkit's cell-overflow contract.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

MARKER_ATTR

public static final String MARKER_ATTR

Marker attribute the juneau-views.js runtime looks for to auto-initialize a view table.

See Also:

• Constant Field Values

SIDECAR_ID_PREFIX

public static final String SIDECAR_ID_PREFIX

Prefix of the sidecar <script> element id: juneau-view:<viewId>.

See Also:

• Constant Field Values

TABLE_CLASS

public static final String TABLE_CLASS

Class stamped on every emitted <table> — top-level and nested alike — and the anchor of the toolkit's cell-overflow contract.

juneau-views.css clips cell content through the named selector .juneau-view-table td rather than a global unnamed td rule, so the contract reaches only tables this toolkit produced and never app markup the toolkit does not own. See CELL_WRAP_CLASS for the opt-out.

See Also:

• Constant Field Values

CELL_WRAP_CLASS

public static final String CELL_WRAP_CLASS

Per-cell opt-out from the clip/ellipsis default: .juneau-view-table td.juneau-cell-wrap restores the pre-10.0 wrapping behavior.

The named renderers whose output is a chip / bar / link rather than prose (progress, pill, tag, linked) stamp this themselves through their class facet; an author who wants a wrapping prose column stamps it through that column's own class.

See Also:

• Constant Field Values

CSRF_ATTR

public static final String CSRF_ATTR

Attribute the CSRF token is stamped into on a shell ancestor (typically <main>) so juneau-views.js can attach it to mutating requests.

On an allowed request the LoopbackBoundaryFilter publishes the process's CSRF token under LoopbackBoundaryFilter.TOKEN_ATTRIBUTE; the host copies it here. The runtime fails closed when this attribute is absent, empty, or whitespace: it visibly refuses to issue any row-action request rather than sending one the server would 403.

See Also:

• Constant Field Values

SELECT_ATTR

public static final String SELECT_ATTR

Marker attribute stamped when a SelectionDef is declared. Pure DOM signaling — never part of the VIEW_META wire contract; see SelectionDef's class javadoc.

See Also:

• Constant Field Values

ROW_ID_FIELD_ATTR

public static final String ROW_ID_FIELD_ATTR

Attribute carrying SelectionDef.rowIdField() — the row-data key the runtime stamps as each row's stable id.

See Also:

• Constant Field Values

SELECT_ALL_ATTR

public static final String SELECT_ALL_ATTR

Attribute carrying "1"/"0" for SelectionDef.selectAll().

See Also:

• Constant Field Values

BULK_ATTR

public static final String BULK_ATTR

Marker attribute stamped when a BulkMutateDef is declared; pairs with the BULK_SIDECAR_ID_PREFIX sidecar carrying the actual bulk-action list.

See Also:

• Constant Field Values

BULK_SIDECAR_ID_PREFIX

public static final String BULK_SIDECAR_ID_PREFIX

Prefix of the bulk-actions sidecar <script> element id: juneau-view-bulk:<viewId>.

See Also:

• Constant Field Values

LAYOUT_ATTR

public static final String LAYOUT_ATTR

Full-real-estate layout hint. A first-class public data-juneau-* convention: consumer chrome (the console chrome.css full-bleed :has rules) can widen the enclosing card/main out of its default centered max-width.

See Also:

• Constant Field Values

LAYOUT_WIDE

public static final String LAYOUT_WIDE

The only LAYOUT_ATTR value in v1: request full horizontal real estate for the wrapper's content.

See Also:

• Constant Field Values

DETAIL_TH_CLASS

public static final String DETAIL_TH_CLASS

CSS class on the dedicated row-expand header cell so the expander glyph never shares the first data column.

See Also:

• Constant Field Values

DETAIL_CONTROL_CLASS

public static final String DETAIL_CONTROL_CLASS

CSS class on the dedicated row-expand body cell (and the DataTables column className).

See Also:

• Constant Field Values

DETAIL_TEMPLATE_ATTR

public static final String DETAIL_TEMPLATE_ATTR

Marker attribute on the row-detail <template> sibling of the view table.

See Also:

• Constant Field Values

DETAIL_CONTRACT_ATTR

public static final String DETAIL_CONTRACT_ATTR

Attribute carrying the row-detail contract version on the row-detail template.

See Also:

• Constant Field Values

DETAIL_URL_ATTR

public static final String DETAIL_URL_ATTR

Attribute carrying the server-stamped expand GET path template on the row-detail template.

See Also:

• Constant Field Values

DETAIL_SECTION_ATTR

public static final String DETAIL_SECTION_ATTR

Historical section-id marker; no longer emitted (row-detail bodies are one region).

See Also:

• Constant Field Values

DETAIL_FIELD_ATTR

public static final String DETAIL_FIELD_ATTR

Marker on a client-painted field-grid value slot (fieldGrid catalog data key).

See Also:

• Constant Field Values

DETAIL_HEADER_ATTR

public static final String DETAIL_HEADER_ATTR

Marker on the optional detail-panel header (title + header actions).

See Also:

• Constant Field Values

DETAIL_TITLE_ATTR

public static final String DETAIL_TITLE_ATTR

Marker on the header title element filled from a {field} template.

See Also:

• Constant Field Values

DETAIL_TITLE_TEMPLATE_ATTR

public static final String DETAIL_TITLE_TEMPLATE_ATTR

Attribute carrying the header title template (placeholders filled at expand time).

See Also:

• Constant Field Values

DETAIL_TITLE_FIELDS_ATTR

public static final String DETAIL_TITLE_FIELDS_ATTR

Comma-separated RegionDef.titleFields allowlist stamped on the row-detail <template>. Copied onto the cloned panel at expand time; paintDetailTitleSlot substitutes only these keys.

See Also:

• Constant Field Values

DETAIL_ICON_ATTR

public static final String DETAIL_ICON_ATTR

Attribute carrying the header icon registry name.

See Also:

• Constant Field Values

DETAIL_FIELD_FORMAT_ATTR

public static final String DETAIL_FIELD_FORMAT_ATTR

Attribute carrying a FieldFormat wire token. Omitted for FieldFormat.TEXT (the default).

See Also:

• Constant Field Values

DETAIL_FIELD_RENDER_ATTR

public static final String DETAIL_FIELD_RENDER_ATTR

Attribute carrying a field-grid render id. Omitted when render is unset.

See Also:

• Constant Field Values

DETAIL_FIELD_RENDER_META_ATTR

public static final String DETAIL_FIELD_RENDER_META_ATTR

Attribute carrying JSON-encoded Render.meta. Omitted when meta is null or empty.

See Also:

• Constant Field Values

DETAIL_FIELD_RENDER_HREF_ATTR

public static final String DETAIL_FIELD_RENDER_HREF_ATTR

Attribute carrying a field-grid href template. Omitted when href is unset.

See Also:

• Constant Field Values

DETAIL_ACTION_ATTR

public static final String DETAIL_ACTION_ATTR

Attribute carrying an ActionRef id on a write button.

See Also:

• Constant Field Values

DETAIL_SAFE_ATTR

public static final String DETAIL_SAFE_ATTR

Attribute carrying a SafeAction.wire() token.

See Also:

• Constant Field Values

DETAIL_ACTION_RULES_ATTR

public static final String DETAIL_ACTION_RULES_ATTR

Attribute carrying an ActionRef's row-state rules as a JSON array, in the author's declared order. Omitted entirely for an ungated action.

Each entry is {"field":..., "op":..., "value"?:..., "reason":...} — the same JSON-in-a-data-attribute shape DETAIL_FIELD_RENDER_META_ATTR uses. Declaration order is the array order, because the first failing rule is the one whose reason an operator sees.

See Also:

• Constant Field Values

DETAIL_ACTION_DESC_ATTR

public static final String DETAIL_ACTION_DESC_ATTR

Attribute on the hidden node a gated action's disabled reason is painted into, carrying that action's id. Emitted only alongside DETAIL_ACTION_RULES_ATTR.

The node exists because aria-describedby needs something real to point at. It carries the native HTML hidden attribute rather than a utility class, so no stylesheet rule is needed to keep it out of view and none is added. It carries no element id here either: this whole subtree is cloned per expanded row, so the runtime mints the row-unique one.

See Also:

• Constant Field Values

NESTED_ATTR

public static final String NESTED_ATTR

Marker attribute on the nested-table wrapper <div> (value "1").

Nested-table seeding inside a row-detail panel is deferred; this marker remains so a later host can skip auto-init of a nested data-juneau-view table until its pane is visible.

See Also:

• Constant Field Values

NESTED_META_ATTR

public static final String NESTED_META_ATTR

Attribute on the nested VIEW_META sidecar <script>, carrying the nested view id.

The nested sidecar carries no HTML id (a <template> clone would collide); the runtime finds it as a sibling of the nested <table> by this attribute instead.

See Also:

• Constant Field Values

NESTED_CONTRACT_ATTR

public static final String NESTED_CONTRACT_ATTR

Attribute carrying the nested-table contract version on the nested-table wrapper.

See Also:

• Constant Field Values

NESTED_SCOPE_PARAM_ATTR

public static final String NESTED_SCOPE_PARAM_ATTR

Attribute carrying the nested-table parent-scope query parameter name on the nested-table wrapper.

See Also:

• Constant Field Values