ScanDocumentFlowState class

State management for Scan Document Flow component Category 3: Complex/Composite - Document scanning interface States: Rest, Disabled (NO Hover or Pressed - buttons handle those)

Extends BaseComponentState which provides:

  • Dimensions (width, height, paddingH, paddingV)
  • Neumorphic shadows (distance, blur, intensities, borderRadius)
  • Animated border (showAnimatedBorder, borderColor, borderWidth)
  • State colors for Rest, Hover, Pressed, Disabled (light + dark)
  • Shadow color helpers (getLightShadowColor, getDarkShadowColor)
Inheritance

Constructors

ScanDocumentFlowState()

Properties

actionButtonSize ↔ double
getter/setter pair
blur ↔ double
getter/setter pairinherited
borderColor ↔ Color
getter/setter pairinherited
borderRadius ↔ double
getter/setter pairinherited
borderWidth ↔ double
getter/setter pairinherited
componentNameGetter → String
Component identifier for theme color resolution. Each component should have a unique name like 'button', 'toggle', 'card'. Named componentNameGetter to avoid conflict with static componentName that some subclasses expose for external access.
no setteroverride
cornerSize ↔ double
getter/setter pair
cornerWidth ↔ double
getter/setter pair
currentStep ↔ int
getter/setter pair
darkIntensity ↔ double
getter/setter pairinherited
disabledBaseColorDark ↔ Color
getter/setter pairinherited
disabledBaseColorLight ↔ Color
getter/setter pairinherited
disabledBlurOverride ↔ double?
getter/setter pairinherited
disabledCornerColorDark ↔ Color
getter/setter pair
disabledCornerColorLight ↔ Color
getter/setter pair
disabledDarkIntensityOverride ↔ double?
getter/setter pairinherited
disabledDistanceOverride ↔ double?
getter/setter pairinherited
disabledIconColorDark ↔ Color
getter/setter pairinherited
disabledIconColorLight ↔ Color
getter/setter pairinherited
disabledInstructionColorDark ↔ Color
getter/setter pair
disabledInstructionColorLight ↔ Color
getter/setter pair
disabledLightIntensityOverride ↔ double?
getter/setter pairinherited
disabledOverrideEnabled ↔ bool
getter/setter pairinherited
disabledScanBorderColorDark ↔ Color
getter/setter pair
disabledScanBorderColorLight ↔ Color
getter/setter pair
disabledScanButtonColorDark ↔ Color
getter/setter pair
disabledScanButtonColorLight ↔ Color
getter/setter pair
disabledTextColorDark ↔ Color
getter/setter pairinherited
disabledTextColorLight ↔ Color
getter/setter pairinherited
disabledTitleColorDark ↔ Color
getter/setter pair
disabledTitleColorLight ↔ Color
getter/setter pair
distance ↔ double
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
height ↔ double
getter/setter pairinherited
hint ↔ String
getter/setter pair
hintFontSize ↔ double
getter/setter pair
hintText ↔ String
getter/setter pair
hoverBaseColorDark ↔ Color
getter/setter pairinherited
hoverBaseColorLight ↔ Color
getter/setter pairinherited
hoverBlurOverride ↔ double?
getter/setter pairinherited
hoverDarkIntensityOverride ↔ double?
getter/setter pairinherited
hoverDistanceOverride ↔ double?
getter/setter pairinherited
hoverIconColorDark ↔ Color
getter/setter pairinherited
hoverIconColorLight ↔ Color
getter/setter pairinherited
hoverLightIntensityOverride ↔ double?
getter/setter pairinherited
hoverOverrideEnabled ↔ bool
getter/setter pairinherited
hoverTextColorDark ↔ Color
getter/setter pairinherited
hoverTextColorLight ↔ Color
getter/setter pairinherited
instructionFontSize ↔ double
getter/setter pair
instructionFontWeight ↔ FontWeight
getter/setter pair
instructionText ↔ String
getter/setter pair
lightIntensity ↔ double
getter/setter pairinherited
paddingH ↔ double
getter/setter pairinherited
paddingHorizontal ↔ double
getter/setter pair
paddingV ↔ double
getter/setter pairinherited
paddingVertical ↔ double
getter/setter pair
palette → GeneratedPalette?
Get the stored palette, if any.
no setterinherited
pressedBaseColorDark ↔ Color
getter/setter pairinherited
pressedBaseColorLight ↔ Color
getter/setter pairinherited
pressedBlurOverride ↔ double?
getter/setter pairinherited
pressedDarkIntensityOverride ↔ double?
getter/setter pairinherited
pressedDistanceOverride ↔ double?
getter/setter pairinherited
pressedIconColorDark ↔ Color
getter/setter pairinherited
pressedIconColorLight ↔ Color
getter/setter pairinherited
pressedLightIntensityOverride ↔ double?
getter/setter pairinherited
pressedOverrideEnabled ↔ bool
getter/setter pairinherited
pressedTextColorDark ↔ Color
getter/setter pairinherited
pressedTextColorLight ↔ Color
getter/setter pairinherited
restActionButtonColorDark ↔ Color
getter/setter pair
restActionButtonColorLight ↔ Color
getter/setter pair
restActionIconColorDark ↔ Color
getter/setter pair
restActionIconColorLight ↔ Color
getter/setter pair
restBaseColorDark ↔ Color
getter/setter pairinherited
restBaseColorLight ↔ Color
getter/setter pairinherited
restBlurOverride ↔ double?
getter/setter pairinherited
restCornerColorDark ↔ Color
getter/setter pair
restCornerColorLight ↔ Color
getter/setter pair
restDarkIntensityOverride ↔ double?
getter/setter pairinherited
restDistanceOverride ↔ double?
getter/setter pairinherited
restHintColorDark ↔ Color
getter/setter pair
restHintColorLight ↔ Color
getter/setter pair
restIconColorDark ↔ Color
getter/setter pairinherited
restIconColorLight ↔ Color
getter/setter pairinherited
restInstructionColorDark ↔ Color
getter/setter pair
restInstructionColorLight ↔ Color
getter/setter pair
restLightIntensityOverride ↔ double?
getter/setter pairinherited
restOverrideEnabled ↔ bool
getter/setter pairinherited
restScanAreaColorDark ↔ Color
getter/setter pair
restScanAreaColorLight ↔ Color
getter/setter pair
restScanBorderColorDark ↔ Color
getter/setter pair
restScanBorderColorLight ↔ Color
getter/setter pair
restScanButtonColorDark ↔ Color
getter/setter pair
restScanButtonColorLight ↔ Color
getter/setter pair
restScanIconColorDark ↔ Color
getter/setter pair
restScanIconColorLight ↔ Color
getter/setter pair
restScannerBgDark ↔ Color
getter/setter pair
restScannerBgLight ↔ Color
getter/setter pair
restStepActiveColorDark ↔ Color
getter/setter pair
restStepActiveColorLight ↔ Color
getter/setter pair
restStepInactiveColorDark ↔ Color
getter/setter pair
restStepInactiveColorLight ↔ Color
getter/setter pair
restStepIndicatorColorDark ↔ Color
getter/setter pair
restStepIndicatorColorLight ↔ Color
getter/setter pair
restTextColorDark ↔ Color
getter/setter pairinherited
restTextColorLight ↔ Color
getter/setter pairinherited
restTitleColorDark ↔ Color
getter/setter pair
restTitleColorLight ↔ Color
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scanAreaBorderRadius ↔ double
getter/setter pair
scanButtonSize ↔ double
getter/setter pair
scannerBorderRadius ↔ double
getter/setter pair
scannerPadding ↔ double
getter/setter pair
showAnimatedBorder ↔ bool
getter/setter pairinherited
stepFontSize ↔ double
getter/setter pair
stepIndicatorSize ↔ double
getter/setter pair
title ↔ String
getter/setter pair
titleFontSize ↔ double
getter/setter pair
titleFontWeight ↔ FontWeight
getter/setter pair
totalSteps ↔ int
getter/setter pair
width ↔ double
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
applyTheme(GeneratedPalette palette) → void
Apply colors from a GeneratedPalette to this component's state.
override
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
getComponentSpecificModifiedProperties() → Set<String>
Get set of component-specific modified properties. Called by getModifiedProperties() to include custom property tracking.
override
getDarkShadowColor(bool isDarkMode) → Color
Get the dark shadow color for neumorphic effects. Uses palette colors when available, falls back to defaults otherwise.
inherited
getDefaultDimensions() → ({double height, double paddingH, double paddingV, double width})
Get component-specific default dimensions. Returns a record with (width, height, paddingH, paddingV).
override
getEffectiveBlur(dynamic state) → double
Get effective blur for a given state (applies overrides if enabled). Accepts either String ('rest', 'hover', 'pressed', 'disabled') or ComponentState enum.
inherited
getEffectiveBorderColor(dynamic state) → Color
Get effective border color for a given state. Returns the animated border color. Override in subclasses for state-specific border colors. Accepts ComponentState enum or component-specific enum types.
inherited
getEffectiveBorderRadius(dynamic state) → double
Get effective border radius for a given state. Most components use the same border radius for all states. Override in subclasses for state-specific border radius. Accepts ComponentState enum or component-specific enum types.
inherited
getEffectiveBorderWidth(dynamic state) → double
Get effective border width for a given state. Returns the animated border width. Override in subclasses for state-specific border widths. Accepts ComponentState enum or component-specific enum types.
inherited
getEffectiveDarkIntensity(dynamic state, [bool isDarkMode = false]) → double
Get effective dark intensity for a given state. Single argument version - assumes light mode for backward compatibility. Accepts either String ('rest', 'hover', 'pressed', 'disabled') or ComponentState enum.
inherited
getEffectiveDistance(dynamic state) → double
Get effective distance for a given state (applies overrides if enabled). Accepts either String ('rest', 'hover', 'pressed', 'disabled') or ComponentState enum.
inherited
getEffectiveHeight(dynamic state) → double
Get effective height for a given state. Most components use the same height for all states, so this defaults to height. Override in subclasses for state-specific sizing. Accepts ComponentState enum or component-specific enum types.
inherited
getEffectiveLightIntensity(dynamic state, [bool isDarkMode = false]) → double
Get effective light intensity for a given state. Single argument version - assumes light mode for backward compatibility. Accepts either String ('rest', 'hover', 'pressed', 'disabled') or ComponentState enum.
inherited
getEffectiveWidth(dynamic state) → double
Get effective width for a given state. Most components use the same width for all states, so this defaults to width. Override in subclasses for state-specific sizing. Accepts ComponentState enum or component-specific enum types.
inherited
getLightShadowColor(bool isDarkMode) → Color
Get the light shadow color for neumorphic effects. Uses palette colors when available, falls back to defaults otherwise.
inherited
getModifiedProperties() → Set<String>
Get the set of property names that have been modified from defaults.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
resetComponentSpecificProperties() → void
Reset component-specific properties to defaults. Called by resetToDefaults() after resetting common properties.
override
resetToDefaults() → void
Reset all properties to their default values.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

componentName → const String