A widget that annotates the widget tree with a description of the meaning of the widgets.

Used by accessibility tools, search engines, and other semantic analysis software to determine the meaning of the application.

See also:

Inheritance
Annotations
  • @immutable

Constructors

Semantics({Key key, Widget child, bool container: false, bool explicitChildNodes: false, bool checked, bool selected, bool button, String label, String value, String increasedValue, String decreasedValue, String hint, TextDirection textDirection, VoidCallback onTap, VoidCallback onLongPress, VoidCallback onScrollLeft, VoidCallback onScrollRight, VoidCallback onScrollUp, VoidCallback onScrollDown, VoidCallback onIncrease, VoidCallback onDecrease, VoidCallback onMoveCursorForwardByCharacter, VoidCallback onMoveCursorBackwardByCharacter })
Creates a semantic annotation. [...]
Semantics.fromProperties({Key key, Widget child, bool container: false, bool explicitChildNodes: false, @required SemanticsProperties properties })
Creates a semantic annotation using SemanticsProperties. [...]
const

Properties

container bool
If 'container' is true, this widget will introduce a new node in the semantics tree. Otherwise, the semantics will be merged with the semantics of any ancestors (if the ancestor allows that). [...]
final
explicitChildNodes bool
Whether descendants of this widget are allowed to add semantic information to the SemanticsNode annotated by this widget. [...]
final
properties SemanticsProperties
Contains properties used by assistive technologies to make the application more accessible.
final
child Widget
The widget below this widget in the tree.
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createRenderObject(BuildContext context) RenderSemanticsAnnotations
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget. [...]
debugFillProperties(DiagnosticPropertiesBuilder description) → void
updateRenderObject(BuildContext context, RenderSemanticsAnnotations renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject. [...]
createElement() SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
didUnmountRenderObject(RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
@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
toStringShort() String
A short, textual description of this widget.
inherited

Operators

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