BackDisposition Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Enumerates values returned by several types.
public enum BackDisposition
type BackDisposition =
- Inheritance
-
BackDisposition
Fields
| Name | Value | Description |
|---|---|---|
| Default | 0 | The back button will close the input window. |
| WillNotDismiss | 1 | This input method will not consume the back key. |
| WillDismiss | 2 | This input method will consume the back key. |
| AdjustNothing | 3 | Asks the system to not adjust the back button affordance even when the software keyboard is shown. This mode is useful for UI modes where IME's main soft input window is used for some supplemental UI, such as floating candidate window for languages such as Chinese and Japanese, where users expect the back button is, or at least looks to be, handled by the target application rather than the UI shown by the IME even while isInputViewShown() returns true. Note that KeyEvent.KEYCODE_BACK events continue to be sent to onKeyDown(int,KeyEvent) even when this mode is specified. The default implementation of onKeyDown(int,KeyEvent) for KeyEvent.KEYCODE_BACK does not take this mode into account. For IMEs targeting Build.VERSION_CODES.CINNAMON_BUN or higher with android:enableOnBackInvokedCallback="true" set in the manifest, specifying this mode causes back events to bypass the IME and be sent directly to the application. If the IME still wants to receive back events in this mode, it must register a custom OnBackInvokedCallback. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
Remarks
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.