ProgressBarCountdown class
Create a Progress Countdown Timer.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ProgressBarCountdown
Constructors
-
ProgressBarCountdown({Key? key, required Duration initialDuration, required Color progressColor, Color progressBackgroundColor = Colors.white, Color? initialTextColor, Color? revealedTextColor, bool hideText = false, TextStyle textStyle = const TextStyle(fontSize: 18, fontWeight: FontWeight.bold), double height = 50.0, ProgressBarCountdownAlignment countdownDirection = ProgressBarCountdownAlignment.left, ProgressBarCountdownController? controller, bool autoStart = false, VoidCallback? onComplete, VoidCallback? onStart, ValueChanged<
String> ? onChange, String timeFormatter(Duration remainingTime)?}) -
const
Properties
- autoStart → bool
-
Handles the timer start.
final
- controller → ProgressBarCountdownController?
-
Controls (i.e Start, Pause, Resume, Restart) the Progress Countdown Timer.
final
- countdownDirection → ProgressBarCountdownAlignment
-
Direction of the Progress Countdown
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double
-
Height of the Progress Bar
final
- hideText → bool
-
Boolean to Show / Hide the Text
final
- initialDuration → Duration
-
Countdown Duration in Seconds.
final
- initialTextColor → Color?
-
Text Color for the Progress Bar
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onChange
→ ValueChanged<
String> ? -
This Callback will execute when the Countdown Changes.
final
- onComplete → VoidCallback?
-
This Callback will execute when the Countdown Ends.
final
- onStart → VoidCallback?
-
This Callback will execute when the Countdown Starts.
final
- progressBackgroundColor → Color
-
Background for Countdown Widget
final
- progressColor → Color
-
Progress Color for Countdown Widget
final
- revealedTextColor → Color?
-
Text Color for 'Behind' the Progress Bar
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- textStyle → TextStyle
-
Text Style of the Countdown
final
- timeFormatter → String Function(Duration remainingTime)?
-
This function can be used to override the default time formatter.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ProgressBarCountdownState -
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