SemanticsData class
Summary information about a SemanticsNode object.
A semantics node might SemanticsNode.mergeAllDescendantsIntoThisNode, which means the individual fields on the semantics node don't fully describe the semantics at that node. This data structure contains the full semantics for the node.
Typically obtained from SemanticsNode.getSemanticsData.
- Mixed-in types
- Annotations
Constructors
-
SemanticsData({required SemanticsFlags flagsCollection, required int actions, required String identifier, required Object? traversalParentIdentifier, required Object? traversalChildIdentifier, required AttributedString attributedLabel, required AttributedString attributedValue, required AttributedString attributedIncreasedValue, required AttributedString attributedDecreasedValue, required AttributedString attributedHint, required String tooltip, required TextDirection? textDirection, required Rect rect, required TextSelection? textSelection, required int? scrollIndex, required int? scrollChildCount, required double? scrollPosition, required double? scrollExtentMax, required double? scrollExtentMin, required int? platformViewId, required int? maxValueLength, required int? currentValueLength, required int headingLevel, required Uri? linkUrl, required SemanticsRole role, required Set<
String> ? controlsNodes, required SemanticsValidationResult validationResult, required SemanticsHitTestBehavior hitTestBehavior, required SemanticsInputType inputType, required Locale? locale, required String? minValue, required String? maxValue, Set<SemanticsTag> ? tags, Matrix4? transform, List<int> ? customSemanticsActionIds}) - Creates a semantics data object.
Properties
- actions → int
-
A bit field of SemanticsActions that apply to this node.
final
- attributedDecreasedValue → AttributedString
-
The value that value will become after performing a
SemanticsAction.decrease action in AttributedString format.
final
- attributedHint → AttributedString
-
A brief description of the result of performing an action on this node
in AttributedString format.
final
- attributedIncreasedValue → AttributedString
-
The value that value will become after performing a
SemanticsAction.increase action in AttributedString format.
final
- attributedLabel → AttributedString
-
A textual description for the current label of the node in
AttributedString format.
final
- attributedValue → AttributedString
-
A textual description for the current value of the node in
AttributedString format.
final
-
controlsNodes
→ Set<
String> ? -
The SemanticsNode.identifiers of widgets controlled by this node.
final
- currentValueLength → int?
-
The current number of characters that have been entered into an editable
text field.
final
-
customSemanticsActionIds
→ List<
int> ? -
The identifiers for the custom semantics actions and standard action
overrides for this node.
final
- decreasedValue → String
-
The value that value will become after performing a
SemanticsAction.decrease action.
no setter
- flags → int
-
A bit field of SemanticsFlags that apply to this node.
no setter
- flagsCollection → SemanticsFlags
-
Semantics flags.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- headingLevel → int
-
Indicates that this subtree represents a heading.
final
- hint → String
-
A brief description of the result of performing an action on this node.
no setter
- hitTestBehavior → SemanticsHitTestBehavior
-
Describes how the semantic node should behave during hit testing.
final
- identifier → String
-
Provides an identifier for the semantics node in native accessibility hierarchy.
final
- increasedValue → String
-
The value that value will become after performing a
SemanticsAction.increase action.
no setter
- inputType → SemanticsInputType
-
The input type for of a editable node.
final
- label → String
-
A textual description for the current label of the node.
no setter
- linkUrl → Uri?
-
The URL that this node links to.
final
- locale → Locale?
-
The locale for this semantics node.
final
- maxValue → String?
-
The maximum value of the node.
final
- maxValueLength → int?
-
The maximum number of characters that can be entered into an editable
text field.
final
- minValue → String?
-
The minimum value of the node.
final
- platformViewId → int?
-
The id of the platform view, whose semantics nodes will be added as
children to this node.
final
- rect → Rect
-
The bounding box for this node in its coordinate system.
final
- role → SemanticsRole
-
The role this node represents
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollChildCount → int?
-
The total number of scrollable children that contribute to semantics.
final
- scrollExtentMax → double?
-
Indicates the maximum in-range value for scrollPosition if the node is
scrollable.
final
- scrollExtentMin → double?
-
Indicates the minimum in-range value for scrollPosition if the node is
scrollable.
final
- scrollIndex → int?
-
The index of the first visible semantic child of a scroll node.
final
- scrollPosition → double?
-
Indicates the current scrolling position in logical pixels if the node is
scrollable.
final
-
The set of SemanticsTags associated with this node.
final
- textDirection → TextDirection?
-
The reading direction for the text in label, value,
increasedValue, decreasedValue, and hint.
final
- textSelection → TextSelection?
-
The currently selected text (or the position of the cursor) within value
if this node represents a text field.
final
- tooltip → String
-
A textual description of the widget's tooltip.
final
- transform → Matrix4?
-
The transform from this node's coordinate system to its parent's coordinate system.
final
- traversalChildIdentifier → Object?
-
Provides an identifier for establishing parent-child relationships in the semantics
traversal tree.
final
- traversalParentIdentifier → Object?
-
Provides an identifier for establishing parent-child relationships in the semantics
traversal tree.
final
- validationResult → SemanticsValidationResult
-
Describes the validation result for a form field represented by this
widget.
final
- value → String
-
A textual description for the current value of the node.
no setter
Methods
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
hasAction(
SemanticsAction action) → bool - Whether actions contains the given action.
-
hasFlag(
SemanticsFlag flag) → bool - Whether flags contains the given flag.
-
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
