1 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 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 192 193 194 195 196 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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
|
/*
* Copyright (C) 2009 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.view.accessibility;
import static android.accessibilityservice.AccessibilityServiceInfo.FLAG_ENABLE_ACCESSIBILITY_VOLUME;
import android.Manifest;
import android.accessibilityservice.AccessibilityService;
import android.accessibilityservice.AccessibilityServiceInfo;
import android.accessibilityservice.AccessibilityServiceInfo.FeedbackType;
import android.accessibilityservice.AccessibilityShortcutInfo;
import android.annotation.CallbackExecutor;
import android.annotation.ColorInt;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.SdkConstant;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.annotation.UserIdInt;
import android.app.RemoteAction;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.content.pm.ServiceInfo;
import android.content.res.Resources;
import android.os.Binder;
import android.os.Build;
import android.os.Handler;
import android.os.HandlerExecutor;
import android.os.IBinder;
import android.os.Looper;
import android.os.Message;
import android.os.Process;
import android.os.RemoteException;
import android.os.ServiceManager;
import android.os.SystemClock;
import android.os.UserHandle;
import android.util.ArrayMap;
import android.util.Log;
import android.util.SparseArray;
import android.view.IWindow;
import android.view.View;
import android.view.accessibility.AccessibilityEvent.EventType;
import com.android.internal.R;
import com.android.internal.annotations.VisibleForTesting;
import com.android.internal.util.IntPair;
import org.xmlpull.v1.XmlPullParserException;
import java.io.IOException;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Executor;
/**
* System level service that serves as an event dispatch for {@link AccessibilityEvent}s,
* and provides facilities for querying the accessibility state of the system.
* Accessibility events are generated when something notable happens in the user interface,
* for example an {@link android.app.Activity} starts, the focus or selection of a
* {@link android.view.View} changes etc. Parties interested in handling accessibility
* events implement and register an accessibility service which extends
* {@link android.accessibilityservice.AccessibilityService}.
*
* @see AccessibilityEvent
* @see AccessibilityNodeInfo
* @see android.accessibilityservice.AccessibilityService
* @see Context#getSystemService
* @see Context#ACCESSIBILITY_SERVICE
*/
@SystemService(Context.ACCESSIBILITY_SERVICE)
public final class AccessibilityManager {
private static final boolean DEBUG = false;
private static final String LOG_TAG = "AccessibilityManager";
/** @hide */
public static final int STATE_FLAG_ACCESSIBILITY_ENABLED = 0x00000001;
/** @hide */
public static final int STATE_FLAG_TOUCH_EXPLORATION_ENABLED = 0x00000002;
/** @hide */
public static final int STATE_FLAG_HIGH_TEXT_CONTRAST_ENABLED = 0x00000004;
/** @hide */
public static final int STATE_FLAG_DISPATCH_DOUBLE_TAP = 0x00000008;
/** @hide */
public static final int STATE_FLAG_REQUEST_MULTI_FINGER_GESTURES = 0x00000010;
/** @hide */
public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_ENABLED = 0x00000100;
/** @hide */
public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_CB_ENABLED = 0x00000200;
/** @hide */
public static final int STATE_FLAG_TRACE_A11Y_INTERACTION_CLIENT_ENABLED = 0x00000400;
/** @hide */
public static final int STATE_FLAG_TRACE_A11Y_SERVICE_ENABLED = 0x00000800;
/** @hide */
public static final int STATE_FLAG_AUDIO_DESCRIPTION_BY_DEFAULT_ENABLED = 0x00001000;
/** @hide */
public static final int DALTONIZER_DISABLED = -1;
/** @hide */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final int DALTONIZER_SIMULATE_MONOCHROMACY = 0;
/** @hide */
public static final int DALTONIZER_CORRECT_DEUTERANOMALY = 12;
/** @hide */
public static final int AUTOCLICK_DELAY_DEFAULT = 600;
/**
* Activity action: Launch UI to manage which accessibility service or feature is assigned
* to the navigation bar Accessibility button.
* <p>
* Input: Nothing.
* </p>
* <p>
* Output: Nothing.
* </p>
*
* @hide
*/
@SdkConstant(SdkConstant.SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_CHOOSE_ACCESSIBILITY_BUTTON =
"com.android.internal.intent.action.CHOOSE_ACCESSIBILITY_BUTTON";
/**
* Used as an int value for accessibility chooser activity to represent the accessibility button
* shortcut type.
*
* @hide
*/
public static final int ACCESSIBILITY_BUTTON = 0;
/**
* Used as an int value for accessibility chooser activity to represent hardware key shortcut,
* such as volume key button.
*
* @hide
*/
public static final int ACCESSIBILITY_SHORTCUT_KEY = 1;
/**
* Annotations for the shortcut type.
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(value = {
ACCESSIBILITY_BUTTON,
ACCESSIBILITY_SHORTCUT_KEY
})
public @interface ShortcutType {}
/**
* Annotations for content flag of UI.
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "FLAG_CONTENT_" }, value = {
FLAG_CONTENT_ICONS,
FLAG_CONTENT_TEXT,
FLAG_CONTENT_CONTROLS
})
public @interface ContentFlag {}
/**
* Use this flag to indicate the content of a UI that times out contains icons.
*
* @see #getRecommendedTimeoutMillis(int, int)
*/
public static final int FLAG_CONTENT_ICONS = 1;
/**
* Use this flag to indicate the content of a UI that times out contains text.
*
* @see #getRecommendedTimeoutMillis(int, int)
*/
public static final int FLAG_CONTENT_TEXT = 2;
/**
* Use this flag to indicate the content of a UI that times out contains interactive controls.
*
* @see #getRecommendedTimeoutMillis(int, int)
*/
public static final int FLAG_CONTENT_CONTROLS = 4;
@UnsupportedAppUsage
static final Object sInstanceSync = new Object();
@UnsupportedAppUsage
private static AccessibilityManager sInstance;
@UnsupportedAppUsage
private final Object mLock = new Object();
@UnsupportedAppUsage
private IAccessibilityManager mService;
@UnsupportedAppUsage
final int mUserId;
@UnsupportedAppUsage
final Handler mHandler;
final Handler.Callback mCallback;
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
boolean mIsEnabled;
int mRelevantEventTypes = AccessibilityEvent.TYPES_ALL_MASK;
int mInteractiveUiTimeout;
int mNonInteractiveUiTimeout;
boolean mIsTouchExplorationEnabled;
@UnsupportedAppUsage(trackingBug = 123768939L)
boolean mIsHighTextContrastEnabled;
boolean mIsAudioDescriptionByDefaultRequested;
// accessibility tracing state
int mAccessibilityTracingState = 0;
AccessibilityPolicy mAccessibilityPolicy;
private int mPerformingAction = 0;
/** The stroke width of the focus rectangle in pixels */
private int mFocusStrokeWidth;
/** The color of the focus rectangle */
private int mFocusColor;
@UnsupportedAppUsage
private final ArrayMap<AccessibilityStateChangeListener, Handler>
mAccessibilityStateChangeListeners = new ArrayMap<>();
private final ArrayMap<TouchExplorationStateChangeListener, Handler>
mTouchExplorationStateChangeListeners = new ArrayMap<>();
private final ArrayMap<HighTextContrastChangeListener, Handler>
mHighTextContrastStateChangeListeners = new ArrayMap<>();
private final ArrayMap<AccessibilityServicesStateChangeListener, Executor>
mServicesStateChangeListeners = new ArrayMap<>();
private final ArrayMap<AudioDescriptionRequestedChangeListener, Executor>
mAudioDescriptionRequestedChangeListeners = new ArrayMap<>();
/**
* Map from a view's accessibility id to the list of request preparers set for that view
*/
private SparseArray<List<AccessibilityRequestPreparer>> mRequestPreparerLists;
/**
* Listener for the system accessibility state. To listen for changes to the
* accessibility state on the device, implement this interface and register
* it with the system by calling {@link #addAccessibilityStateChangeListener}.
*/
public interface AccessibilityStateChangeListener {
/**
* Called when the accessibility enabled state changes.
*
* @param enabled Whether accessibility is enabled.
*/
void onAccessibilityStateChanged(boolean enabled);
}
/**
* Listener for the system touch exploration state. To listen for changes to
* the touch exploration state on the device, implement this interface and
* register it with the system by calling
* {@link #addTouchExplorationStateChangeListener}.
*/
public interface TouchExplorationStateChangeListener {
/**
* Called when the touch exploration enabled state changes.
*
* @param enabled Whether touch exploration is enabled.
*/
void onTouchExplorationStateChanged(boolean enabled);
}
/**
* Listener for changes to the state of accessibility services.
*
* <p>
* This refers to changes to {@link AccessibilityServiceInfo}, including:
* <ul>
* <li>Whenever a service is enabled or disabled, or its info has been set or removed.</li>
* <li>Whenever a metadata attribute of any running service's info changes.</li>
* </ul>
*
* @see #getEnabledAccessibilityServiceList for a list of infos of the enabled accessibility
* services.
* @see #addAccessibilityServicesStateChangeListener
*
*/
public interface AccessibilityServicesStateChangeListener {
/**
* Called when the state of accessibility services changes.
*
* @param manager The manager that is calling back
*/
void onAccessibilityServicesStateChanged(@NonNull AccessibilityManager manager);
}
/**
* Listener for the system high text contrast state. To listen for changes to
* the high text contrast state on the device, implement this interface and
* register it with the system by calling
* {@link #addHighTextContrastStateChangeListener}.
*
* @hide
*/
public interface HighTextContrastChangeListener {
/**
* Called when the high text contrast enabled state changes.
*
* @param enabled Whether high text contrast is enabled.
*/
void onHighTextContrastStateChanged(boolean enabled);
}
/**
* Listener for the audio description by default state. To listen for
* changes to the audio description by default state on the device,
* implement this interface and register it with the system by calling
* {@link #addAudioDescriptionRequestedChangeListener}.
*/
public interface AudioDescriptionRequestedChangeListener {
/**
* Called when the audio description enabled state changes.
*
* @param enabled Whether audio description by default is enabled.
*/
void onAudioDescriptionRequestedChanged(boolean enabled);
}
/**
* Policy to inject behavior into the accessibility manager.
*
* @hide
*/
public interface AccessibilityPolicy {
/**
* Checks whether accessibility is enabled.
*
* @param accessibilityEnabled Whether the accessibility layer is enabled.
* @return whether accessibility is enabled.
*/
boolean isEnabled(boolean accessibilityEnabled);
/**
* Notifies the policy for an accessibility event.
*
* @param event The event.
* @param accessibilityEnabled Whether the accessibility layer is enabled.
* @param relevantEventTypes The events relevant events.
* @return The event to dispatch or null.
*/
@Nullable AccessibilityEvent onAccessibilityEvent(@NonNull AccessibilityEvent event,
boolean accessibilityEnabled, @EventType int relevantEventTypes);
/**
* Gets the list of relevant events.
*
* @param relevantEventTypes The relevant events.
* @return The relevant events to report.
*/
@EventType int getRelevantEventTypes(@EventType int relevantEventTypes);
/**
* Gets the list of installed services to report.
*
* @param installedService The installed services.
* @return The services to report.
*/
@NonNull List<AccessibilityServiceInfo> getInstalledAccessibilityServiceList(
@Nullable List<AccessibilityServiceInfo> installedService);
/**
* Gets the list of enabled accessibility services.
*
* @param feedbackTypeFlags The feedback type to query for.
* @param enabledService The enabled services.
* @return The services to report.
*/
@Nullable List<AccessibilityServiceInfo> getEnabledAccessibilityServiceList(
@FeedbackType int feedbackTypeFlags,
@Nullable List<AccessibilityServiceInfo> enabledService);
}
private final IAccessibilityManagerClient.Stub mClient =
new IAccessibilityManagerClient.Stub() {
@Override
public void setState(int state) {
// We do not want to change this immediately as the application may
// have already checked that accessibility is on and fired an event,
// that is now propagating up the view tree, Hence, if accessibility
// is now off an exception will be thrown. We want to have the exception
// enforcement to guard against apps that fire unnecessary accessibility
// events when accessibility is off.
mHandler.obtainMessage(MyCallback.MSG_SET_STATE, state, 0).sendToTarget();
}
@Override
public void notifyServicesStateChanged(long updatedUiTimeout) {
updateUiTimeout(updatedUiTimeout);
final ArrayMap<AccessibilityServicesStateChangeListener, Executor> listeners;
synchronized (mLock) {
if (mServicesStateChangeListeners.isEmpty()) {
return;
}
listeners = new ArrayMap<>(mServicesStateChangeListeners);
}
int numListeners = listeners.size();
for (int i = 0; i < numListeners; i++) {
final AccessibilityServicesStateChangeListener listener =
mServicesStateChangeListeners.keyAt(i);
mServicesStateChangeListeners.valueAt(i).execute(() -> listener
.onAccessibilityServicesStateChanged(AccessibilityManager.this));
}
}
@Override
public void setRelevantEventTypes(int eventTypes) {
mRelevantEventTypes = eventTypes;
}
@Override
public void setFocusAppearance(int strokeWidth, int color) {
synchronized (mLock) {
updateFocusAppearanceLocked(strokeWidth, color);
}
}
};
/**
* Get an AccessibilityManager instance (create one if necessary).
*
* @param context Context in which this manager operates.
*
* @hide
*/
@UnsupportedAppUsage
public static AccessibilityManager getInstance(Context context) {
synchronized (sInstanceSync) {
if (sInstance == null) {
final int userId;
if (Binder.getCallingUid() == Process.SYSTEM_UID
|| context.checkCallingOrSelfPermission(
Manifest.permission.INTERACT_ACROSS_USERS)
== PackageManager.PERMISSION_GRANTED
|| context.checkCallingOrSelfPermission(
Manifest.permission.INTERACT_ACROSS_USERS_FULL)
== PackageManager.PERMISSION_GRANTED) {
userId = UserHandle.USER_CURRENT;
} else {
userId = context.getUserId();
}
sInstance = new AccessibilityManager(context, null, userId);
}
}
return sInstance;
}
/**
* Create an instance.
*
* @param context A {@link Context}.
* @param service An interface to the backing service.
* @param userId User id under which to run.
*
* @hide
*/
public AccessibilityManager(Context context, IAccessibilityManager service, int userId) {
// Constructor can't be chained because we can't create an instance of an inner class
// before calling another constructor.
mCallback = new MyCallback();
mHandler = new Handler(context.getMainLooper(), mCallback);
mUserId = userId;
synchronized (mLock) {
initialFocusAppearanceLocked(context.getResources());
tryConnectToServiceLocked(service);
}
}
/**
* Create an instance.
*
* @param context A {@link Context}.
* @param handler The handler to use
* @param service An interface to the backing service.
* @param userId User id under which to run.
* @param serviceConnect {@code true} to connect the service or
* {@code false} not to connect the service.
*
* @hide
*/
@VisibleForTesting
public AccessibilityManager(Context context, Handler handler, IAccessibilityManager service,
int userId, boolean serviceConnect) {
mCallback = new MyCallback();
mHandler = handler;
mUserId = userId;
synchronized (mLock) {
initialFocusAppearanceLocked(context.getResources());
if (serviceConnect) {
tryConnectToServiceLocked(service);
}
}
}
/**
* @hide
*/
public IAccessibilityManagerClient getClient() {
return mClient;
}
/**
* Unregisters the IAccessibilityManagerClient from the backing service
* @hide
*/
public boolean removeClient() {
synchronized (mLock) {
IAccessibilityManager service = getServiceLocked();
if (service == null) {
return false;
}
try {
return service.removeClient(mClient, mUserId);
} catch (RemoteException re) {
Log.e(LOG_TAG, "AccessibilityManagerService is dead", re);
}
}
return false;
}
/**
* @hide
*/
@VisibleForTesting
public Handler.Callback getCallback() {
return mCallback;
}
/**
* Returns if the accessibility in the system is enabled.
*
* @return True if accessibility is enabled, false otherwise.
*/
public boolean isEnabled() {
synchronized (mLock) {
return mIsEnabled || (mAccessibilityPolicy != null
&& mAccessibilityPolicy.isEnabled(mIsEnabled));
}
}
/**
* Returns if the touch exploration in the system is enabled.
*
* @return True if touch exploration is enabled, false otherwise.
*/
public boolean isTouchExplorationEnabled() {
synchronized (mLock) {
IAccessibilityManager service = getServiceLocked();
if (service == null) {
return false;
}
return mIsTouchExplorationEnabled;
}
}
/**
* Returns if the high text contrast in the system is enabled.
* <p>
* <strong>Note:</strong> You need to query this only if you application is
* doing its own rendering and does not rely on the platform rendering pipeline.
* </p>
*
* @return True if high text contrast is enabled, false otherwise.
*
* @hide
*/
@UnsupportedAppUsage
public boolean isHighTextContrastEnabled() {
synchronized (mLock) {
IAccessibilityManager service = getServiceLocked();
if (service == null) {
return false;
}
return mIsHighTextContrastEnabled;
}
}
/**
* Sends an {@link AccessibilityEvent}.
*
* @param event The event to send.
*
* @throws IllegalStateException if accessibility is not enabled.
*
* <strong>Note:</strong> The preferred mechanism for sending custom accessibility
* events is through calling
* {@link android.view.ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
* instead of this method to allow predecessors to augment/filter events sent by
* their descendants.
*/
public void sendAccessibilityEvent(AccessibilityEvent event) {
final IAccessibilityManager service;
final int userId;
final AccessibilityEvent dispatchedEvent;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
event.setEventTime(SystemClock.uptimeMillis());
if (event.getAction() == 0) {
event.setAction(mPerformingAction);
}
if (mAccessibilityPolicy != null) {
dispatchedEvent = mAccessibilityPolicy.onAccessibilityEvent(event,
mIsEnabled, mRelevantEventTypes);
if (dispatchedEvent == null) {
return;
}
} else {
dispatchedEvent = event;
}
if (!isEnabled()) {
Looper myLooper = Looper.myLooper();
if (myLooper == Looper.getMainLooper()) {
throw new IllegalStateException(
"Accessibility off. Did you forget to check that?");
} else {
// If we're not running on the thread with the main looper, it's possible for
// the state of accessibility to change between checking isEnabled and
// calling this method. So just log the error rather than throwing the
// exception.
Log.e(LOG_TAG, "AccessibilityEvent sent with accessibility disabled");
return;
}
}
if ((dispatchedEvent.getEventType() & mRelevantEventTypes) == 0) {
if (DEBUG) {
Log.i(LOG_TAG, "Not dispatching irrelevant event: " + dispatchedEvent
+ " that is not among "
+ AccessibilityEvent.eventTypeToString(mRelevantEventTypes));
}
return;
}
userId = mUserId;
}
try {
// it is possible that this manager is in the same process as the service but
// client using it is called through Binder from another process. Example: MMS
// app adds a SMS notification and the NotificationManagerService calls this method
final long identityToken = Binder.clearCallingIdentity();
try {
service.sendAccessibilityEvent(dispatchedEvent, userId);
} finally {
Binder.restoreCallingIdentity(identityToken);
}
if (DEBUG) {
Log.i(LOG_TAG, dispatchedEvent + " sent");
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error during sending " + dispatchedEvent + " ", re);
} finally {
if (event != dispatchedEvent) {
event.recycle();
}
dispatchedEvent.recycle();
}
}
/**
* Requests feedback interruption from all accessibility services.
*/
public void interrupt() {
final IAccessibilityManager service;
final int userId;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
if (!isEnabled()) {
Looper myLooper = Looper.myLooper();
if (myLooper == Looper.getMainLooper()) {
throw new IllegalStateException(
"Accessibility off. Did you forget to check that?");
} else {
// If we're not running on the thread with the main looper, it's possible for
// the state of accessibility to change between checking isEnabled and
// calling this method. So just log the error rather than throwing the
// exception.
Log.e(LOG_TAG, "Interrupt called with accessibility disabled");
return;
}
}
userId = mUserId;
}
try {
service.interrupt(userId);
if (DEBUG) {
Log.i(LOG_TAG, "Requested interrupt from all services");
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while requesting interrupt from all services. ", re);
}
}
/**
* Returns the {@link ServiceInfo}s of the installed accessibility services.
*
* @return An unmodifiable list with {@link ServiceInfo}s.
*
* @deprecated Use {@link #getInstalledAccessibilityServiceList()}
*/
@Deprecated
public List<ServiceInfo> getAccessibilityServiceList() {
List<AccessibilityServiceInfo> infos = getInstalledAccessibilityServiceList();
List<ServiceInfo> services = new ArrayList<>();
final int infoCount = infos.size();
for (int i = 0; i < infoCount; i++) {
AccessibilityServiceInfo info = infos.get(i);
services.add(info.getResolveInfo().serviceInfo);
}
return Collections.unmodifiableList(services);
}
/**
* Returns the {@link AccessibilityServiceInfo}s of the installed accessibility services.
*
* @return An unmodifiable list with {@link AccessibilityServiceInfo}s.
*/
public List<AccessibilityServiceInfo> getInstalledAccessibilityServiceList() {
final IAccessibilityManager service;
final int userId;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return Collections.emptyList();
}
userId = mUserId;
}
List<AccessibilityServiceInfo> services = null;
try {
services = service.getInstalledAccessibilityServiceList(userId);
if (DEBUG) {
Log.i(LOG_TAG, "Installed AccessibilityServices " + services);
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while obtaining the installed AccessibilityServices. ", re);
}
if (mAccessibilityPolicy != null) {
services = mAccessibilityPolicy.getInstalledAccessibilityServiceList(services);
}
if (services != null) {
return Collections.unmodifiableList(services);
} else {
return Collections.emptyList();
}
}
/**
* Returns the {@link AccessibilityServiceInfo}s of the enabled accessibility services
* for a given feedback type.
*
* @param feedbackTypeFlags The feedback type flags.
* @return An unmodifiable list with {@link AccessibilityServiceInfo}s.
*
* @see AccessibilityServiceInfo#FEEDBACK_AUDIBLE
* @see AccessibilityServiceInfo#FEEDBACK_GENERIC
* @see AccessibilityServiceInfo#FEEDBACK_HAPTIC
* @see AccessibilityServiceInfo#FEEDBACK_SPOKEN
* @see AccessibilityServiceInfo#FEEDBACK_VISUAL
* @see AccessibilityServiceInfo#FEEDBACK_BRAILLE
*/
public List<AccessibilityServiceInfo> getEnabledAccessibilityServiceList(
int feedbackTypeFlags) {
final IAccessibilityManager service;
final int userId;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return Collections.emptyList();
}
userId = mUserId;
}
List<AccessibilityServiceInfo> services = null;
try {
services = service.getEnabledAccessibilityServiceList(feedbackTypeFlags, userId);
if (DEBUG) {
Log.i(LOG_TAG, "Enabled AccessibilityServices " + services);
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while obtaining the enabled AccessibilityServices. ", re);
}
if (mAccessibilityPolicy != null) {
services = mAccessibilityPolicy.getEnabledAccessibilityServiceList(
feedbackTypeFlags, services);
}
if (services != null) {
return Collections.unmodifiableList(services);
} else {
return Collections.emptyList();
}
}
/**
* Registers an {@link AccessibilityStateChangeListener} for changes in
* the global accessibility state of the system. Equivalent to calling
* {@link #addAccessibilityStateChangeListener(AccessibilityStateChangeListener, Handler)}
* with a null handler.
*
* @param listener The listener.
* @return Always returns {@code true}.
*/
public boolean addAccessibilityStateChangeListener(
@NonNull AccessibilityStateChangeListener listener) {
addAccessibilityStateChangeListener(listener, null);
return true;
}
/**
* Registers an {@link AccessibilityStateChangeListener} for changes in
* the global accessibility state of the system. If the listener has already been registered,
* the handler used to call it back is updated.
*
* @param listener The listener.
* @param handler The handler on which the listener should be called back, or {@code null}
* for a callback on the process's main handler.
*/
public void addAccessibilityStateChangeListener(
@NonNull AccessibilityStateChangeListener listener, @Nullable Handler handler) {
synchronized (mLock) {
mAccessibilityStateChangeListeners
.put(listener, (handler == null) ? mHandler : handler);
}
}
/**
* Unregisters an {@link AccessibilityStateChangeListener}.
*
* @param listener The listener.
* @return True if the listener was previously registered.
*/
public boolean removeAccessibilityStateChangeListener(
@NonNull AccessibilityStateChangeListener listener) {
synchronized (mLock) {
int index = mAccessibilityStateChangeListeners.indexOfKey(listener);
mAccessibilityStateChangeListeners.remove(listener);
return (index >= 0);
}
}
/**
* Registers a {@link TouchExplorationStateChangeListener} for changes in
* the global touch exploration state of the system. Equivalent to calling
* {@link #addTouchExplorationStateChangeListener(TouchExplorationStateChangeListener, Handler)}
* with a null handler.
*
* @param listener The listener.
* @return Always returns {@code true}.
*/
public boolean addTouchExplorationStateChangeListener(
@NonNull TouchExplorationStateChangeListener listener) {
addTouchExplorationStateChangeListener(listener, null);
return true;
}
/**
* Registers an {@link TouchExplorationStateChangeListener} for changes in
* the global touch exploration state of the system. If the listener has already been
* registered, the handler used to call it back is updated.
*
* @param listener The listener.
* @param handler The handler on which the listener should be called back, or {@code null}
* for a callback on the process's main handler.
*/
public void addTouchExplorationStateChangeListener(
@NonNull TouchExplorationStateChangeListener listener, @Nullable Handler handler) {
synchronized (mLock) {
mTouchExplorationStateChangeListeners
.put(listener, (handler == null) ? mHandler : handler);
}
}
/**
* Unregisters a {@link TouchExplorationStateChangeListener}.
*
* @param listener The listener.
* @return True if listener was previously registered.
*/
public boolean removeTouchExplorationStateChangeListener(
@NonNull TouchExplorationStateChangeListener listener) {
synchronized (mLock) {
int index = mTouchExplorationStateChangeListeners.indexOfKey(listener);
mTouchExplorationStateChangeListeners.remove(listener);
return (index >= 0);
}
}
/**
* Registers a {@link AccessibilityServicesStateChangeListener}.
*
* @param executor The executor.
* @param listener The listener.
*/
public void addAccessibilityServicesStateChangeListener(
@NonNull @CallbackExecutor Executor executor,
@NonNull AccessibilityServicesStateChangeListener listener) {
synchronized (mLock) {
mServicesStateChangeListeners.put(listener, executor);
}
}
/**
* Registers a {@link AccessibilityServicesStateChangeListener}. This will execute a callback on
* the process's main handler.
*
* @param listener The listener.
*
*/
public void addAccessibilityServicesStateChangeListener(
@NonNull AccessibilityServicesStateChangeListener listener) {
addAccessibilityServicesStateChangeListener(new HandlerExecutor(mHandler), listener);
}
/**
* Unregisters a {@link AccessibilityServicesStateChangeListener}.
*
* @param listener The listener.
* @return {@code true} if the listener was previously registered.
*/
public boolean removeAccessibilityServicesStateChangeListener(
@NonNull AccessibilityServicesStateChangeListener listener) {
synchronized (mLock) {
return mServicesStateChangeListeners.remove(listener) != null;
}
}
/**
* Registers a {@link AccessibilityRequestPreparer}.
*/
public void addAccessibilityRequestPreparer(AccessibilityRequestPreparer preparer) {
if (mRequestPreparerLists == null) {
mRequestPreparerLists = new SparseArray<>(1);
}
int id = preparer.getAccessibilityViewId();
List<AccessibilityRequestPreparer> requestPreparerList = mRequestPreparerLists.get(id);
if (requestPreparerList == null) {
requestPreparerList = new ArrayList<>(1);
mRequestPreparerLists.put(id, requestPreparerList);
}
requestPreparerList.add(preparer);
}
/**
* Unregisters a {@link AccessibilityRequestPreparer}.
*/
public void removeAccessibilityRequestPreparer(AccessibilityRequestPreparer preparer) {
if (mRequestPreparerLists == null) {
return;
}
int viewId = preparer.getAccessibilityViewId();
List<AccessibilityRequestPreparer> requestPreparerList = mRequestPreparerLists.get(viewId);
if (requestPreparerList != null) {
requestPreparerList.remove(preparer);
if (requestPreparerList.isEmpty()) {
mRequestPreparerLists.remove(viewId);
}
}
}
/**
* Get the recommended timeout for changes to the UI needed by this user. Controls should remain
* on the screen for at least this long to give users time to react. Some users may need
* extra time to review the controls, or to reach them, or to activate assistive technology
* to activate the controls automatically.
* <p>
* Use the combination of content flags to indicate contents of UI. For example, use
* {@code FLAG_CONTENT_ICONS | FLAG_CONTENT_TEXT} for message notification which contains
* icons and text, or use {@code FLAG_CONTENT_TEXT | FLAG_CONTENT_CONTROLS} for button dialog
* which contains text and button controls.
* <p/>
*
* @param originalTimeout The timeout appropriate for users with no accessibility needs.
* @param uiContentFlags The combination of flags {@link #FLAG_CONTENT_ICONS},
* {@link #FLAG_CONTENT_TEXT} or {@link #FLAG_CONTENT_CONTROLS} to
* indicate the contents of UI.
* @return The recommended UI timeout for the current user in milliseconds.
*/
public int getRecommendedTimeoutMillis(int originalTimeout, @ContentFlag int uiContentFlags) {
boolean hasControls = (uiContentFlags & FLAG_CONTENT_CONTROLS) != 0;
boolean hasIconsOrText = (uiContentFlags & FLAG_CONTENT_ICONS) != 0
|| (uiContentFlags & FLAG_CONTENT_TEXT) != 0;
int recommendedTimeout = originalTimeout;
if (hasControls) {
recommendedTimeout = Math.max(recommendedTimeout, mInteractiveUiTimeout);
}
if (hasIconsOrText) {
recommendedTimeout = Math.max(recommendedTimeout, mNonInteractiveUiTimeout);
}
return recommendedTimeout;
}
/**
* Gets the strokeWidth of the focus rectangle. This value can be set by
* {@link AccessibilityService}.
*
* @return The strokeWidth of the focus rectangle in pixels.
*
*/
public int getAccessibilityFocusStrokeWidth() {
synchronized (mLock) {
return mFocusStrokeWidth;
}
}
/**
* Gets the color of the focus rectangle. This value can be set by
* {@link AccessibilityService}.
*
* @return The color of the focus rectangle.
*
*/
public @ColorInt int getAccessibilityFocusColor() {
synchronized (mLock) {
return mFocusColor;
}
}
/**
* Gets accessibility interaction connection tracing enabled state.
*
* @hide
*/
public boolean isA11yInteractionConnectionTraceEnabled() {
synchronized (mLock) {
return ((mAccessibilityTracingState
& STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_ENABLED) != 0);
}
}
/**
* Gets accessibility interaction connection callback tracing enabled state.
*
* @hide
*/
public boolean isA11yInteractionConnectionCBTraceEnabled() {
synchronized (mLock) {
return ((mAccessibilityTracingState
& STATE_FLAG_TRACE_A11Y_INTERACTION_CONNECTION_CB_ENABLED) != 0);
}
}
/**
* Gets accessibility interaction client tracing enabled state.
*
* @hide
*/
public boolean isA11yInteractionClientTraceEnabled() {
synchronized (mLock) {
return ((mAccessibilityTracingState
& STATE_FLAG_TRACE_A11Y_INTERACTION_CLIENT_ENABLED) != 0);
}
}
/**
* Gets accessibility service tracing enabled state.
*
* @hide
*/
public boolean isA11yServiceTraceEnabled() {
synchronized (mLock) {
return ((mAccessibilityTracingState
& STATE_FLAG_TRACE_A11Y_SERVICE_ENABLED) != 0);
}
}
/**
* Get the preparers that are registered for an accessibility ID
*
* @param id The ID of interest
* @return The list of preparers, or {@code null} if there are none.
*
* @hide
*/
public List<AccessibilityRequestPreparer> getRequestPreparersForAccessibilityId(int id) {
if (mRequestPreparerLists == null) {
return null;
}
return mRequestPreparerLists.get(id);
}
/**
* Set the currently performing accessibility action in views.
*
* @param actionId the action id of {@link AccessibilityNodeInfo.AccessibilityAction}.
* @hide
*/
public void notifyPerformingAction(int actionId) {
mPerformingAction = actionId;
}
/**
* Registers a {@link HighTextContrastChangeListener} for changes in
* the global high text contrast state of the system.
*
* @param listener The listener.
*
* @hide
*/
public void addHighTextContrastStateChangeListener(
@NonNull HighTextContrastChangeListener listener, @Nullable Handler handler) {
synchronized (mLock) {
mHighTextContrastStateChangeListeners
.put(listener, (handler == null) ? mHandler : handler);
}
}
/**
* Unregisters a {@link HighTextContrastChangeListener}.
*
* @param listener The listener.
*
* @hide
*/
public void removeHighTextContrastStateChangeListener(
@NonNull HighTextContrastChangeListener listener) {
synchronized (mLock) {
mHighTextContrastStateChangeListeners.remove(listener);
}
}
/**
* Registers a {@link AudioDescriptionRequestedChangeListener}
* for changes in the audio description by default state of the system.
* The value could be read via {@link #isAudioDescriptionRequested}.
*
* @param executor The executor on which the listener should be called back.
* @param listener The listener.
*/
public void addAudioDescriptionRequestedChangeListener(
@NonNull Executor executor,
@NonNull AudioDescriptionRequestedChangeListener listener) {
synchronized (mLock) {
mAudioDescriptionRequestedChangeListeners.put(listener, executor);
}
}
/**
* Unregisters a {@link AudioDescriptionRequestedChangeListener}.
*
* @param listener The listener.
* @return True if listener was previously registered.
*/
public boolean removeAudioDescriptionRequestedChangeListener(
@NonNull AudioDescriptionRequestedChangeListener listener) {
synchronized (mLock) {
return (mAudioDescriptionRequestedChangeListeners.remove(listener) != null);
}
}
/**
* Sets the {@link AccessibilityPolicy} controlling this manager.
*
* @param policy The policy.
*
* @hide
*/
public void setAccessibilityPolicy(@Nullable AccessibilityPolicy policy) {
synchronized (mLock) {
mAccessibilityPolicy = policy;
}
}
/**
* Check if the accessibility volume stream is active.
*
* @return True if accessibility volume is active (i.e. some service has requested it). False
* otherwise.
* @hide
*/
public boolean isAccessibilityVolumeStreamActive() {
List<AccessibilityServiceInfo> serviceInfos =
getEnabledAccessibilityServiceList(AccessibilityServiceInfo.FEEDBACK_ALL_MASK);
for (int i = 0; i < serviceInfos.size(); i++) {
if ((serviceInfos.get(i).flags & FLAG_ENABLE_ACCESSIBILITY_VOLUME) != 0) {
return true;
}
}
return false;
}
/**
* Report a fingerprint gesture to accessibility. Only available for the system process.
*
* @param keyCode The key code of the gesture
* @return {@code true} if accessibility consumes the event. {@code false} if not.
* @hide
*/
public boolean sendFingerprintGesture(int keyCode) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return false;
}
}
try {
return service.sendFingerprintGesture(keyCode);
} catch (RemoteException e) {
return false;
}
}
/**
* Returns accessibility window id from window token. Accessibility window id is the one
* returned from AccessibilityWindowInfo.getId(). Only available for the system process.
*
* @param windowToken Window token to find accessibility window id.
* @return Accessibility window id for the window token.
* AccessibilityWindowInfo.UNDEFINED_WINDOW_ID if accessibility window id not available for
* the token.
* @hide
*/
@SystemApi
public int getAccessibilityWindowId(@Nullable IBinder windowToken) {
if (windowToken == null) {
return AccessibilityWindowInfo.UNDEFINED_WINDOW_ID;
}
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return AccessibilityWindowInfo.UNDEFINED_WINDOW_ID;
}
}
try {
return service.getAccessibilityWindowId(windowToken);
} catch (RemoteException e) {
return AccessibilityWindowInfo.UNDEFINED_WINDOW_ID;
}
}
/**
* Associate the connection between the host View and the embedded SurfaceControlViewHost.
*
* @hide
*/
public void associateEmbeddedHierarchy(@NonNull IBinder host, @NonNull IBinder embedded) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.associateEmbeddedHierarchy(host, embedded);
} catch (RemoteException e) {
return;
}
}
/**
* Disassociate the connection between the host View and the embedded SurfaceControlViewHost.
* The given token could be either from host side or embedded side.
*
* @hide
*/
public void disassociateEmbeddedHierarchy(@NonNull IBinder token) {
if (token == null) {
return;
}
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.disassociateEmbeddedHierarchy(token);
} catch (RemoteException e) {
return;
}
}
/**
* Sets the current state and notifies listeners, if necessary.
*
* @param stateFlags The state flags.
*/
@UnsupportedAppUsage
private void setStateLocked(int stateFlags) {
final boolean enabled = (stateFlags & STATE_FLAG_ACCESSIBILITY_ENABLED) != 0;
final boolean touchExplorationEnabled =
(stateFlags & STATE_FLAG_TOUCH_EXPLORATION_ENABLED) != 0;
final boolean highTextContrastEnabled =
(stateFlags & STATE_FLAG_HIGH_TEXT_CONTRAST_ENABLED) != 0;
final boolean audioDescriptionEnabled =
(stateFlags & STATE_FLAG_AUDIO_DESCRIPTION_BY_DEFAULT_ENABLED) != 0;
final boolean wasEnabled = isEnabled();
final boolean wasTouchExplorationEnabled = mIsTouchExplorationEnabled;
final boolean wasHighTextContrastEnabled = mIsHighTextContrastEnabled;
final boolean wasAudioDescriptionByDefaultRequested = mIsAudioDescriptionByDefaultRequested;
// Ensure listeners get current state from isZzzEnabled() calls.
mIsEnabled = enabled;
mIsTouchExplorationEnabled = touchExplorationEnabled;
mIsHighTextContrastEnabled = highTextContrastEnabled;
mIsAudioDescriptionByDefaultRequested = audioDescriptionEnabled;
if (wasEnabled != isEnabled()) {
notifyAccessibilityStateChanged();
}
if (wasTouchExplorationEnabled != touchExplorationEnabled) {
notifyTouchExplorationStateChanged();
}
if (wasHighTextContrastEnabled != highTextContrastEnabled) {
notifyHighTextContrastStateChanged();
}
if (wasAudioDescriptionByDefaultRequested
!= audioDescriptionEnabled) {
notifyAudioDescriptionbyDefaultStateChanged();
}
updateAccessibilityTracingState(stateFlags);
}
/**
* Find an installed service with the specified {@link ComponentName}.
*
* @param componentName The name to match to the service.
*
* @return The info corresponding to the installed service, or {@code null} if no such service
* is installed.
* @hide
*/
public AccessibilityServiceInfo getInstalledServiceInfoWithComponentName(
ComponentName componentName) {
final List<AccessibilityServiceInfo> installedServiceInfos =
getInstalledAccessibilityServiceList();
if ((installedServiceInfos == null) || (componentName == null)) {
return null;
}
for (int i = 0; i < installedServiceInfos.size(); i++) {
if (componentName.equals(installedServiceInfos.get(i).getComponentName())) {
return installedServiceInfos.get(i);
}
}
return null;
}
/**
* Adds an accessibility interaction connection interface for a given window.
* @param windowToken The window token to which a connection is added.
* @param leashToken The leash token to which a connection is added.
* @param connection The connection.
*
* @hide
*/
public int addAccessibilityInteractionConnection(IWindow windowToken, IBinder leashToken,
String packageName, IAccessibilityInteractionConnection connection) {
final IAccessibilityManager service;
final int userId;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return View.NO_ID;
}
userId = mUserId;
}
try {
return service.addAccessibilityInteractionConnection(windowToken, leashToken,
connection, packageName, userId);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while adding an accessibility interaction connection. ", re);
}
return View.NO_ID;
}
/**
* Removed an accessibility interaction connection interface for a given window.
* @param windowToken The window token to which a connection is removed.
*
* @hide
*/
public void removeAccessibilityInteractionConnection(IWindow windowToken) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.removeAccessibilityInteractionConnection(windowToken);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while removing an accessibility interaction connection. ", re);
}
}
/**
* Perform the accessibility shortcut if the caller has permission.
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)
public void performAccessibilityShortcut() {
performAccessibilityShortcut(null);
}
/**
* Perform the accessibility shortcut for the given target which is assigned to the shortcut.
*
* @param targetName The flattened {@link ComponentName} string or the class name of a system
* class implementing a supported accessibility feature, or {@code null} if there's no
* specified target.
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)
public void performAccessibilityShortcut(@Nullable String targetName) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.performAccessibilityShortcut(targetName);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error performing accessibility shortcut. ", re);
}
}
/**
* Register the provided {@link RemoteAction} with the given actionId
* <p>
* To perform established system actions, an accessibility service uses the GLOBAL_ACTION
* constants in {@link android.accessibilityservice.AccessibilityService}. To provide a
* customized implementation for one of these actions, the id of the registered system action
* must match that of the corresponding GLOBAL_ACTION constant. For example, to register a
* Back action, {@code actionId} must be
* {@link android.accessibilityservice.AccessibilityService#GLOBAL_ACTION_BACK}
* </p>
* @param action The remote action to be registered with the given actionId as system action.
* @param actionId The id uniquely identify the system action.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)
public void registerSystemAction(@NonNull RemoteAction action, int actionId) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.registerSystemAction(action, actionId);
if (DEBUG) {
Log.i(LOG_TAG, "System action " + action.getTitle() + " is registered.");
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error registering system action " + action.getTitle() + " ", re);
}
}
/**
* Unregister a system action with the given actionId
*
* @param actionId The id uniquely identify the system action to be unregistered.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)
public void unregisterSystemAction(int actionId) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.unregisterSystemAction(actionId);
if (DEBUG) {
Log.i(LOG_TAG, "System action with actionId " + actionId + " is unregistered.");
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error unregistering system action with actionId " + actionId + " ", re);
}
}
/**
* Notifies that the accessibility button in the system's navigation area has been clicked
*
* @param displayId The logical display id.
* @hide
*/
@RequiresPermission(android.Manifest.permission.STATUS_BAR_SERVICE)
public void notifyAccessibilityButtonClicked(int displayId) {
notifyAccessibilityButtonClicked(displayId, null);
}
/**
* Perform the accessibility button for the given target which is assigned to the button.
*
* @param displayId displayId The logical display id.
* @param targetName The flattened {@link ComponentName} string or the class name of a system
* class implementing a supported accessibility feature, or {@code null} if there's no
* specified target.
* @hide
*/
@RequiresPermission(android.Manifest.permission.STATUS_BAR_SERVICE)
public void notifyAccessibilityButtonClicked(int displayId, @Nullable String targetName) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.notifyAccessibilityButtonClicked(displayId, targetName);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while dispatching accessibility button click", re);
}
}
/**
* Notifies that the visibility of the accessibility button in the system's navigation area
* has changed.
*
* @param shown {@code true} if the accessibility button is visible within the system
* navigation area, {@code false} otherwise
* @hide
*/
public void notifyAccessibilityButtonVisibilityChanged(boolean shown) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.notifyAccessibilityButtonVisibilityChanged(shown);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error while dispatching accessibility button visibility change", re);
}
}
/**
* Set an IAccessibilityInteractionConnection to replace the actions of a picture-in-picture
* window. Intended for use by the System UI only.
*
* @param connection The connection to handle the actions. Set to {@code null} to avoid
* affecting the actions.
*
* @hide
*/
public void setPictureInPictureActionReplacingConnection(
@Nullable IAccessibilityInteractionConnection connection) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.setPictureInPictureActionReplacingConnection(connection);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error setting picture in picture action replacement", re);
}
}
/**
* Returns the list of shortcut target names currently assigned to the given shortcut.
*
* @param shortcutType The shortcut type.
* @return The list of shortcut target names.
* @hide
*/
@TestApi
@RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)
@NonNull
public List<String> getAccessibilityShortcutTargets(@ShortcutType int shortcutType) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
}
if (service != null) {
try {
return service.getAccessibilityShortcutTargets(shortcutType);
} catch (RemoteException re) {
re.rethrowFromSystemServer();
}
}
return Collections.emptyList();
}
/**
* Returns the {@link AccessibilityShortcutInfo}s of the installed accessibility shortcut
* targets, for specific user.
*
* @param context The context of the application.
* @param userId The user id.
* @return A list with {@link AccessibilityShortcutInfo}s.
* @hide
*/
@NonNull
public List<AccessibilityShortcutInfo> getInstalledAccessibilityShortcutListAsUser(
@NonNull Context context, @UserIdInt int userId) {
final List<AccessibilityShortcutInfo> shortcutInfos = new ArrayList<>();
final int flags = PackageManager.GET_ACTIVITIES
| PackageManager.GET_META_DATA
| PackageManager.MATCH_DISABLED_UNTIL_USED_COMPONENTS
| PackageManager.MATCH_DIRECT_BOOT_AWARE
| PackageManager.MATCH_DIRECT_BOOT_UNAWARE;
final Intent actionMain = new Intent(Intent.ACTION_MAIN);
actionMain.addCategory(Intent.CATEGORY_ACCESSIBILITY_SHORTCUT_TARGET);
final PackageManager packageManager = context.getPackageManager();
final List<ResolveInfo> installedShortcutList =
packageManager.queryIntentActivitiesAsUser(actionMain, flags, userId);
for (int i = 0; i < installedShortcutList.size(); i++) {
final AccessibilityShortcutInfo shortcutInfo =
getShortcutInfo(context, installedShortcutList.get(i));
if (shortcutInfo != null) {
shortcutInfos.add(shortcutInfo);
}
}
return shortcutInfos;
}
/**
* Returns an {@link AccessibilityShortcutInfo} according to the given {@link ResolveInfo} of
* an activity.
*
* @param context The context of the application.
* @param resolveInfo The resolve info of an activity.
* @return The AccessibilityShortcutInfo.
*/
@Nullable
private AccessibilityShortcutInfo getShortcutInfo(@NonNull Context context,
@NonNull ResolveInfo resolveInfo) {
final ActivityInfo activityInfo = resolveInfo.activityInfo;
if (activityInfo == null || activityInfo.metaData == null
|| activityInfo.metaData.getInt(AccessibilityShortcutInfo.META_DATA) == 0) {
return null;
}
try {
return new AccessibilityShortcutInfo(context, activityInfo);
} catch (XmlPullParserException | IOException exp) {
Log.e(LOG_TAG, "Error while initializing AccessibilityShortcutInfo", exp);
}
return null;
}
/**
*
* Sets an {@link IWindowMagnificationConnection} that manipulates window magnification.
*
* @param connection The connection that manipulates window magnification.
* @hide
*/
public void setWindowMagnificationConnection(@Nullable
IWindowMagnificationConnection connection) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.setWindowMagnificationConnection(connection);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error setting window magnfication connection", re);
}
}
/**
* Determines if users want to select sound track with audio description by default.
* <p>
* Audio description, also referred to as a video description, described video, or
* more precisely called a visual description, is a form of narration used to provide
* information surrounding key visual elements in a media work for the benefit of
* blind and visually impaired consumers.
* </p>
* <p>
* The method provides the preference value to content provider apps to select the
* default sound track during playing a video or movie.
* </p>
* <p>
* Add listener to detect the state change via
* {@link #addAudioDescriptionRequestedChangeListener}
* </p>
* @return {@code true} if the audio description is enabled, {@code false} otherwise.
*/
public boolean isAudioDescriptionRequested() {
synchronized (mLock) {
IAccessibilityManager service = getServiceLocked();
if (service == null) {
return false;
}
return mIsAudioDescriptionByDefaultRequested;
}
}
/**
* Sets the system audio caption enabled state.
*
* @param isEnabled The system audio captioning enabled state.
* @param userId The user Id.
* @hide
*/
public void setSystemAudioCaptioningEnabled(boolean isEnabled, int userId) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.setSystemAudioCaptioningEnabled(isEnabled, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Gets the system audio caption UI enabled state.
*
* @param userId The user Id.
* @return the system audio caption UI enabled state.
* @hide
*/
public boolean isSystemAudioCaptioningUiEnabled(int userId) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return false;
}
}
try {
return service.isSystemAudioCaptioningUiEnabled(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the system audio caption UI enabled state.
*
* @param isEnabled The system audio captioning UI enabled state.
* @param userId The user Id.
* @hide
*/
public void setSystemAudioCaptioningUiEnabled(boolean isEnabled, int userId) {
final IAccessibilityManager service;
synchronized (mLock) {
service = getServiceLocked();
if (service == null) {
return;
}
}
try {
service.setSystemAudioCaptioningUiEnabled(isEnabled, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
private IAccessibilityManager getServiceLocked() {
if (mService == null) {
tryConnectToServiceLocked(null);
}
return mService;
}
private void tryConnectToServiceLocked(IAccessibilityManager service) {
if (service == null) {
IBinder iBinder = ServiceManager.getService(Context.ACCESSIBILITY_SERVICE);
if (iBinder == null) {
return;
}
service = IAccessibilityManager.Stub.asInterface(iBinder);
}
try {
final long userStateAndRelevantEvents = service.addClient(mClient, mUserId);
setStateLocked(IntPair.first(userStateAndRelevantEvents));
mRelevantEventTypes = IntPair.second(userStateAndRelevantEvents);
updateUiTimeout(service.getRecommendedTimeoutMillis());
updateFocusAppearanceLocked(service.getFocusStrokeWidth(), service.getFocusColor());
mService = service;
} catch (RemoteException re) {
Log.e(LOG_TAG, "AccessibilityManagerService is dead", re);
}
}
/**
* Notifies the registered {@link AccessibilityStateChangeListener}s.
*/
private void notifyAccessibilityStateChanged() {
final boolean isEnabled;
final ArrayMap<AccessibilityStateChangeListener, Handler> listeners;
synchronized (mLock) {
if (mAccessibilityStateChangeListeners.isEmpty()) {
return;
}
isEnabled = isEnabled();
listeners = new ArrayMap<>(mAccessibilityStateChangeListeners);
}
final int numListeners = listeners.size();
for (int i = 0; i < numListeners; i++) {
final AccessibilityStateChangeListener listener = listeners.keyAt(i);
listeners.valueAt(i).post(() ->
listener.onAccessibilityStateChanged(isEnabled));
}
}
/**
* Notifies the registered {@link TouchExplorationStateChangeListener}s.
*/
private void notifyTouchExplorationStateChanged() {
final boolean isTouchExplorationEnabled;
final ArrayMap<TouchExplorationStateChangeListener, Handler> listeners;
synchronized (mLock) {
if (mTouchExplorationStateChangeListeners.isEmpty()) {
return;
}
isTouchExplorationEnabled = mIsTouchExplorationEnabled;
listeners = new ArrayMap<>(mTouchExplorationStateChangeListeners);
}
final int numListeners = listeners.size();
for (int i = 0; i < numListeners; i++) {
final TouchExplorationStateChangeListener listener = listeners.keyAt(i);
listeners.valueAt(i).post(() ->
listener.onTouchExplorationStateChanged(isTouchExplorationEnabled));
}
}
/**
* Notifies the registered {@link HighTextContrastChangeListener}s.
*/
private void notifyHighTextContrastStateChanged() {
final boolean isHighTextContrastEnabled;
final ArrayMap<HighTextContrastChangeListener, Handler> listeners;
synchronized (mLock) {
if (mHighTextContrastStateChangeListeners.isEmpty()) {
return;
}
isHighTextContrastEnabled = mIsHighTextContrastEnabled;
listeners = new ArrayMap<>(mHighTextContrastStateChangeListeners);
}
final int numListeners = listeners.size();
for (int i = 0; i < numListeners; i++) {
final HighTextContrastChangeListener listener = listeners.keyAt(i);
listeners.valueAt(i).post(() ->
listener.onHighTextContrastStateChanged(isHighTextContrastEnabled));
}
}
/**
* Notifies the registered {@link AudioDescriptionStateChangeListener}s.
*/
private void notifyAudioDescriptionbyDefaultStateChanged() {
final boolean isAudioDescriptionByDefaultRequested;
final ArrayMap<AudioDescriptionRequestedChangeListener, Executor> listeners;
synchronized (mLock) {
if (mAudioDescriptionRequestedChangeListeners.isEmpty()) {
return;
}
isAudioDescriptionByDefaultRequested = mIsAudioDescriptionByDefaultRequested;
listeners = new ArrayMap<>(mAudioDescriptionRequestedChangeListeners);
}
final int numListeners = listeners.size();
for (int i = 0; i < numListeners; i++) {
final AudioDescriptionRequestedChangeListener listener = listeners.keyAt(i);
listeners.valueAt(i).execute(() ->
listener.onAudioDescriptionRequestedChanged(
isAudioDescriptionByDefaultRequested));
}
}
/**
* Update mAccessibilityTracingState.
*/
private void updateAccessibilityTracingState(int stateFlag) {
synchronized (mLock) {
mAccessibilityTracingState = stateFlag;
}
}
/**
* Update interactive and non-interactive UI timeout.
*
* @param uiTimeout A pair of {@code int}s. First integer for interactive one, and second
* integer for non-interactive one.
*/
private void updateUiTimeout(long uiTimeout) {
mInteractiveUiTimeout = IntPair.first(uiTimeout);
mNonInteractiveUiTimeout = IntPair.second(uiTimeout);
}
/**
* Updates the stroke width and color of the focus rectangle.
*
* @param strokeWidth The strokeWidth of the focus rectangle.
* @param color The color of the focus rectangle.
*/
private void updateFocusAppearanceLocked(int strokeWidth, int color) {
if (mFocusStrokeWidth == strokeWidth && mFocusColor == color) {
return;
}
mFocusStrokeWidth = strokeWidth;
mFocusColor = color;
}
/**
* Sets the stroke width and color of the focus rectangle to default value.
*
* @param resource The resources.
*/
private void initialFocusAppearanceLocked(Resources resource) {
try {
mFocusStrokeWidth = resource.getDimensionPixelSize(
R.dimen.accessibility_focus_highlight_stroke_width);
mFocusColor = resource.getColor(R.color.accessibility_focus_highlight_color);
} catch (Resources.NotFoundException re) {
// Sets the stroke width and color to default value by hardcoded for making
// the Talkback can work normally.
mFocusStrokeWidth = (int) (4 * resource.getDisplayMetrics().density);
mFocusColor = 0xbf39b500;
Log.e(LOG_TAG, "Error while initialing the focus appearance data then setting to"
+ " default value by hardcoded", re);
}
}
/**
* Determines if the accessibility button within the system navigation area is supported.
*
* @return {@code true} if the accessibility button is supported on this device,
* {@code false} otherwise
*/
public static boolean isAccessibilityButtonSupported() {
final Resources res = Resources.getSystem();
return res.getBoolean(com.android.internal.R.bool.config_showNavigationBar);
}
private final class MyCallback implements Handler.Callback {
public static final int MSG_SET_STATE = 1;
@Override
public boolean handleMessage(Message message) {
switch (message.what) {
case MSG_SET_STATE: {
// See comment at mClient
final int state = message.arg1;
synchronized (mLock) {
setStateLocked(state);
}
} break;
}
return true;
}
}
}
|