From e1302edd40c5cc264f842e17e3796e0a11d6f045 Mon Sep 17 00:00:00 2001 From: Joe Fernandez Date: Mon, 6 Feb 2012 14:30:15 -0800 Subject: [PATCH] docs: Accessibility Dev Guide (subsumes Accessibility Best Practices) Change-Id: Id7e3f647042d2afd390abe851be1c3b561af33ca --- .../AccessibilityService.java | 8 + .../AccessibilityServiceInfo.java | 7 + core/java/android/view/View.java | 6 + .../accessibility/AccessibilityEvent.java | 6 + .../AccessibilityEventSource.java | 7 + .../accessibility/AccessibilityNodeInfo.java | 6 + .../accessibility/AccessibilityRecord.java | 7 + .../android/view/accessibility/package.html | 7 + docs/html/guide/guide_toc.cs | 17 +- .../guide/practices/design/accessibility.html | 11 + .../guide/practices/design/accessibility.jd | 352 ----------- .../guide/topics/ui/accessibility/apps.jd | 570 ++++++++++++++++++ .../guide/topics/ui/accessibility/index.jd | 55 ++ .../guide/topics/ui/accessibility/services.jd | 290 +++++++++ 14 files changed, 994 insertions(+), 355 deletions(-) create mode 100644 docs/html/guide/practices/design/accessibility.html delete mode 100644 docs/html/guide/practices/design/accessibility.jd create mode 100644 docs/html/guide/topics/ui/accessibility/apps.jd create mode 100644 docs/html/guide/topics/ui/accessibility/index.jd create mode 100644 docs/html/guide/topics/ui/accessibility/services.jd diff --git a/core/java/android/accessibilityservice/AccessibilityService.java b/core/java/android/accessibilityservice/AccessibilityService.java index 211be52e0622b..5d3670f532167 100644 --- a/core/java/android/accessibilityservice/AccessibilityService.java +++ b/core/java/android/accessibilityservice/AccessibilityService.java @@ -35,6 +35,14 @@ import com.android.internal.os.HandlerCaller; * etc. Such a service can optionally request the capability for querying the content * of the active window. Development of an accessibility service requires extending this * class and implementing its abstract methods. + * + *
+ *

Developer Guides

+ *

For more information about creating AccessibilityServices, read the + * Accessibility + * developer guide.

+ *
+ * *

Lifecycle

*

* The lifecycle of an accessibility service is managed exclusively by the system and diff --git a/core/java/android/accessibilityservice/AccessibilityServiceInfo.java b/core/java/android/accessibilityservice/AccessibilityServiceInfo.java index e5a5e986e7041..edfefac2d81e6 100644 --- a/core/java/android/accessibilityservice/AccessibilityServiceInfo.java +++ b/core/java/android/accessibilityservice/AccessibilityServiceInfo.java @@ -41,6 +41,13 @@ import java.io.IOException; * {@link AccessibilityService} for {@link android.view.accessibility.AccessibilityEvent}s * according to the information encapsulated in this class. * + *

+ *

Developer Guides

+ *

For more information about creating AccessibilityServices, read the + * Accessibility + * developer guide.

+ *
+ * * @see AccessibilityService * @see android.view.accessibility.AccessibilityEvent * @see android.view.accessibility.AccessibilityManager diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java index 54bb056ab0350..6b4bbb3b15d2a 100644 --- a/core/java/android/view/View.java +++ b/core/java/android/view/View.java @@ -14804,6 +14804,12 @@ public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Cal * classes i.e. classes in package android.view, that would like their * applications to be backwards compatible. *

+ *
+ *

Developer Guides

+ *

For more information about making applications accessible, read the + * Accessibility + * developer guide.

+ *
*

* A scenario in which a developer would like to use an accessibility delegate * is overriding a method introduced in a later API version then the minimal API diff --git a/core/java/android/view/accessibility/AccessibilityEvent.java b/core/java/android/view/accessibility/AccessibilityEvent.java index 91dcac8db548b..42403c17308b8 100644 --- a/core/java/android/view/accessibility/AccessibilityEvent.java +++ b/core/java/android/view/accessibility/AccessibilityEvent.java @@ -59,6 +59,12 @@ import java.util.List; * by this class. For each event type there is a corresponding constant defined * in this class. Follows a specification of the event types and their associated properties: *

+ *
+ *

Developer Guides

+ *

For more information about creating and processing AccessibilityEvents, read the + * Accessibility + * developer guide.

+ *
*

* VIEW TYPES
*

diff --git a/core/java/android/view/accessibility/AccessibilityEventSource.java b/core/java/android/view/accessibility/AccessibilityEventSource.java index f11880bc8c07c..525ba9e184617 100644 --- a/core/java/android/view/accessibility/AccessibilityEventSource.java +++ b/core/java/android/view/accessibility/AccessibilityEventSource.java @@ -18,6 +18,13 @@ package android.view.accessibility; /** * This interface is implemented by classes source of {@link AccessibilityEvent}s. + * + *
+ *

Developer Guides

+ *

For more information about making applications accessible, read the + * Accessibility + * developer guide.

+ *
*/ public interface AccessibilityEventSource { diff --git a/core/java/android/view/accessibility/AccessibilityNodeInfo.java b/core/java/android/view/accessibility/AccessibilityNodeInfo.java index 9b0f44a55614a..eaaafec4673b9 100644 --- a/core/java/android/view/accessibility/AccessibilityNodeInfo.java +++ b/core/java/android/view/accessibility/AccessibilityNodeInfo.java @@ -43,6 +43,12 @@ import java.util.List; * details about how to obtain a handle to window content as a tree of accessibility * node info as well as familiarizing with the security model. *

+ *
+ *

Developer Guides

+ *

For more information about making applications accessible, read the + * Accessibility + * developer guide.

+ *
* * @see android.accessibilityservice.AccessibilityService * @see AccessibilityEvent diff --git a/core/java/android/view/accessibility/AccessibilityRecord.java b/core/java/android/view/accessibility/AccessibilityRecord.java index 18d0f6fe8a27b..3b0202569117d 100644 --- a/core/java/android/view/accessibility/AccessibilityRecord.java +++ b/core/java/android/view/accessibility/AccessibilityRecord.java @@ -41,6 +41,13 @@ import java.util.List; * event types. For detailed information please refer to {@link AccessibilityEvent}. *

* + *
+ *

Developer Guides

+ *

For more information about creating and processing AccessibilityRecords, read the + * Accessibility + * developer guide.

+ *
+ * * @see AccessibilityEvent * @see AccessibilityManager * @see android.accessibilityservice.AccessibilityService diff --git a/core/java/android/view/accessibility/package.html b/core/java/android/view/accessibility/package.html index 4afafd3ca128b..c2da0ae486543 100644 --- a/core/java/android/view/accessibility/package.html +++ b/core/java/android/view/accessibility/package.html @@ -35,5 +35,12 @@ changes etc. Parties interested in handling accessibility events implement and register an accessibility service which extends {@link android.accessibilityservice.AccessibilityService}.

+
+

Developer Guides

+

For more information about making applications accessible, read the +Accessibility +developer guide.

+
+ diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index 9d5064e4f8635..3fa37d89b61b3 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -160,6 +160,20 @@
  • Custom Components
    • +
  • +
    + Accessibility + new! +
    + +
  • Binding to Data with AdapterView
    • @@ -835,9 +849,6 @@ applications