SemanticsProperties class
Contains properties used by assistive technologies to make the application more accessible.
The properties of this class are used to generate a SemanticsNodes in the semantics tree.
- Inheritance
- Object
- Diagnosticable
- DiagnosticableTree
- SemanticsProperties
- Annotations
- @immutable
Constructors
-
SemanticsProperties({bool enabled, bool checked, bool selected, bool toggled, bool button, bool header, bool textField, bool focused, bool inMutuallyExclusiveGroup, bool obscured, bool scopesRoute, bool namesRoute, bool image, bool liveRegion, String label, String value, String increasedValue, String decreasedValue, String hint, SemanticsHintOverrides hintOverrides, TextDirection textDirection, SemanticsSortKey sortKey, VoidCallback onTap, VoidCallback onLongPress, VoidCallback onScrollLeft, VoidCallback onScrollRight, VoidCallback onScrollUp, VoidCallback onScrollDown, VoidCallback onIncrease, VoidCallback onDecrease, VoidCallback onCopy, VoidCallback onCut, VoidCallback onPaste, MoveCursorHandler onMoveCursorForwardByCharacter, MoveCursorHandler onMoveCursorBackwardByCharacter, MoveCursorHandler onMoveCursorForwardByWord, MoveCursorHandler onMoveCursorBackwardByWord, SetSelectionHandler onSetSelection, VoidCallback onDidGainAccessibilityFocus, VoidCallback onDidLoseAccessibilityFocus, VoidCallback onDismiss, Map<
CustomSemanticsAction, VoidCallback> customSemanticsActions }) -
Creates a semantic annotation.
const
Properties
-
If non-null, indicates that this subtree represents a button. [...]
final
- checked → bool
-
If non-null, indicates that this subtree represents a checkbox
or similar widget with a "checked" state, and what its current
state is. [...]
final
-
customSemanticsActions
→ Map<
CustomSemanticsAction, VoidCallback> -
A map from each supported CustomSemanticsAction to a provided handler. [...]
final
- decreasedValue → String
-
The value that value will become after a SemanticsAction.decrease
action has been performed on this widget. [...]
final
- enabled → bool
-
If non-null, indicates that this subtree represents something that can be
in an enabled or disabled state. [...]
final
- focused → bool
-
If non-null, whether the node currently holds input focus. [...]
final
- header → bool
-
If non-null, indicates that this subtree represents a header. [...]
final
-
If non-null, whether the node is considered hidden. [...]
final
- hint → String
-
Provides a brief textual description of the result of an action performed
on the widget. [...]
final
- hintOverrides → SemanticsHintOverrides
-
Provides hint values which override the default hints on supported
platforms. [...]
final
- image → bool
-
If non-null, whether the node represents an image. [...]
final
- increasedValue → String
-
The value that value will become after a SemanticsAction.increase
action has been performed on this widget. [...]
final
- inMutuallyExclusiveGroup → bool
-
If non-null, whether a semantic node is in a mutually exclusive group. [...]
final
- label → String
-
Provides a textual description of the widget. [...]
final
- liveRegion → bool
-
If non-null, whether the node should be considered a live region. [...]
final
- namesRoute → bool
-
If non-null, whether the node contains the semantic label for a route. [...]
final
- obscured → bool
-
If non-null, whether value should be obscured. [...]
final
- onCopy → VoidCallback
-
The handler for SemanticsAction.copy. [...]
final
- onCut → VoidCallback
-
The handler for SemanticsAction.cut. [...]
final
- onDecrease → VoidCallback
-
The handler for SemanticsAction.decrease. [...]
final
- onDidGainAccessibilityFocus → VoidCallback
-
The handler for SemanticsAction.didGainAccessibilityFocus. [...]
final
- onDidLoseAccessibilityFocus → VoidCallback
-
The handler for SemanticsAction.didLoseAccessibilityFocus. [...]
final
- onDismiss → VoidCallback
-
The handler for SemanticsAction.dismiss. [...]
final
- onIncrease → VoidCallback
-
The handler for SemanticsAction.increase. [...]
final
- onLongPress → VoidCallback
-
The handler for SemanticsAction.longPress. [...]
final
- onMoveCursorBackwardByCharacter → MoveCursorHandler
-
The handler for
SemanticsAction.onMoveCursorBackwardByCharacter
. [...]final - onMoveCursorBackwardByWord → MoveCursorHandler
-
The handler for
SemanticsAction.onMoveCursorBackwardByWord
. [...]final - onMoveCursorForwardByCharacter → MoveCursorHandler
-
The handler for
SemanticsAction.onMoveCursorForwardByCharacter
. [...]final - onMoveCursorForwardByWord → MoveCursorHandler
-
The handler for
SemanticsAction.onMoveCursorForwardByWord
. [...]final - onPaste → VoidCallback
-
The handler for SemanticsAction.paste. [...]
final
- onScrollDown → VoidCallback
-
The handler for SemanticsAction.scrollDown. [...]
final
- onScrollLeft → VoidCallback
-
The handler for SemanticsAction.scrollLeft. [...]
final
- onScrollRight → VoidCallback
-
The handler for SemanticsAction.scrollRight. [...]
final
- onScrollUp → VoidCallback
-
The handler for SemanticsAction.scrollUp. [...]
final
- onSetSelection → SetSelectionHandler
-
The handler for SemanticsAction.setSelection. [...]
final
- onTap → VoidCallback
-
The handler for SemanticsAction.tap. [...]
final
- scopesRoute → bool
-
If non-null, whether the node corresponds to the root of a subtree for
which a route name should be announced. [...]
final
- selected → bool
-
If non-null indicates that this subtree represents something that can be
in a selected or unselected state, and what its current state is. [...]
final
- sortKey → SemanticsSortKey
-
Determines the position of this node among its siblings in the traversal
sort order. [...]
final
- textDirection → TextDirection
-
The reading direction of the label, value, hint, increasedValue,
and decreasedValue. [...]
final
- textField → bool
-
If non-null, indicates that this subtree represents a text field. [...]
final
- toggled → bool
-
If non-null, indicates that this subtree represents a toggle switch
or similar widget with an "on" state, and what its current
state is. [...]
final
- value → String
-
Provides a textual description of the value of the widget. [...]
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
override
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode. [...]
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children. [...]
@protected, inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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 toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns 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
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited