Package org.apache.juneau.console.freemarker

package org.apache.juneau.console.freemarker

FreeMarker-only delivery of the admin-console chrome: the reserved-classpath base.ftlh template, the <@tag> macro, and ConsoleFreemarkerMixin (registers a reserved-path ClassTemplateLoader on top of the host's own FreemarkerMixin configuration).

Depends on juneau-console + juneau-rest-server-view-freemarker only — never juneau-console-datatables. A consumer who wants only chrome pulls this module and does not drag in DataTables.

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.console	Engine-agnostic themeable admin-console chrome: Theme, the stock theme stylesheets, the bundled chrome.css asset, and ConsoleChromeMixin.

Class	Description
Annotations	The built-in annotations decorator: ECharts markPoint presets (max, min, average) on every series, or explicit points on a carrier series juneau-annotations-<n>.
AssetUrlMethodModel	The assetUrl(path) FreeMarker method: appends ?v=<crc32> of an adopter's own bundled static asset to its URL path, so a browser cannot keep a stale copy after a deploy.
BadgeDirectiveModel	The <@badge> FreeMarker twin of PageSpec.badge(BadgeDef): every scalar or enum BadgeDef field is a plain attribute (the label templates as labelOne, labelOther and labelMine, the scope as scopeParam and scopeBy, the state filter as stateFilterColumn).
Bands	The built-in bands decorator: shaded x ranges from a list, a same-origin src, a data: topic, or the gaps in the first series (Bands.gaps()).
BridgeDirectiveModel	<@bridge id transport session downstream upstream? maxAttempts?/>: declares a server bridge in the contract's bridges list.
CardDirectiveModel	The <@card> FreeMarker directive: adds one entry to the page contract's cards[].
CardSection	A rail section holding one ordinary card.
CardSpec	Type-agnostic card entry in the page contract: id, type, optional src, title, template, plus a type-specific body map.
ChartCardType	The built-in chart card type: a JSON5 body naming a helper, a legacy flat kind, or a raw ECharts option, with data from exactly one of src=, an inline data array or a source (data: topic).
ChartDef	Typed builder for a chart card.
ChoiceSection	A rail section of checkboxes over the distinct values of one dictionary column of a data source.
ConsoleDirectiveModel	The <@console> document-shell FreeMarker directive.
ConsoleFreemarkerMixin	A FreemarkerMixin that additionally makes the reserved-classpath admin-console chrome template (org/apache/juneau/console/base.ftlh) — and the <@tag> macro it defines — resolvable from any consumer template, without shadowing the consumer's own basePath-rooted template tree.
ConsoleFreemarkerMixin.Builder	Builder for ConsoleFreemarkerMixin.
ConsoleSlotDirectiveModel	The capture-only console slot directives: <@head>, <@scripts>, <@brand>, <@actions>, <@title>, <@footer>, and <@body>.
ConsoleTemplateValidator	Static lint for console FreeMarker templates.
ConsoleTemplateValidator.Finding	One lint finding.
DashboardSpec	A dashboard: a rail of filter sections beside a grid of card panels, with a status header and optional persistence.
DataSourceDef	Declares a console data source: a browser loader that fetches rows from a same-origin URL, builds a columnar frame and publishes it on the topic data:<id>, which chart cards read with ChartDef.source(...).
DataSourceDef.Aggregate	The aggregate request: a bucket unit, up to 3 groupBy dims, and the measures.
DataSourceDef.Cache	Where closed chunks are kept.
DataSourceDef.Chunking	How the window is split into requests; UTC calendar units.
DataSourceDef.Format	The built-in parser for each wire format.
DataSourceDef.Mode	How the frame is produced.
DatatablesCardType	The built-in datatables card type, registered through META-INF/services: validates the author catalog and resolves per-column search metadata, with no shape lift — the catalog stays in author shape (key/label, not VIEW_META's data/title); NS.card.liftCatalog (juneau-views.js) does the lift at mount time.
Decorator	A chart decorator entry: one element of a chart card's decorators[], run in the browser by the decorator registered under its use name (JuneauCharts.decorator).
Derived	Declares a derived data source: transforms run in the browser on each new frame of another source, published on data:<as>.
FactsDirectiveModel	The <@facts> FreeMarker twin of the <@console facts=> attribute: a JSON5 object body, merged last-wins with any other chrome-side facts.
Fn	Builds $fn markers: JSON values the chart glue replaces with a function from JuneauCharts.fn.
HasToolkitMethodModel	The jcHasToolkit(name) FreeMarker method: whether the current <@page toolkit=…> lists name.
JobLogCardType	The built-in job-log card type: a form that submits to an endpoint returning an AsyncJobRef, then streams the job's progress from AsyncJobsMixin into a log pane, with cancel and reload re-attach.
MainDirectiveModel	The <@main/> console FreeMarker directive: the positional placeholder that renders the captured page body inside exactly one <main class="jc-main">.
Markers	The built-in markers decorator: vertical mark lines at x values from a list, a same-origin src, a data: topic, or the current time.
NavigationDirectiveModel	The <@navigation> console FreeMarker directive: opens the nav tree on the PageCapture.
NavNode	One node in the console navigation tree.
NodeDirectiveModel	The recursive <@node> console FreeMarker directive: one entry in a <@navigation> tree, of any depth, or (with under=) a page-scoped addition appended under an existing chrome nav node.
PageCapture	Typed, per-render capture of one console page: theme, header, footer, nav tree, active nav, cards and slot templates, held as FreeMarker Environment custom state (see PageCapture.KEY) so every directive in the render shares one instance.
PageCapture.FooterSpec	Mutable footer fields; mirrors $defs/footer.
PageCapture.HeaderSpec	Mutable header fields; mirrors $defs/header.
PageCapture.NavAdder	A nav-tree mutation deferred until the chrome's nav tree exists.
PageDirectiveModel	The <@page> shared FreeMarker directive: capture the nested body into PageCapture, resolve the toolkit= packs, then include the consumer chrome template.
PageSpec	Java description of one console page: the active tab, toolkits, page CSS and init scripts, per-request header fields, the stock theme by name, and the page's cards (tables, html and registered custom types) and body attributes.
PersistSpec	Save and restore of a dashboard's state topics.
Rail	The rail of a dashboard: a column of Sections beside the panel grid, with a splitter.
RangeSection	A rail section of quick time-range presets, with an optional custom from/to.
SearchSection	A rail section with one text input.
Section	A section of a dashboard Rail.
Section.Custom	A section implemented in JS.
TerminalCardType	The built-in terminal card type: validates a {contractVersion:'1', terminal:{...}} body through TerminalDef and emits {terminal: ...}.
ThemeDirectiveModel	The <@theme name="…"> chrome FreeMarker directive: names the active stock theme once, in the chrome, points the chrome at that theme's shipped stylesheet, and — when a nested <@token> body is present — builds a Theme of custom overrides on top of it.
Thresholds	The built-in thresholds decorator: a horizontal mark line at a y value, on a carrier series juneau-thresholds-<n>.
TokenDirectiveModel	The <@token name="--jc-…" value="…"/> / <@token name="--jc-…" alias="var(--jc-…)"/> chrome FreeMarker directive: one custom theme-token override authored inside a <@theme> element.
ToolkitPack	One named toolkit pack: ordered CSS and JS asset paths, the packs it depends on, its ToolkitPack.Kind, and the resolver that turns each path into a URL.
ToolkitPack.Builder	Builder for ToolkitPack.
ToolkitPack.Kind	Where a pack's assets are emitted on the page.
ToolkitPackRegistry	Registry of named toolkit packs for the <@page toolkit=...> directive and for the packs cards require.
ToolkitPackRegistry.AssetUrlResolver	Resolves an asset path to an absolute, cache-busted URL against the in-flight request.
ToolkitPackRegistry.Resolved	Resolved absolute URLs, split by pack kind.
TopicDirectiveModel	<@topic name="..." retain=true|false publisher="script|server|ribbon"/>: declares a page-level custom topic in the contract's topics list.