PaperDisplayFace class final

The Paper & ink display panel.

Inheritance

Constructors

PaperDisplayFace({required Color panel, required Color ink, required Color rule, required Color margin, bool ledger = false, bool rules = true, double grain = 0, bool dark = false, bool accessible = false, int weight = 400, bool lite = false, double ruleFade = 1, double? rulePitch})
const

Properties

accessible → bool
Accessible lock: heavier small text.
final
clearStagger → Duration
Delay between characters when the whole line clears, right to left (Retro long-press clear: 15 ms per digit); zero = no stagger.
no setterinherited
dark → bool
Dark sheet (a black contact shadow).
final
glyphOff → Duration
How long an unlit glyph takes to disappear (Retro: off 50 ms).
no setterinherited
glyphOn → Duration
How long a newly lit glyph takes to appear (Retro: segments on 30 ms).
no setterinherited
grain → double
Paper grain opacity on the panel (0–1).
final
hashCode → int
The hash code for this object.
no setteroverride
ink → Color
The ink (display text colour family): the contact shadow on light sheets and the lite tier's edge.
final
ledger → bool
Ruled ledger (ruled sheets) rather than a torn index card.
final
lite → bool
Lite effects tier: no blurred contact shadow.
final
margin → Color
The margin rule's red pen (palette error).
final
panel → Color
The panel colour (palette surface, opaque).
final
panelColor → Color
The panel colour the display text sits on (its contrast backdrop).
no setteroverride
panelMargin → EdgeInsets
One margin for both panels, so a ledger ↔ card swipe never reflows the display.
no setteroverride
rule → Color
Feint-rule ink (the sheet's rule colour).
final
ruleFade → double
The feint rules' opacity factor (0–1): 1 for a theme's own panel. An in-between panel of a Paper → Paper morph fades its rules and its grain out over the first quarter and back in over the last (neither in between; neither at all between a light and a dark sheet), since the lerped display text is repaired against the panel colour alone.
final
rulePitch → double?
The ledger's feint-rule pitch, dp: the sheet's own ruling (null: a seventh of the panel, 20–34 dp).
final
rules → bool
Whether feint rules are drawn (off under the Accessible lock).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
weight → int
Display weight (CSS) for results; typing is 100 lighter, messages 100 heavier, Bold Text adds three steps.
final

Methods

drawsChar(int codeUnit) → bool
Whether this face draws the UTF-16 code unit codeUnit itself.
override
feintRulesIn(Rect rect) → List<double>
The feint rules' y positions in rect (none under the Accessible lock): every pitch from the top, within the upper 40 %.
lerpTo(DisplayFace other, double t) → DisplayFace
This face t of the way to other (theme transitions between two themes of the same family); switches at the midpoint by default.
override
marginRulesIn(Rect rect) → List<double>
The margin rules' x positions in rect.
maskedSpan(String text, TextStyle style) → TextSpan
text in style with the face-drawn characters transparent: the same layout as TextSpan(text: text, style: style).
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paintGlyphs(Canvas canvas, TextPainter painter, String text, {required Offset origin, required Color color, required double fontSize, int start = 0, int? end, double opacity(int index)?}) → void
Paints the face-drawn characters [start, end) of text, which painter has laid out (with maskedSpan) at origin, in color. opacity (per character index) fades glyphs in or out.
override
paintPanel(Canvas canvas, Rect rect) → void
Paints the panel filling rect.
override
textStyle(TextStyle base) → TextStyle
An editorial serif cut: the display asks for w300 (typing), w400 (results) or w500 (messages), plus three steps under Bold Text; each maps onto weight shifted by the same amount, floored at 350 (400 below 24 dp and under the Accessible lock) and capped at the font's 800. Optical size follows the font size (the display cut at 56 dp).
override
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

ruleAlpha → const int
Feint-rule alpha (of 255).