/* * Copyright (C) 2011 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.support.v4.view; import android.os.Build; import android.os.Bundle; import android.support.v4.view.accessibility.AccessibilityNodeInfoCompat; import android.support.v4.view.accessibility.AccessibilityNodeProviderCompat; import android.view.View; import android.view.ViewGroup; import android.view.accessibility.AccessibilityEvent; /** * Helper for accessing {@link View.AccessibilityDelegate} introduced after * API level 4 in a backwards compatible fashion. *
* Note: On platform versions prior to * {@link android.os.Build.VERSION_CODES#M API 23}, delegate methods on * views in the {@code android.widget.*} package are called before * host methods. This prevents certain properties such as class name from * being modified by overriding * {@link AccessibilityDelegateCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat)}, * as any changes will be overwritten by the host class. *
* Starting in {@link android.os.Build.VERSION_CODES#M API 23}, delegate * methods are called after host methods, which all properties to be * modified without being overwritten by the host class. */ public class AccessibilityDelegateCompat { static interface AccessibilityDelegateImpl { public Object newAccessiblityDelegateDefaultImpl(); public Object newAccessiblityDelegateBridge(AccessibilityDelegateCompat listener); public boolean dispatchPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event); public void onInitializeAccessibilityEvent(Object delegate, View host, AccessibilityEvent event); public void onInitializeAccessibilityNodeInfo(Object delegate, View host, AccessibilityNodeInfoCompat info); public void onPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event); public boolean onRequestSendAccessibilityEvent(Object delegate, ViewGroup host, View child, AccessibilityEvent event); public void sendAccessibilityEvent(Object delegate, View host, int eventType); public void sendAccessibilityEventUnchecked(Object delegate, View host, AccessibilityEvent event); public AccessibilityNodeProviderCompat getAccessibilityNodeProvider(Object delegate, View host); public boolean performAccessibilityAction(Object delegate, View host, int action, Bundle args); } static class AccessibilityDelegateStubImpl implements AccessibilityDelegateImpl { @Override public Object newAccessiblityDelegateDefaultImpl() { return null; } @Override public Object newAccessiblityDelegateBridge(AccessibilityDelegateCompat listener) { return null; } @Override public boolean dispatchPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { return false; } @Override public void onInitializeAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { } @Override public void onInitializeAccessibilityNodeInfo(Object delegate, View host, AccessibilityNodeInfoCompat info) { } @Override public void onPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { } @Override public boolean onRequestSendAccessibilityEvent(Object delegate, ViewGroup host, View child, AccessibilityEvent event) { return true; } @Override public void sendAccessibilityEvent(Object delegate, View host, int eventType) { } @Override public void sendAccessibilityEventUnchecked(Object delegate, View host, AccessibilityEvent event) { } @Override public AccessibilityNodeProviderCompat getAccessibilityNodeProvider(Object delegate, View host) { return null; } @Override public boolean performAccessibilityAction(Object delegate, View host, int action, Bundle args) { return false; } } static class AccessibilityDelegateIcsImpl extends AccessibilityDelegateStubImpl { @Override public Object newAccessiblityDelegateDefaultImpl() { return AccessibilityDelegateCompatIcs.newAccessibilityDelegateDefaultImpl(); } @Override public Object newAccessiblityDelegateBridge(final AccessibilityDelegateCompat compat) { return AccessibilityDelegateCompatIcs.newAccessibilityDelegateBridge( new AccessibilityDelegateCompatIcs.AccessibilityDelegateBridge() { @Override public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { return compat.dispatchPopulateAccessibilityEvent(host, event); } @Override public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { compat.onInitializeAccessibilityEvent(host, event); } @Override public void onInitializeAccessibilityNodeInfo(View host, Object info) { compat.onInitializeAccessibilityNodeInfo(host, new AccessibilityNodeInfoCompat(info)); } @Override public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { compat.onPopulateAccessibilityEvent(host, event); } @Override public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, AccessibilityEvent event) { return compat.onRequestSendAccessibilityEvent(host, child, event); } @Override public void sendAccessibilityEvent(View host, int eventType) { compat.sendAccessibilityEvent(host, eventType); } @Override public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { compat.sendAccessibilityEventUnchecked(host, event); } }); } @Override public boolean dispatchPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { return AccessibilityDelegateCompatIcs.dispatchPopulateAccessibilityEvent(delegate, host, event); } @Override public void onInitializeAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { AccessibilityDelegateCompatIcs.onInitializeAccessibilityEvent(delegate, host, event); } @Override public void onInitializeAccessibilityNodeInfo(Object delegate, View host, AccessibilityNodeInfoCompat info) { AccessibilityDelegateCompatIcs.onInitializeAccessibilityNodeInfo(delegate, host, info.getInfo()); } @Override public void onPopulateAccessibilityEvent(Object delegate, View host, AccessibilityEvent event) { AccessibilityDelegateCompatIcs.onPopulateAccessibilityEvent(delegate, host, event); } @Override public boolean onRequestSendAccessibilityEvent(Object delegate, ViewGroup host, View child, AccessibilityEvent event) { return AccessibilityDelegateCompatIcs.onRequestSendAccessibilityEvent(delegate, host, child, event); } @Override public void sendAccessibilityEvent(Object delegate, View host, int eventType) { AccessibilityDelegateCompatIcs.sendAccessibilityEvent(delegate, host, eventType); } @Override public void sendAccessibilityEventUnchecked(Object delegate, View host, AccessibilityEvent event) { AccessibilityDelegateCompatIcs.sendAccessibilityEventUnchecked(delegate, host, event); } } static class AccessibilityDelegateJellyBeanImpl extends AccessibilityDelegateIcsImpl { @Override public Object newAccessiblityDelegateBridge(final AccessibilityDelegateCompat compat) { return AccessibilityDelegateCompatJellyBean.newAccessibilityDelegateBridge( new AccessibilityDelegateCompatJellyBean .AccessibilityDelegateBridgeJellyBean() { @Override public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { return compat.dispatchPopulateAccessibilityEvent(host, event); } @Override public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { compat.onInitializeAccessibilityEvent(host, event); } @Override public void onInitializeAccessibilityNodeInfo(View host, Object info) { compat.onInitializeAccessibilityNodeInfo(host, new AccessibilityNodeInfoCompat(info)); } @Override public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { compat.onPopulateAccessibilityEvent(host, event); } @Override public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, AccessibilityEvent event) { return compat.onRequestSendAccessibilityEvent(host, child, event); } @Override public void sendAccessibilityEvent(View host, int eventType) { compat.sendAccessibilityEvent(host, eventType); } @Override public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { compat.sendAccessibilityEventUnchecked(host, event); } @Override public Object getAccessibilityNodeProvider(View host) { AccessibilityNodeProviderCompat provider = compat.getAccessibilityNodeProvider(host); return (provider != null) ? provider.getProvider() : null; } @Override public boolean performAccessibilityAction(View host, int action, Bundle args) { return compat.performAccessibilityAction(host, action, args); } }); } @Override public AccessibilityNodeProviderCompat getAccessibilityNodeProvider(Object delegate, View host) { Object provider = AccessibilityDelegateCompatJellyBean.getAccessibilityNodeProvider( delegate, host); if (provider != null) { return new AccessibilityNodeProviderCompat(provider); } return null; } @Override public boolean performAccessibilityAction(Object delegate, View host, int action, Bundle args) { return AccessibilityDelegateCompatJellyBean.performAccessibilityAction(delegate, host, action, args); } } private static final AccessibilityDelegateImpl IMPL; private static final Object DEFAULT_DELEGATE; static { if (Build.VERSION.SDK_INT >= 16) { // JellyBean IMPL = new AccessibilityDelegateJellyBeanImpl(); } else if (Build.VERSION.SDK_INT >= 14) { // ICS IMPL = new AccessibilityDelegateIcsImpl(); } else { IMPL = new AccessibilityDelegateStubImpl(); } DEFAULT_DELEGATE = IMPL.newAccessiblityDelegateDefaultImpl(); } final Object mBridge; /** * Creates a new instance. */ public AccessibilityDelegateCompat() { mBridge = IMPL.newAccessiblityDelegateBridge(this); } /** * @return The wrapped bridge implementation. */ Object getBridge() { return mBridge; } /** * Sends an accessibility event of the given type. If accessibility is not * enabled this method has no effect. *
* The default implementation behaves as {@link View#sendAccessibilityEvent(int) * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate * been set. *
* * @param host The View hosting the delegate. * @param eventType The type of the event to send. * * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) */ public void sendAccessibilityEvent(View host, int eventType) { IMPL.sendAccessibilityEvent(DEFAULT_DELEGATE, host, eventType); } /** * Sends an accessibility event. This method behaves exactly as * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an * empty {@link AccessibilityEvent} and does not perform a check whether * accessibility is enabled. ** The default implementation behaves as * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param event The event to send. * * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) * View#sendAccessibilityEventUnchecked(AccessibilityEvent) */ public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { IMPL.sendAccessibilityEventUnchecked(DEFAULT_DELEGATE, host, event); } /** * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then * to its children for adding their text content to the event. ** The default implementation behaves as * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param event The event. * @return True if the event population was completed. * * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) */ public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { return IMPL.dispatchPopulateAccessibilityEvent(DEFAULT_DELEGATE, host, event); } /** * Gives a chance to the host View to populate the accessibility event with its * text content. ** The default implementation behaves as * {@link ViewCompat#onPopulateAccessibilityEvent(View, AccessibilityEvent) * ViewCompat#onPopulateAccessibilityEvent(AccessibilityEvent)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param event The accessibility event which to populate. * * @see ViewCompat#onPopulateAccessibilityEvent(View ,AccessibilityEvent) * ViewCompat#onPopulateAccessibilityEvent(View, AccessibilityEvent) */ public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { IMPL.onPopulateAccessibilityEvent(DEFAULT_DELEGATE, host, event); } /** * Initializes an {@link AccessibilityEvent} with information about the * the host View which is the event source. ** The default implementation behaves as * {@link ViewCompat#onInitializeAccessibilityEvent(View v, AccessibilityEvent event) * ViewCompat#onInitalizeAccessibilityEvent(View v, AccessibilityEvent event)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param event The event to initialize. * * @see ViewCompat#onInitializeAccessibilityEvent(View, AccessibilityEvent) * ViewCompat#onInitializeAccessibilityEvent(View, AccessibilityEvent) */ public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { IMPL.onInitializeAccessibilityEvent(DEFAULT_DELEGATE, host, event); } /** * Initializes an {@link AccessibilityNodeInfoCompat} with information about the host view. ** The default implementation behaves as * {@link ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat) * ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param info The instance to initialize. * * @see ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat) * ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat) */ public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfoCompat info) { IMPL.onInitializeAccessibilityNodeInfo(DEFAULT_DELEGATE, host, info); } /** * Called when a child of the host View has requested sending an * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) * to augment the event. ** The default implementation behaves as * {@link ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent) * ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent)} for * the case of no accessibility delegate been set. *
* * @param host The View hosting the delegate. * @param child The child which requests sending the event. * @param event The event to be sent. * @return True if the event should be sent * * @see ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent) * ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent) */ public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, AccessibilityEvent event) { return IMPL.onRequestSendAccessibilityEvent(DEFAULT_DELEGATE, host, child, event); } /** * Gets the provider for managing a virtual view hierarchy rooted at this View * and reported to {@link android.accessibilityservice.AccessibilityService}s * that explore the window content. ** The default implementation behaves as * {@link ViewCompat#getAccessibilityNodeProvider(View) ViewCompat#getAccessibilityNodeProvider(View)} * for the case of no accessibility delegate been set. *
* * @return The provider. * * @see AccessibilityNodeProviderCompat */ public AccessibilityNodeProviderCompat getAccessibilityNodeProvider(View host) { return IMPL.getAccessibilityNodeProvider(DEFAULT_DELEGATE, host); } /** * Performs the specified accessibility action on the view. For * possible accessibility actions look at {@link AccessibilityNodeInfoCompat}. ** The default implementation behaves as * {@link View#performAccessibilityAction(int, Bundle) * View#performAccessibilityAction(int, Bundle)} for the case of * no accessibility delegate been set. *
* * @param action The action to perform. * @return Whether the action was performed. * * @see View#performAccessibilityAction(int, Bundle) * View#performAccessibilityAction(int, Bundle) */ public boolean performAccessibilityAction(View host, int action, Bundle args) { return IMPL.performAccessibilityAction(DEFAULT_DELEGATE, host, action, args); } }