JidoujishoIconButton class
A button that can be set as busy. When busy, the icon is faded out when its onTap action is on-going and processing, which can be used to indicate when a button cannot be pressed once its click action has been executed and is busy.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- JidoujishoIconButton
Constructors
-
JidoujishoIconButton({required IconData icon, required String tooltip, FutureOr<
void> onTap()?, FutureOr<void> onTapDown(TapDownDetails)?, bool busy = false, bool enabled = true, double? size, ShapeBorder shapeBorder = const CircleBorder(), Color? backgroundColor, Color? enabledColor, Color? disabledColor, BoxConstraints? constraints, EdgeInsets? padding, bool isWideTapArea = false, Key? key}) -
Creates a busy icon button. Default values rely on IconTheme.
const
Properties
- backgroundColor → Color?
-
Color of the shape around the icon.
final
- busy → bool
-
Whether or not this icon should have busy behaviour, locking the icon
out from being pressed when its onTap action is on-going.
final
- constraints → BoxConstraints?
-
Allows overriding of the standard size of the IconButton constraints.
final
- disabledColor → Color?
-
What color to show for this icon when disabled. If null, this is the
theme's unselected widget color.
final
- enabled → bool
-
Whether the icon is clickable upon build of this widget.
final
- enabledColor → Color?
-
What color to show for this icon when enabled. If null, this is the
theme's default icon color.
final
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- icon → IconData
-
The icon to display within the button.
final
- isWideTapArea → bool
-
If this button needs to act like an IconButton with a wide area.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onTap
→ (FutureOr<
void> Function()?) -
The action to execute and wait for. While enabled,
final
-
onTapDown
→ (FutureOr<
void> Function(TapDownDetails)?) -
The action to execute and wait for. Use when the global position is
needed.
final
- padding → EdgeInsets?
-
Allows overriding of the standard size of the IconButton padding.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- shapeBorder → ShapeBorder
-
For configuring a custom shaped button. By default, this is a circle.
final
- size → double?
-
The size of the icon. By default, this is 24.0.
final
- tooltip → String
-
Enforces all icons to have a tooltip that explains the purpose of this
icon for accessibility and tutorial purposes.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< StatefulWidget> -
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}) → 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