AccessibleAbility

java.lang.Object
- ohos.app.AbilityContext
- - ohos.aafwk.ability.Ability
  - - ohos.accessibility.ability.AccessibleAbility

所有已实现的接口:

ILifecycle, Context
```
public abstract class AccessibleAbility
extends Ability
```
Provides capabilities for you to develop your own accessibility application.
The accessibility application helps users use their devices and programs easily. AccessibilityEventInfo will be called to send events when the UI status has any changes, for example, a button is clicked or focus is gained. You can inherit this class to handle your interested events.

从以下版本开始:

3

SystemCapability

SystemCapability.Accessibility#ABILITY

嵌套类概要
- 从类继承的嵌套类/接口 ohos.aafwk.ability.Ability
  Ability.LayoutParamsHelper, Ability.WindowAttributeHelper

字段概要

字段
限定符和类型	字段	说明
`static int`	`GLOBAL_ACTION_BACK`	Indicates a global action of returning to the previous page.
`static int`	`GLOBAL_ACTION_HOME`	Indicates a global action of returning to the home page.
`static int`	`GLOBAL_ACTION_LOCK_SCREEN`	Indicates a global action of locking the screen.
`static int`	`GLOBAL_ACTION_NOTIFICATIONS`	Indicates a global action of opening the notification panel.
`static int`	`GLOBAL_ACTION_POWER_DIALOG`	Indicates a global action of pressing and holding the power button.
`static int`	`GLOBAL_ACTION_QUICK_SETTINGS`	Indicates a global action of opening quick settings.
`static int`	`GLOBAL_ACTION_RECENTS`	Indicates a global action of displaying a list of recent tasks.
`static int`	`GLOBAL_ACTION_TAKE_SCREENSHOT`	Indicates a global action of taking a screenshot.
`static int`	`GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN`	Indicates a global action of switching between split screens.
`static int`	`SHOW_MODE_AUTO`	Indicates to show the soft keyboard.
`static int`	`SHOW_MODE_HIDE`	Indicates to hide the soft keyboard.
`static int`	`SHOW_MODE_IGNORE_HARD_KEYBOARD`	Indicates to show the soft keyboard when using an external keyboard.

从类继承的字段 ohos.aafwk.ability.Ability
FORM_INVISIBLE, FORM_VISIBLE

从接口继承的字段 ohos.app.Context
CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESOUCE_ONLY, CONTEXT_RESTRICTED, MODE_APPEND, MODE_PRIVATE

构造器概要

构造器
构造器说明

AccessibleAbility()

构造器
构造器	说明
`AccessibleAbility()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`void`	`disableAbility()`	Disables the accessibility service.
`Optional<AccessibilityInfo>`	`gainFocus(int focusType)`	Obtains the accessibility node that gains the focus.
`boolean`	`gestureSimulate(List<GesturePathDefine> gesturePathDefineList, GestureResultListener listener)`	Sends customized gestures to the screen.
`DisplayResizeController`	`getDisplayResizeController()`	Obtains the controller for display resizing operations.
`DisplayResizeController`	`getDisplayResizeController(int displayId)`	Obtains the controller for display resizing operations.
`Optional<AccessibilityInfo>`	`getRootAccessibilityInfo()`	Obtains information about the accessibility root node.
`SoftKeyBoardController`	`getSoftKeyBoardController()`	Obtains the controller for the soft keyboard.
`List<AccessibilityWindow>`	`getWindows()`	Obtains the list of interactive windows on the device, in the layers they are visible to users.
`protected void`	`onAbilityConnected()`	Called when your accessibility service is successfully connected to the OS.
`abstract void`	`onAccessibilityEvent(AccessibilityEventInfo eventInfo)`	Called when an accessibility event occurs.
`IRemoteObject`	`onConnect(Intent intent)`	Called back when a Service ability is first connected to an ability.
`protected boolean`	`onGesture(int gestureId)`	Called when a user performs a specified gesture on the device that your accessibility application has requested to be in touch exploration mode.
`abstract void`	`onInterrupt()`	Called when the accessibility service is interrupted.
`protected boolean`	`onKeyPressEvent(KeyEvent keyEvent)`	Called when a key event occurs, for example, a user presses the key to increase or decrease the volume.
`boolean`	`performCommonAction(int action)`	Executes a specified action.

从类继承的方法 ohos.aafwk.ability.Ability
addActionRoute, batchInsert, call, cancelBackgroundRunning, connectAbility, continueAbility, continueAbility, continueAbilityReversibly, continueAbilityReversibly, createPipeFile, delete, denormalizeUri, disconnectAbility, dispatchAccessibilityEventInfo, executeBatch, executeOperation, findComponentById, getAbilityName, getAbilityPackage, getAdmissionTransitionConcurEnabled, getAdmissionTransitionObject, getAVController, getBackTransitionConcurEnabled, getBackTransitionObject, getContinuationRegisterManager, getContinuationState, getCurrentFocus, getFileTypes, getIntent, getLayoutParams, getLifecycle, getOriginalDeviceId, getQuitTransitionObject, getReadmissionTransitionObject, getSharedItemAdmissionTransitionObject, getSharedItemBackTransitionObject, getSharedItemQuitTransitionObject, getSharedItemReadmissionTransitionObject, getState, getType, getVolumeTypeAdjustedByKey, getWindow, hasWindowFocus, insert, isTemporary, isTerminating, keepBackgroundRunning, normalizeUri, onAbilityResult, onAcquireFormState, onActive, onBackground, onBackPressed, onCastTempForm, onCommand, onCommand, onConfigurationUpdated, onCreateForm, onCreateForm, onDeleteForm, onDeleteForm, onDisconnect, onEventDispatch, onEventNotify, onForeground, onHotkeyTriggered, onInactive, onInitialized, onKeyDown, onKeyPressAndHold, onKeyUp, onLeaveForeground, onMemoryLevel, onMissionDeleted, onNewDescription, onNewIntent, onOrientationChanged, onPostActive, onPostStart, onReconnect, onRequestPermissionsFromUserResult, onRestoreAbilityState, onSaveAbilityState, onSetCaller, onStart, onStop, onStoreDataWhenConfigChange, onTopActiveAbilityChanged, onTouchEvent, onTriggerFormEvent, onTriggerFormEvent, onUnloadForm, onUpdateForm, onUpdateForm, onWindowFocusChanged, openFile, openRawFile, parsePredictionArgsReference, parseValuesBucketReference, postTask, query, reload, reverseContinueAbility, setAbilitySliceAnimator, setAdmissionTransitionConcurEnabled, setAdmissionTransitionObject, setAVController, setBackTransitionConcurEnabled, setBackTransitionObject, setFormNextRefreshTime, setIntent, setIsAmbientMode, setLayoutParams, setMainRoute, setQuitTransitionObject, setReadmissionTransitionObject, setResult, setSharedItemAdmissionTransitionObject, setSharedItemBackTransitionObject, setSharedItemQuitTransitionObject, setSharedItemReadmissionTransitionObject, setSwipeToDismiss, setUIContent, setUIContent, setVolumeTypeAdjustedByKey, setWindowBackgroundColor, shutdown, startAbility, startAbility, startAbility, startAbility, startAbilityForResult, startAbilityForResult, startAssistAbility, stopAbility, stopAssistAbility, supportHighPerformanceUI, terminateAbility, update, updateForm, updateForm, updateForm, updateForm

从类继承的方法 ohos.app.AbilityContext
attachBaseContext, canRequestPermission, compelVerifyCallerPermission, compelVerifyCallerUriPermission, compelVerifyPermission, compelVerifyPermission, compelVerifyUriPermission, compelVerifyUriPermission, compelVerifyUriPermission, createBundleContext, createParallelTaskDispatcher, createSerialTaskDispatcher, deleteFile, displayUnlockMissionMessage, getAbilityInfo, getAbilityManager, getAbilityPackageContext, getApplicationContext, getApplicationInfo, getAppType, getBundleCodePath, getBundleManager, getBundleName, getBundleResourcePath, getCacheDir, getCaller, getCallingAbility, getCallingBundle, getClassloader, getCodeCacheDir, getColor, getColorMode, getContext, getDatabaseDir, getDataDir, getDir, getDisplayOrientation, getDistributedDir, getElementName, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getGlobalTaskDispatcher, getHapModuleInfo, getIntArray, getLastStoredDataWhenConfigChanged, getLocalClassName, getMainTaskDispatcher, getNoBackupFilesDir, getPattern, getPreferencesDir, getProcessInfo, getProcessName, getResourceManager, getResourceManager, getString, getString, getStringArray, getTheme, getThemeId, getUITaskDispatcher, init, isCredentialEncryptedStorage, isDeviceEncryptedStorage, isUpdatingConfigurations, lockMission, printDrawnCompleted, requestPermissionsFromUser, restart, setColorMode, setDisplayOrientation, setPattern, setShowOnLockScreen, setTheme, setTransitionAnimation, setWakeUpScreen, startAbilities, startAbility, startAbility, startAbility, switchToCredentialEncryptedStorageContext, switchToDeviceEncryptedStorageContext, terminateAbility, terminateAbilityResult, unlockMission, verifyCallingOrSelfPermission, verifyCallingPermission, verifyPermission, verifySelfPermission

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - GLOBAL_ACTION_BACK
```
public static final int GLOBAL_ACTION_BACK
```
    Indicates a global action of returning to the previous page.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_HOME
```
public static final int GLOBAL_ACTION_HOME
```
    Indicates a global action of returning to the home page.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_LOCK_SCREEN
```
public static final int GLOBAL_ACTION_LOCK_SCREEN
```
    Indicates a global action of locking the screen.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_NOTIFICATIONS
```
public static final int GLOBAL_ACTION_NOTIFICATIONS
```
    Indicates a global action of opening the notification panel.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_POWER_DIALOG
```
public static final int GLOBAL_ACTION_POWER_DIALOG
```
    Indicates a global action of pressing and holding the power button.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_QUICK_SETTINGS
```
public static final int GLOBAL_ACTION_QUICK_SETTINGS
```
    Indicates a global action of opening quick settings.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_RECENTS
```
public static final int GLOBAL_ACTION_RECENTS
```
    Indicates a global action of displaying a list of recent tasks.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_TAKE_SCREENSHOT
```
public static final int GLOBAL_ACTION_TAKE_SCREENSHOT
```
    Indicates a global action of taking a screenshot.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN
```
public static final int GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN
```
    Indicates a global action of switching between split screens.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SHOW_MODE_AUTO
```
public static final int SHOW_MODE_AUTO
```
    Indicates to show the soft keyboard.
    
    另请参阅:
    
    常量字段值
  - SHOW_MODE_HIDE
```
public static final int SHOW_MODE_HIDE
```
    Indicates to hide the soft keyboard.
    
    另请参阅:
    
    常量字段值
  - SHOW_MODE_IGNORE_HARD_KEYBOARD
```
public static final int SHOW_MODE_IGNORE_HARD_KEYBOARD
```
    Indicates to show the soft keyboard when using an external keyboard.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AccessibleAbility
```
public AccessibleAbility()
```
- 方法详细资料
  - onAccessibilityEvent
```
public abstract void onAccessibilityEvent(AccessibilityEventInfo eventInfo)
```
    Called when an accessibility event occurs.
    When receiving an accessibility event, for example, AccessibilityEventInfo#TYPE_VIEW_CLICKED_EVENT, you can implement this method to handle the event.
    
    参数:
    
    eventInfo - Indicates the accessibility event information.
    
    从以下版本开始:
    
    3
  - onInterrupt
```
public abstract void onInterrupt()
```
    Called when the accessibility service is interrupted.
    You can implement this method to handle the interruption.
    
    从以下版本开始:
    
    3
  - disableAbility
```
public final void disableAbility()
```
    Disables the accessibility service.
    After the accessibility service is disabled by this method, it becomes disabled on the UI settings accordingly.
    
    从以下版本开始:
    
    3
  - onKeyPressEvent
```
protected boolean onKeyPressEvent(KeyEvent keyEvent)
```
    Called when a key event occurs, for example, a user presses the key to increase or decrease the volume.
    Changing the keyEvent value does not affect other services that receive this event. The return value determines whether this event has been consumed by the current control. You can implement this method to filter key events.
    
    参数:
    
    keyEvent - Indicates the key event to send.
    
    返回:
    
    Returns true if the event has been consumed; returns false otherwise. The event that has been consumed will not be sent to the application.
    
    从以下版本开始:
    
    3
  - getSoftKeyBoardController
```
public final SoftKeyBoardController getSoftKeyBoardController()
```
    Obtains the controller for the soft keyboard.
    
    返回:
    
    Returns a SoftKeyBoardController instance.
  - getDisplayResizeController
```
public final DisplayResizeController getDisplayResizeController()
```
    Obtains the controller for display resizing operations.
    
    返回:
    
    Returns a DisplayResizeController instance.
  - getDisplayResizeController
```
public final DisplayResizeController getDisplayResizeController(int displayId)
```
    Obtains the controller for display resizing operations.
    
    参数:
    
    displayId - Indicates the ID of the display.
    
    返回:
    
    Returns a DisplayResizeController instance.
  - onAbilityConnected
```
protected void onAbilityConnected()
```
    Called when your accessibility service is successfully connected to the OS. You can implement this method to perform subsequent initialization operations.
    
    从以下版本开始:
    
    3
  - onGesture
```
protected boolean onGesture(int gestureId)
```
    Called when a user performs a specified gesture on the device that your accessibility application has requested to be in touch exploration mode.
    
    参数:
    
    gestureId - Indicates the gesture ID.
    
    返回:
    
    Returns true if the gesture has been handled; returns false otherwise.
  - gestureSimulate
```
public final boolean gestureSimulate(List<GesturePathDefine> gesturePathDefineList,
                                     GestureResultListener listener)
```
    Sends customized gestures to the screen.
    
    参数:
    
    gesturePathDefineList - Indicates the path of the customized gestures to send.
    
    listener - Indicates the listener used to observe the gesture sending result.
    
    返回:
    
    Returns true if the gestures are successfully sent; returns false otherwise.
  - getWindows
```
public List<AccessibilityWindow> getWindows()
```
    Obtains the list of interactive windows on the device, in the layers they are visible to users.
    You need to configure the permission to search for the window content in the configuration file.
    Permissions: SystemPermission.CONNECT_ACCESSIBILITY_ABILITY.
    
    返回:
    
    Returns the window list.
    
    从以下版本开始:
    
    3
  - getRootAccessibilityInfo
```
public Optional<AccessibilityInfo> getRootAccessibilityInfo()
```
    Obtains information about the accessibility root node.
    This method will search all windows for view information about the accessibility root node, so that you need to configure the permission to search for the window content in the configuration file.
    Permissions: SystemPermission.CONNECT_ACCESSIBILITY_ABILITY.
    
    返回:
    
    Returns information about the accessibility root node.
    
    从以下版本开始:
    
    3
  - gainFocus
```
public Optional<AccessibilityInfo> gainFocus(int focusType)
```
    Obtains the accessibility node that gains the focus.
    
    参数:
    
    focusType - Indicates the focus type.
    
    返回:
    
    Returns the focused accessibility node.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AccessibilityInfo.FOCUS_TYPE_INPUT, AccessibilityInfo.FOCUS_TYPE_ACCESSIBILITY
  - performCommonAction
```
public final boolean performCommonAction(int action)
```
    Executes a specified action.
    This action can be executed without any user operations, for example, going to the previous step, going to the home page, and taking a screenshot.
    
    参数:
    
    action - Indicates the action type.
    
    返回:
    
    Returns true if the action is successfully executed; returns false otherwise.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    GLOBAL_ACTION_BACK, GLOBAL_ACTION_HOME, GLOBAL_ACTION_RECENTS, GLOBAL_ACTION_NOTIFICATIONS, GLOBAL_ACTION_QUICK_SETTINGS, GLOBAL_ACTION_POWER_DIALOG, GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN, GLOBAL_ACTION_LOCK_SCREEN, GLOBAL_ACTION_TAKE_SCREENSHOT
  - onConnect
```
public final IRemoteObject onConnect(Intent intent)
```
    从类复制的说明: Ability
    
    Called back when a Service ability is first connected to an ability.
    This method is called only on Service abilities. You can override the method to return the proxy of a Service ability.
    
    覆盖:
    
    onConnect 在类中 Ability
    
    参数:
    
    intent - Indicates connection information about the Service ability.
    
    返回:
    
    Returns the proxy of the Service ability.

类 AccessibleAbility

嵌套类概要

从类继承的嵌套类/接口 ohos.aafwk.ability.Ability

字段概要

从类继承的字段 ohos.aafwk.ability.Ability

从接口继承的字段 ohos.app.Context

构造器概要

方法概要

从类继承的方法 ohos.aafwk.ability.Ability

从类继承的方法 ohos.app.AbilityContext

从类继承的方法 java.lang.Object

字段详细资料

GLOBAL_ACTION_BACK

GLOBAL_ACTION_HOME

GLOBAL_ACTION_LOCK_SCREEN

GLOBAL_ACTION_NOTIFICATIONS

GLOBAL_ACTION_POWER_DIALOG

GLOBAL_ACTION_QUICK_SETTINGS

GLOBAL_ACTION_RECENTS

GLOBAL_ACTION_TAKE_SCREENSHOT

GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN

SHOW_MODE_AUTO

SHOW_MODE_HIDE

SHOW_MODE_IGNORE_HARD_KEYBOARD

构造器详细资料

AccessibleAbility

方法详细资料

onAccessibilityEvent

onInterrupt

disableAbility

onKeyPressEvent

getSoftKeyBoardController

getDisplayResizeController

getDisplayResizeController

onAbilityConnected

onGesture

gestureSimulate

getWindows

getRootAccessibilityInfo

gainFocus

performCommonAction

onConnect