LedgerSideInset class

How far the desktop sidebar stands over the left of the pages under it: a page lays its content out to the right of inset, as the source's grid does. The shell publishes it on the desktop; elsewhere it is none. Plumbing of the shell and the screen; pages never place one.

Inheritance

Constructors

LedgerSideInset({required double inset, required Widget child, bool beside = false, Key? key})
Publishes the sidebar's inset to child.
const

Properties

beside → bool
Whether the pages stand beside the sidebar or the rail rather than under it (ui_core's shell lays them beside it): nothing to pad, but a page's masthead heads it as beside a bar.
final
child → Widget
The widget below this widget in the tree.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
inset → double
How far the sidebar stands over the pages' start.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → InheritedElement
Inflates this configuration to a concrete instance.
inherited
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
updateShouldNotify(covariant LedgerSideInset oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

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

Static Methods

besideOf(BuildContext context) → bool
Whether context's page stands by a sidebar or a rail: under one (an inset over 0) or beside one.
of(BuildContext context) → double
The sidebar's reach over context's page: 0 off the desktop, in a sheet, or outside a shell.