SemanticsConfiguration class

Describes the semantic information associated with the owning RenderObject.

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

Constructors

SemanticsConfiguration()

Properties

customSemanticsActions ↔ Map<CustomSemanticsAction, VoidCallback>
The handlers for each supported CustomSemanticsAction. [...]
read / write
decreasedValue ↔ String
The value that value will have after performing a SemanticsAction.decrease action. [...]
read / write
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. [...]
read / write
hasBeenAnnotated → bool
Whether this configuration is empty. [...]
read-only
hasImplicitScrolling ↔ bool
Whether the platform can scroll the semantics node when the user attempts to move focus to an offscreen child. [...]
read / write
hint ↔ String
A brief description of the result of performing an action on this node. [...]
read / write
hintOverrides SemanticsHintOverrides
Provides hint values which override the default hints on supported platforms.
read / write
increasedValue ↔ String
The value that value will have after performing a SemanticsAction.increase action. [...]
read / write
isBlockingSemanticsOfPreviouslyPaintedNodes ↔ bool
Whether the owning RenderObject makes other RenderObjects previously painted within the same semantic boundary unreachable for accessibility purposes. [...]
read / write
isButton ↔ bool
Whether the owning RenderObject is a button (true) or not (false).
read / write
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. [...]
read / write
isEnabled ↔ bool
Whether the owning RenderObject is currently enabled. [...]
read / write
isFocused ↔ bool
Whether the owning RenderObject currently holds the user's focus.
read / write
isHeader ↔ bool
Whether the owning RenderObject is a header (true) or not (false).
read / write
isHidden ↔ bool
Whether the owning RenderObject is considered hidden. [...]
read / write
isImage ↔ bool
Whether the semantics node represents an image.
read / write
isInMutuallyExclusiveGroup ↔ bool
Whether the owning RenderObject corresponds to UI that allows the user to pick one of several mutually exclusive options. [...]
read / write
isMergingSemanticsOfDescendants ↔ bool
Whether the semantic information provided by the owning RenderObject and all of its descendants should be treated as one logical entity. [...]
read / write
isObscured ↔ bool
Whether the value should be obscured. [...]
read / write
isSelected ↔ bool
Whether the owning RenderObject is selected (true) or not (false).
read / write
isSemanticBoundary ↔ bool
Whether the RenderObject owner of this configuration wants to own its own SemanticsNode. [...]
read / write
isTextField ↔ bool
Whether the owning RenderObject is a text field.
read / write
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. [...]
read / write
label ↔ String
A textual description of the owning RenderObject. [...]
read / write
liveRegion ↔ bool
Whether the semantics node is a live region. [...]
read / write
namesRoute ↔ bool
Whether the semantics node contains the label of a route. [...]
read / write
onCopy VoidCallback
The handler for SemanticsAction.copy. [...]
read / write
onCut VoidCallback
The handler for SemanticsAction.cut. [...]
read / write
onDecrease VoidCallback
The handler for SemanticsAction.decrease. [...]
read / write
onDidGainAccessibilityFocus VoidCallback
The handler for SemanticsAction.didGainAccessibilityFocus. [...]
read / write
onDidLoseAccessibilityFocus VoidCallback
The handler for SemanticsAction.didLoseAccessibilityFocus. [...]
read / write
onDismiss VoidCallback
The handler for SemanticsAction.dismiss. [...]
read / write
onIncrease VoidCallback
The handler for SemanticsAction.increase. [...]
read / write
onLongPress VoidCallback
The handler for SemanticsAction.longPress. [...]
read / write
onMoveCursorBackwardByCharacter MoveCursorHandler
The handler for SemanticsAction.onMoveCursorBackwardByCharacter. [...]
read / write
onMoveCursorBackwardByWord MoveCursorHandler
The handler for SemanticsAction.onMoveCursorBackwardByWord. [...]
read / write
onMoveCursorForwardByCharacter MoveCursorHandler
The handler for SemanticsAction.onMoveCursorForwardByCharacter. [...]
read / write
onMoveCursorForwardByWord MoveCursorHandler
The handler for SemanticsAction.onMoveCursorForwardByWord. [...]
read / write
onPaste VoidCallback
The handler for SemanticsAction.paste. [...]
read / write
onScrollDown VoidCallback
The handler for SemanticsAction.scrollDown. [...]
read / write
onScrollLeft VoidCallback
The handler for SemanticsAction.scrollLeft. [...]
read / write
onScrollRight VoidCallback
The handler for SemanticsAction.scrollRight. [...]
read / write
onScrollUp VoidCallback
The handler for SemanticsAction.scrollUp. [...]
read / write
onSetSelection SetSelectionHandler
The handler for SemanticsAction.setSelection. [...]
read / write
onShowOnScreen VoidCallback
The handler for SemanticsAction.showOnScreen. [...]
read / write
onTap VoidCallback
The handler for SemanticsAction.tap. [...]
read / write
scopesRoute ↔ bool
Whether the semantics node is the root of a subtree for which values should be announced. [...]
read / write
scrollExtentMax ↔ double
Indicates the maximum in-range value for scrollPosition if the node is scrollable. [...]
read / write
scrollExtentMin ↔ double
Indicates the minimum in-range value for scrollPosition if the node is scrollable. [...]
read / write
scrollPosition ↔ double
Indicates the current scrolling position in logical pixels if the node is scrollable. [...]
read / write
sortKey SemanticsSortKey
Determines the position of this node among its siblings in the traversal sort order. [...]
read / write
tagsForChildren → Iterable<SemanticsTag>
The set of tags that this configuration wants to add to all child SemanticsNodes. [...]
read-only
textDirection TextDirection
The reading direction for the text in label, value, hint, increasedValue, and decreasedValue.
read / write
textSelection TextSelection
The currently selected text (or the position of the cursor) within value if this node represents a text field.
read / write
value ↔ String
A textual description for the current value of the owning RenderObject. [...]
read / write
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

absorb(SemanticsConfiguration other) → void
Absorb the semantic information from other 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 non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited