DVStudioScreen class

The Studio admin surface: a navigation rail, and the section it opens.

Pages is the builder: a site overview with a thumbnail of every stored page, and — once a page is open — the editor, with the site's pages and an insert panel or layer tree on the left, the page on an artboard in the middle, and its properties on the right. Any other section is whatever the application attaches; the Pro workflow builder is one.

Inheritance

Constructors

DVStudioScreen({Key? key, DVPageStore store = const DVPageStore(), DVStudioSiteSource? site, List<DVStudioPaletteItem> palette = const <DVStudioPaletteItem>[], List<DVStudioSection> sections = const <DVStudioSection>[], List<DVStudioEditorHook> editorHooks = const <DVStudioEditorHook>[], DVStudioContent? content, Object? actor, List<String> reviewers = const <String>[], DVFlags? flags, DVAlerting? alerting, DVIncidents? incidents, DateTime clock()?, Future<DVHealthReport> statusHealth()?, Widget? account, String? selected, String? object, void onSelect(String section, String? object)?})
const

Properties

account → Widget?
Who is signed in and the control that signs them out, at the foot of the rail. Studio served by an application's backend always has one; a Studio inside the application it manages has no session of its own.
final
actor → Object?
final
alerting → DVAlerting?
The alert rule engine, which adds an Operations section: service levels and their error budgets, rule state and delivery, and analysis findings.
final
clock → DateTime Function()?
The clock the Operations section judges burn rates, ages and new timeline entries by.
final
content → DVStudioContent?
final
editorHooks → List<DVStudioEditorHook>
Attached to each editor the Pages tab opens, detached when it closes. The seam collaboration and permissions attach through.
final
flags → DVFlags?
The flag runtime, which adds a Flags section: every declared flag, its rules, who gets what, rule edits applied to this running app, and a debug-build override. Without it there is no Flags tab.
final
hashCode → int
The hash code for this object.
no setterinherited
incidents → DVIncidents?
The incidents the Operations section lists and writes to, as actor. Without this, the alerting runtime's own store is used; without either, there is no Operations tab.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
object → String?
What the address names inside selected: a page's route, a model's name, a function's. Only the sections that can open one are told.
final
onSelect → void Function(String section, String? object)?
Called when the person chooses another section, or another thing inside one, so that the address can follow them. The sections that can open something call it; the rest never can.
final
palette → List<DVStudioPaletteItem>
Widget palette entries, defaulting to the Dartvel primitives.
final
reviewers → List<String>
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sections → List<DVStudioSection>
Sections beyond Pages, appended to the switcher in order.
final
selected → String?
The section the address names, as the id of one of sections or of the ones Studio draws itself. Null, or an id this build has no section for, draws the first.
final
site → DVStudioSiteSource?
Where the site's routes come from: the application's compiled routes and the pages store holds, each marked for what it is. Without it Pages lists what store holds and nothing it did not publish.
final
statusHealth → Future<DVHealthReport> Function()?
The health report the status page preview is built from. Defaults to running the application's registered health checks.
final
store → DVPageStore
The store page documents are read from and published to.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<DVStudioScreen>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited