common.dart 6.84 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:convert';

import 'package:meta/meta.dart';
import 'constants.dart';

/// A semantics node created from Android accessibility information.
///
/// This object represents Android accessibility information derived from an
/// [AccessibilityNodeInfo](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo)
/// object. The purpose is to verify in integration
/// tests that our semantics framework produces the correct accessibility info
/// on Android.
///
/// See also:
///
///   * [AccessibilityNodeInfo](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo)
class AndroidSemanticsNode  {
  AndroidSemanticsNode._(this._values);

  /// Deserializes a new [AndroidSemanticsNode] from a json map.
  ///
  /// The structure of the JSON:
  ///
  ///     {
  ///       "flags": {
  ///         "isChecked": bool,
  ///         "isCheckable": bool,
  ///         "isEditable": bool,
  ///         "isEnabled": bool,
  ///         "isFocusable": bool,
  ///         "isFocused": bool,
36
  ///         "isHeading": bool,
37 38 39 40
  ///         "isPassword": bool,
  ///         "isLongClickable": bool,
  ///       },
  ///       "text": String,
41
  ///       "contentDescription": String,
42 43 44 45 46 47 48 49 50 51 52 53 54
  ///       "className": String,
  ///       "id": int,
  ///       "rect": {
  ///         left: int,
  ///         top: int,
  ///         right: int,
  ///         bottom: int,
  ///       },
  ///       actions: [
  ///         int,
  ///       ]
  ///     }
  factory AndroidSemanticsNode.deserialize(String value) {
55
    return AndroidSemanticsNode._(json.decode(value) as Map<String, Object>);
56 57 58 59 60
  }

  final Map<String, Object> _values;
  final List<AndroidSemanticsNode> _children = <AndroidSemanticsNode>[];

61
  Map<String, Object> get _flags => _values['flags'] as Map<String, Object>;
62 63 64 65 66

  /// The text value of the semantics node.
  ///
  /// This is produced by combining the value, label, and hint fields from
  /// the Flutter [SemanticsNode].
67
  String get text => _values['text'] as String;
68

69 70 71 72 73 74 75 76
  /// The contentDescription of the semantics node.
  ///
  /// This field is used for the Switch, Radio, and Checkbox widgets
  /// instead of [text]. If the text property is used for these, TalkBack
  /// will not read out the "checked" or "not checked" label by default.
  ///
  /// This is produced by combining the value, label, and hint fields from
  /// the Flutter [SemanticsNode].
77
  String get contentDescription => _values['contentDescription'] as String;
78

79 80 81 82 83 84 85
  /// The className of the semantics node.
  ///
  /// Certain kinds of Flutter semantics are mapped to Android classes to
  /// use their default semantic behavior, such as checkboxes and images.
  ///
  /// If a more specific value isn't provided, it defaults to
  /// "android.view.View".
86
  String get className => _values['className'] as String;
87 88

  /// The identifier for this semantics node.
89
  int get id => _values['id'] as int;
90 91 92 93 94 95 96

  /// The children of this semantics node.
  List<AndroidSemanticsNode> get children => _children;

  /// Whether the node is currently in a checked state.
  ///
  /// Equivalent to [SemanticsFlag.isChecked].
97
  bool get isChecked => _flags['isChecked'] as bool;
98 99 100 101

  /// Whether the node can be in a checked state.
  ///
  /// Equivalent to [SemanticsFlag.hasCheckedState]
102
  bool get isCheckable => _flags['isCheckable'] as bool;
103 104 105 106 107

  /// Whether the node is editable.
  ///
  /// This is usually only applied to text fields, which map
  /// to "android.widget.EditText".
108
  bool get isEditable => _flags['isEditable'] as bool;
109 110

  /// Whether the node is enabled.
111
  bool get isEnabled => _flags['isEnabled'] as bool;
112 113

  /// Whether the node is focusable.
114
  bool get isFocusable => _flags['isFocusable'] as bool;
115 116

  /// Whether the node is focused.
117
  bool get isFocused => _flags['isFocused'] as bool;
118

119
  /// Whether the node is considered a heading.
120
  bool get isHeading => _flags['isHeading'] as bool;
121

122 123 124
  /// Whether the node represents a password field.
  ///
  /// Equivalent to [SemanticsFlag.isObscured].
125
  bool get isPassword => _flags['isPassword'] as bool;
126 127 128 129

  /// Whether the node is long clickable.
  ///
  /// Equivalent to having [SemanticsAction.longPress].
130
  bool get isLongClickable => _flags['isLongClickable'] as bool;
131 132 133

  /// Gets a [Rect] which defines the position and size of the semantics node.
  Rect getRect() {
134
    final Map<String, Object> rawRect = _values['rect'] as Map<String, Object>;
135
    final Map<String, int> rect = rawRect.cast<String, int>();
136
    return Rect.fromLTRB(
137 138 139 140 141 142 143 144 145 146
      rect['left'].toDouble(),
      rect['top'].toDouble(),
      rect['right'].toDouble(),
      rect['bottom'].toDouble(),
    );
  }

  /// Gets a [Size] which defines the size of the semantics node.
  Size getSize() {
    final Rect rect = getRect();
147
    return Size(rect.bottom - rect.top, rect.right - rect.left);
148 149 150
  }

  /// Gets a list of [AndroidSemanticsActions] which are defined for the node.
151
  List<AndroidSemanticsAction> getActions() => <AndroidSemanticsAction>[
152
    for (final int id in (_values['actions'] as List<dynamic>).cast<int>()) AndroidSemanticsAction.deserialize(id),
153
  ];
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

  @override
  String toString() {
    return _values.toString();
  }
}


/// A Dart VM implementation of a rectangle.
///
/// Created to mirror the implementation of [ui.Rect].
@immutable
class Rect {
  /// Creates a new rectangle.
  ///
  /// All values are required.
  const Rect.fromLTRB(this.left, this.top, this.right, this.bottom);

  /// The top side of the rectangle.
  final double top;

  /// The left side of the rectangle.
  final double left;

  /// The right side of the rectangle.
  final double right;

  /// The bottom side of the rectangle.
  final double bottom;

  @override
  int get hashCode =>
      top.hashCode ^ left.hashCode ^ right.hashCode ^ bottom.hashCode;

  @override
  bool operator ==(Object other) {
    if (other.runtimeType != runtimeType)
      return false;
192 193 194 195 196
    return other is Rect
        && other.top == top
        && other.left == left
        && other.right == right
        && other.bottom == bottom;
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
  }

  @override
  String toString() => 'Rect.fromLTRB($left, $top, $right, $bottom)';
}

/// A Dart VM implementation of a Size.
///
/// Created to mirror the implementation [ui.Size].
@immutable
class Size {
  /// Creates a new [Size] object.
  const Size(this.width, this.height);

  /// The width of some object.
  final double width;

  /// The height of some object.
  final double height;

  @override
  int get hashCode => width.hashCode ^ height.hashCode;

  @override
  bool operator ==(Object other) {
    if (other.runtimeType != runtimeType)
      return false;
224 225 226
    return other is Size
        && other.width == width
        && other.height == height;
227 228 229 230 231
  }

  @override
  String toString() => 'Size{$width, $height}';
}