Uses of Class
org.apache.juneau.console.freemarker.PageSpec

Packages that use PageSpec

Package	Description
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).
org.apache.juneau.petstore.console	Petstore admin console: the /console page tree.
org.apache.juneau.petstore.console.pages	Builder twins of the petstore console pages: each page's .ftlh file rebuilt with PageSpec, served when the page is requested with ?builder.

Uses of PageSpec in org.apache.juneau.console.freemarker

Methods in org.apache.juneau.console.freemarker that return PageSpec

Modifier and Type	Method	Description
PageSpec	PageSpec.attr(String key, Object value)	Adds a passthrough attribute, applied to the view this spec builds.
PageSpec	PageSpec.badge(BadgeDef def)	Adds a header badge.
PageSpec	PageSpec.bodyAttr(String name, String value)	Sets one <body> attribute.
PageSpec	PageSpec.bridge(BridgeDecl decl)	Declares a server bridge; repeatable.
PageSpec	PageSpec.card(CardSpec card)	Adds a custom-type card with no inline markup.
PageSpec	PageSpec.card(CardSpec card, String markupOrNull)	Adds a custom-type card that also takes inline markup.
static PageSpec	PageSpec.create()	Creates a new, empty spec.
PageSpec	PageSpec.csrf(String token, String headerName)	Sets the CSRF body attributes: data-juneau-csrf and, if headerName is non-blank, data-juneau-csrf-header.
PageSpec	PageSpec.css(String... urls)	Adds page CSS URLs, appending any not already present.
PageSpec	PageSpec.dashboard(DashboardSpec dashboard)	Adds the page's dashboard: a rail of filter sections beside a grid of card panels.
PageSpec	PageSpec.data(DataSourceDef def)	Declares a data source, published on data:<id>; repeatable.
PageSpec	PageSpec.data(Derived def)	Declares a derived data source, published on data:<as>; repeatable.
PageSpec	PageSpec.facts(Map<String,Object> v)	Seeds page-level facts, which visibleWhen rules test on the client.
PageSpec	PageSpec.header(String name, String value)	Adds a passthrough HTTP response header, applied to the view this spec builds.
PageSpec	PageSpec.header(Consumer<PageCapture.HeaderSpec> c)	Sets the header's subtitle and/or userMenu.
PageSpec	PageSpec.html(String id, String markup)	Adds an html card whose body is markup, with no title.
PageSpec	PageSpec.html(String id, String title, String markup)	Adds an html card whose body is markup, with a title.
PageSpec	PageSpec.html(String id, String markup, Consumer<CardSpec> card)	Adds an html card whose body is markup, letting card adjust the card (title, CSS class, and so on).
PageSpec	PageSpec.htmlSrc(String id, String title, String src)	Adds an html card whose body is fetched from src, with a title, unsanitized.
PageSpec	PageSpec.htmlSrc(String id, String title, String src, boolean sanitize)	Adds an html card whose body is fetched from src, with a title, optionally rebuilt through the views attribute-allowlist sanitizer.
PageSpec	PageSpec.init(String... urls)	Adds page init-script URLs, appending any not already present.
PageSpec	PageSpec.navUnder(String parentIdPath, PageCapture.NavAdder adder)	Queues a child to add under an existing chrome nav node, resolved once the chrome's own nav tree exists.
PageSpec	PageSpec.scheme(String name)	Pins the page's colour scheme.
PageSpec	PageSpec.schemeToggle(boolean value)	Lets the visitor override the page's colour scheme with a stored choice.
PageSpec	PageSpec.tab(String idPath)	Sets the <@page tab>-equivalent active-nav path.
PageSpec	PageSpec.table(TableSpec table)	Adds a datatables card for table, with no title.
PageSpec	PageSpec.table(TableSpec table, String title)	Adds a datatables card for table, with a title.
PageSpec	PageSpec.table(TableSpec table, Consumer<CardSpec> card)	Adds a datatables card for table, letting card adjust the card.
PageSpec	PageSpec.template(String pageTemplateName)	Sets the page template, overriding the mixin's configured chrome template.
PageSpec	PageSpec.theme(String stockName)	Selects a stock theme by name.
PageSpec	PageSpec.title(String v)	Sets the page title.
PageSpec	PageSpec.toolkit(String... names)	Adds toolkit names, appending any not already present.
PageSpec	PageSpec.topic(TopicDecl decl)	Declares a page-level custom topic; repeatable.

Uses of PageSpec in org.apache.juneau.petstore.console

Methods in org.apache.juneau.petstore.console with parameters of type PageSpec

Modifier and Type	Method	Description
static View	PetstoreConsolePage.twin(RestRequest req, PageSpec spec)	Renders a builder-twin page, marked with PetstoreConsolePage.PAGE_HEADER.

Uses of PageSpec in org.apache.juneau.petstore.console.pages

Methods in org.apache.juneau.petstore.console.pages that return PageSpec

Modifier and Type	Method	Description
static PageSpec	AboutPageBuilders.about()	About.
static PageSpec	OpsPageBuilders.audit()	P7 Audit.
static PageSpec	DevPageBuilders.cards()	Custom cards.
static PageSpec	ChangesPageBuilders.changes()	P10 Pending changes.
static PageSpec	DevPageBuilders.charts()	Charts (builder only): a line chart with markers, a threshold and a click topic, and a table whose ribbon highlights a point.
static PageSpec	DevPageBuilders.dashboard(String variant, int version)	Dashboard (builder only): a rail of every section kind over a 2-column grid of charts, bound to one CSV source.
static PageSpec	DevPageBuilders.data()	Data sources (builder only): an hourly CSV source chunked by UTC day and cached in IndexedDB, over a range the page script publishes, drawn by a line chart.
static PageSpec	DevPageBuilders.flavor(Flavor flavor)	One Rendering flavors page.
static PageSpec	OpsPageBuilders.jobs(TerminalDef groomOutput, TerminalDef groomFile)	P6 Jobs.
static PageSpec	OrdersPageBuilders.orders()	P5 Orders.
static PageSpec	PetsPageBuilders.pet(Pet pet, String tab, String activeNav, Order order, List<String> roles, String apiCsrf)	P4 one pet, on one tab.
static PageSpec	PetsPageBuilders.pets()	P2 Pets.
static PageSpec	PetsPageBuilders.petsMixed()	P2 Pets, half FTL: pets-mixed.ftlh lays out the page and places this spec's table with <@card ref="pets"/>.
static PageSpec	DevPageBuilders.secure()	Secure.
static PageSpec	PetsPageBuilders.sold()	P3 Sold.
static PageSpec	StorePageBuilders.store(StorePageBuilders.QuickStats qs)	P1 Store.
static PageSpec	DevPageBuilders.themes(String theme, boolean custom, List<String> choices)	Themes.
static PageSpec	UsersPageBuilders.users()	P11 Users.