SemanticsConfiguration class

Describes the semantic information associated with the owning RenderObject.

The information provided in the configuration is used to generate the semantics tree.

Constructors

SemanticsConfiguration.new()

Properties

attributedDecreasedValue ↔ AttributedString
The value that value will have after performing a SemanticsAction.decrease action in AttributedString format.
getter/setter pair
attributedHint ↔ AttributedString
A brief description of the result of performing an action on this node in AttributedString format.
getter/setter pair
attributedIncreasedValue ↔ AttributedString
The value that value will have after performing a SemanticsAction.increase action in AttributedString format.
getter/setter pair
attributedLabel ↔ AttributedString
A textual description of the owning RenderObject in AttributedString format.
getter/setter pair
attributedValue ↔ AttributedString
A textual description for the current value of the owning RenderObject in AttributedString format.
getter/setter pair
childConfigurationsDelegate ↔ ChildSemanticsConfigurationsDelegate?
A delegate that decides how to handle SemanticsConfigurations produced in the widget subtree.
getter/setter pair
controlsNodes ↔ Set<String>?
The SemanticsNode.identifiers of widgets controlled by this node.
getter/setter pair
currentValueLength ↔ int?
The current number of characters that have been entered into an editable text field.
getter/setter pair
customSemanticsActions ↔ Map<CustomSemanticsAction, VoidCallback>
The handlers for each supported CustomSemanticsAction.
getter/setter pair
decreasedValue ↔ String
The value that value will have after performing a SemanticsAction.decrease action.
getter/setter pair
explicitChildNodes ↔ bool
Whether the configuration forces all children of the owning RenderObject that want to contribute semantic information to the semantics tree to do so in the form of explicit SemanticsNodes.
getter/setter pair
hasBeenAnnotated → bool
Whether this configuration is empty.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasImplicitScrolling ↔ bool
Whether the platform can scroll the semantics node when the user attempts to move focus to an offscreen child.
getter/setter pair
headingLevel ↔ int
Indicates the heading level in the document structure.
getter/setter pair
hint ↔ String
A brief description of the result of performing an action on this node.
getter/setter pair
hintOverrides ↔ SemanticsHintOverrides?
Provides hint values which override the default hints on supported platforms.
getter/setter pair
identifier ↔ String
Provides an identifier for the semantics node in native accessibility hierarchy.
getter/setter pair
increasedValue ↔ String
The value that value will have after performing a SemanticsAction.increase action.
getter/setter pair
indexInParent ↔ int?
The index of this node within the parent's list of semantic children.
getter/setter pair
inputType ↔ SemanticsInputType
The input type for of a editable widget.
getter/setter pair
isBlockingSemanticsOfPreviouslyPaintedNodes ↔ bool
Whether the owning RenderObject makes other RenderObjects previously painted within the same semantic boundary unreachable for accessibility purposes.
getter/setter pair
isBlockingUserActions ↔ bool
Whether to block pointer related user actions for the rendering subtree.
getter/setter pair
isButton ↔ bool
Whether the owning RenderObject is a button (true) or not (false).
getter/setter pair
isChecked ↔ bool?
If this node has Boolean state that can be controlled by the user, whether that state is checked or unchecked, corresponding to true and false, respectively.
getter/setter pair
isCheckStateMixed ↔ bool?
If this node has tristate that can be controlled by the user, whether that state is in its mixed state.
getter/setter pair
isEnabled ↔ bool?
Whether the owning RenderObject is currently enabled.
getter/setter pair
isExpanded ↔ bool?
If this node has Boolean state that can be controlled by the user, whether that state is expanded or collapsed, corresponding to true and false, respectively.
getter/setter pair
isFocusable ↔ bool
Whether the owning RenderObject can hold the input focus.
getter/setter pair
isFocused ↔ bool
Whether the owning RenderObject currently holds the input focus.
getter/setter pair
isHeader ↔ bool
Whether the owning RenderObject is a header (true) or not (false).
getter/setter pair
isHidden ↔ bool
Whether the owning RenderObject is considered hidden.
getter/setter pair
isImage ↔ bool
Whether the semantics node represents an image.
getter/setter pair
isInMutuallyExclusiveGroup ↔ bool
Whether the owning RenderObject corresponds to UI that allows the user to pick one of several mutually exclusive options.
getter/setter pair
isKeyboardKey ↔ bool
Whether the owning RenderObject is a keyboard key (true) or not (false).
getter/setter pair
Whether the owning RenderObject is a link (true) or not (false).
getter/setter pair
isMergingSemanticsOfDescendants ↔ bool
Whether the semantic information provided by the owning RenderObject and all of its descendants should be treated as one logical entity.
getter/setter pair
isMultiline ↔ bool
Whether the text field is multiline.
getter/setter pair
isObscured ↔ bool
Whether value should be obscured.
getter/setter pair
isReadOnly ↔ bool
Whether the owning RenderObject is read only.
getter/setter pair
isRequired ↔ bool?
Whether the semantics node has a required state.
getter/setter pair
isSelected ↔ bool
Whether the owning RenderObject is selected (true) or not (false).
getter/setter pair
isSemanticBoundary ↔ bool
Whether the RenderObject owner of this configuration wants to own its own SemanticsNode.
getter/setter pair
isSlider ↔ bool
Whether the owning RenderObject is a slider (true) or not (false).
getter/setter pair
isTextField ↔ bool
Whether the owning RenderObject is a text field.
getter/setter pair
isToggled ↔ bool?
If this node has Boolean state that can be controlled by the user, whether that state is on or off, corresponding to true and false, respectively.
getter/setter pair
label ↔ String
A textual description of the owning RenderObject.
getter/setter pair
linkUrl ↔ Uri?
The URL that the owning RenderObject links to.
getter/setter pair
liveRegion ↔ bool
Whether the semantics node is a live region.
getter/setter pair
locale ↔ Locale?
The locale of the resulting semantics node if this configuration formed one.
getter/setter pair
localeForSubtree ↔ Locale?
The locale for widgets in the subtree.
getter/setter pair
maxValueLength ↔ int?
The maximum number of characters that can be entered into an editable text field.
getter/setter pair
namesRoute ↔ bool
Whether the semantics node contains the label of a route.
getter/setter pair
onCopy ↔ VoidCallback?
The handler for SemanticsAction.copy.
getter/setter pair
onCut ↔ VoidCallback?
The handler for SemanticsAction.cut.
getter/setter pair
onDecrease ↔ VoidCallback?
The handler for SemanticsAction.decrease.
getter/setter pair
onDidGainAccessibilityFocus ↔ VoidCallback?
The handler for SemanticsAction.didGainAccessibilityFocus.
getter/setter pair
onDidLoseAccessibilityFocus ↔ VoidCallback?
The handler for SemanticsAction.didLoseAccessibilityFocus.
getter/setter pair
onDismiss ↔ VoidCallback?
The handler for SemanticsAction.dismiss.
getter/setter pair
onFocus ↔ VoidCallback?
The handler for SemanticsAction.focus.
getter/setter pair
onIncrease ↔ VoidCallback?
The handler for SemanticsAction.increase.
getter/setter pair
onLongPress ↔ VoidCallback?
The handler for SemanticsAction.longPress.
getter/setter pair
onMoveCursorBackwardByCharacter ↔ MoveCursorHandler?
The handler for SemanticsAction.moveCursorBackwardByCharacter.
getter/setter pair
onMoveCursorBackwardByWord ↔ MoveCursorHandler?
The handler for SemanticsAction.moveCursorBackwardByWord.
getter/setter pair
onMoveCursorForwardByCharacter ↔ MoveCursorHandler?
The handler for SemanticsAction.moveCursorForwardByCharacter.
getter/setter pair
onMoveCursorForwardByWord ↔ MoveCursorHandler?
The handler for SemanticsAction.moveCursorForwardByWord.
getter/setter pair
onPaste ↔ VoidCallback?
The handler for SemanticsAction.paste.
getter/setter pair
onScrollDown ↔ VoidCallback?
The handler for SemanticsAction.scrollDown.
getter/setter pair
onScrollLeft ↔ VoidCallback?
The handler for SemanticsAction.scrollLeft.
getter/setter pair
onScrollRight ↔ VoidCallback?
The handler for SemanticsAction.scrollRight.
getter/setter pair
onScrollToOffset ↔ ScrollToOffsetHandler?
The handler for SemanticsAction.scrollToOffset.
getter/setter pair
onScrollUp ↔ VoidCallback?
The handler for SemanticsAction.scrollUp.
getter/setter pair
onSetSelection ↔ SetSelectionHandler?
The handler for SemanticsAction.setSelection.
getter/setter pair
onSetText ↔ SetTextHandler?
The handler for SemanticsAction.setText.
getter/setter pair
onShowOnScreen ↔ VoidCallback?
The handler for SemanticsAction.showOnScreen.
getter/setter pair
onTap ↔ VoidCallback?
The handler for SemanticsAction.tap.
getter/setter pair
platformViewId ↔ int?
The id of the platform view, whose semantics nodes will be added as children to this node.
getter/setter pair
role ↔ SemanticsRole
A enum to describe what role the subtree represents.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopesRoute ↔ bool
Whether the semantics node is the root of a subtree for which values should be announced.
getter/setter pair
scrollChildCount ↔ int?
The total number of scrollable children that contribute to semantics.
getter/setter pair
scrollExtentMax ↔ double?
Indicates the maximum in-range value for scrollPosition if the node is scrollable.
getter/setter pair
scrollExtentMin ↔ double?
Indicates the minimum in-range value for scrollPosition if the node is scrollable.
getter/setter pair
scrollIndex ↔ int?
The index of the first visible scrollable child that contributes to semantics.
getter/setter pair
scrollPosition ↔ double?
Indicates the current scrolling position in logical pixels if the node is scrollable.
getter/setter pair
sortKey ↔ SemanticsSortKey?
Determines the position of this node among its siblings in the traversal sort order.
getter/setter pair
tagsForChildren → Iterable<SemanticsTag>?
The set of tags that this configuration wants to add to all child SemanticsNodes.
no setter
textDirection ↔ TextDirection?
The reading direction for the text in label, value, hint, increasedValue, and decreasedValue.
getter/setter pair
textSelection ↔ TextSelection?
The currently selected text (or the position of the cursor) within value if this node represents a text field.
getter/setter pair
tooltip ↔ String
A textual description of the widget's tooltip.
getter/setter pair
validationResult ↔ SemanticsValidationResult
Describes the validation result for a form field represented by this widget.
getter/setter pair
value ↔ String
A textual description for the current value of the owning RenderObject.
getter/setter pair

Methods

absorb(SemanticsConfiguration child) → void
Absorb the semantic information from child into this configuration.
addTagForChildren(SemanticsTag tag) → void
Specifies a SemanticsTag that this configuration wants to apply to all child SemanticsNodes.
copy() → SemanticsConfiguration
Returns an exact copy of this configuration.
getActionHandler(SemanticsAction action) → SemanticsActionHandler?
Returns the action handler registered for action or null if none was registered.
isCompatibleWith(SemanticsConfiguration? other) → bool
Whether this configuration is compatible with the provided other configuration.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
tagsChildrenWith(SemanticsTag tag) → bool
Whether this configuration will tag the child semantics nodes with a given SemanticsTag.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited