ArnaTooltip class
An Arna-styled tooltip.
Tooltips provide text labels which help explain the function of a button or other user interface action.
Many widgets, such as ArnaButton have a tooltipMessage property that,
when non-null, causes the widget to include an ArnaTooltip in its build.
Tooltips improve the accessibility of visual widgets by proving a textual representation of the widget, which, for example, can be vocalized by a screen reader.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ArnaTooltip
Constructors
- ArnaTooltip({Key? key, String? message, InlineSpan? richMessage, bool? preferBelow, bool? excludeFromSemantics, bool enableFeedback = true, ArnaTooltipTriggeredCallback? onTriggered, required Widget child})
-
Creates a tooltip.
Only one of message and richMessage may be non-null.
const
Properties
- child → Widget
-
The widget below this widget in the tree.
final
- enableFeedback → bool
-
Whether detected gestures should provide acoustic and/or haptic feedback.
final
- excludeFromSemantics → bool?
-
Whether the tooltip's message or richMessage should be excluded from the semantics tree.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- message → String?
-
The text to display in the tooltip.
final
- onTriggered → ArnaTooltipTriggeredCallback?
-
Called when the Tooltip is triggered.
final
- preferBelow → bool?
-
Whether the tooltip defaults to being displayed below the widget.
final
- richMessage → InlineSpan?
-
The rich text to display in the tooltip.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ArnaTooltip> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
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
Static Methods
-
dismissAllToolTips(
) → bool - Dismiss all of the tooltips that are currently shown on the screen.