Package org.apache.juneau.console.widgets

package org.apache.juneau.console.widgets
Reusable widget primitives for the Juneau REST server toolkit.

This optional module holds the shared Widget marker and the bean-only definitions for the reusable calendar widget (CalendarDef, EventCategory, CalendarEvent). Table-specific types (row actions, bulk mutate) stay in juneau-console-views; this module has no dependency on views, so a widget bean can never import a views-module type. A CalendarDef carries no HTML-emitter code — pages mount an empty data-juneau-calendar marker and juneau-calendar.js hydrates it.

See Also:
Since:
10.0.0
  • Class
    Description
    ActionBarItem
    One item in an action bar: either an ActionRef (opaque id naming a write action on the enclosing view) or a SafeAction (client-only, no endpoint).
    ActionRef
    An opaque id naming a write action on the enclosing view.
    ActionRef.Emphasis
    The visual weight an ActionRef button is painted with.
    ActionRef.EnabledRule
    One row-state rule gating an ActionRef.
    Badge
    An overlay badge on a header action (a bell count, for example) or a BarBadge.
    BarBadge
    A labelled count widget in a BarSlot — the "N change pending"-style badge to the right of the subtab ribbon.
    BarSlot
    An additive trailing region beside the subtab ribbon: a small row of BarWidgets (concept #9).
    BarText
    A static contextual label widget in a BarSlot.
    BarWidget
    One widget in a BarSlot: either a BarBadge (a labelled count, e.g.
    Behavior
    How a header/menu action behaves when the user activates it.
    CalendarDef
    A reusable month-calendar definition: month/year navigation, event categories, and a display-only legend (parent concept #10).
    CalendarDef.CalendarView
    The view families; v1 ships MONTH only so an author cannot set a value that only fails at validate().
    CalendarDef.WeekStart
    The first column of the week grid.
    CalendarEvent
    A single calendar event — also the element type of the per-month event GET envelope's events.
    EventCategory
    A declared calendar event category — a legend entry and the color family its events paint with.
    EventCategory.CategoryColor
    The fixed category color families, each mapped to an existing --jc-tag-* token family.
    FormDef
    The declarative source of a row-action modal's input form (the form half of a present=dialog action).
    FormDef.Input
    A single typed form input painted client-side with createElement (never innerHTML).
    FormDef.Input.Option
    A single select option: a submit value and its visible label.
    FormDef.Section
    One labelled group of inputs inside a sectioned form: the multi-page dialog shape.
    MenuItem
    A single row in an attached header or avatar menu.
    ModalDef
    The declarative modal (dialog) a present=dialog row action opens — the payload the modal-open confirmation fetch returns.
    ModalDef.ChildAction
    One entry in a dialog's ModalDef.childActions catalog — a stacked step a type="action" input inside this dialog's form may open.
    ModalDef.Field
    A single typed confirmation field: a label and a value, painted client-side with textContent (never innerHTML).
    ModalDef.Step
    One page of a ModalDef.steps wizard: an id, an optional title and confirm-button label, and the typed display fields painted for that page.
    Op
    The comparison operator of a declarative single-field rule.
    SafeAction
    A client-only ActionBarItem with no endpoint.
    ServerValues
    A Widget-marked declaration of named server-side scalar values.
    ServerValuesRegistry
    An internal, per-render resolver for a single ServerValues declaration.
    ServerValuesValue
    An immutable named server-side scalar value declaration held by a ServerValues bean.
    StatusTone
    The one closed status-tone palette shared by every surface that paints a semantic status colour: info / success / warning / error / neutral.
    Widget
    Marker for a reusable widget primitive.
    WidgetsMixin
    The widget toolkit's serving-path mixin: the mount, asset-URL API and serving endpoints for the widget-owned browser runtime (juneau-calendar.js, juneau-calendar.css), plus the contract-version handshake constants those runtimes bake in.
    WidgetsMixin.WidgetValidationProcessor
    The serving-path Widget.validate() gate: fail-closed structural validation for any REST response content that is a Widget, giving the JSON serving path the same gate the juneau-console-views HTML emitters already give every Widget they consume.