KeyboardShortcutInfo
public final class KeyboardShortcutInfo
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | android.view.KeyboardShortcutInfo |
Information about a Keyboard Shortcut.
Summary
Inherited constants |
|---|
Fields | |
|---|---|
public static final Creator<KeyboardShortcutInfo> | CREATOR
|
Public constructors | |
|---|---|
KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers) | |
KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers) | |
Public methods | |
|---|---|
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
char | getBaseCharacter() Returns the base character that, combined with the modifiers, triggers this shortcut. |
int | getKeycode() Returns the base keycode that, combined with the modifiers, triggers this shortcut. |
CharSequence | getLabel() Returns the label to be used to describe this shortcut. |
int | getModifiers() Returns the set of modifiers that, combined with the key, trigger this shortcut. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
Public constructors
KeyboardShortcutInfo
public KeyboardShortcutInfo (CharSequence label, char baseCharacter, int modifiers)
| Parameters | |
|---|---|
label | CharSequence: The label that identifies the action performed by this shortcut. |
baseCharacter | char: The character that triggers the shortcut. |
modifiers | int: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of KeyEvent.META_CTRL_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_META_ON, KeyEvent.META_ALT_ON, KeyEvent.META_FUNCTION_ON and KeyEvent.META_SYM_ON. |
KeyboardShortcutInfo
public KeyboardShortcutInfo (CharSequence label, int keycode, int modifiers)
| Parameters | |
|---|---|
label | CharSequence: The label that identifies the action performed by this shortcut. |
keycode | int: The keycode that triggers the shortcut. This should be a valid constant defined in KeyEvent. |
modifiers | int: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of KeyEvent.META_CTRL_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_META_ON, KeyEvent.META_ALT_ON, KeyEvent.META_FUNCTION_ON and KeyEvent.META_SYM_ON. |
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
getBaseCharacter
public char getBaseCharacter ()
Returns the base character that, combined with the modifiers, triggers this shortcut. If the keycode was set instead, returns Character.MIN_VALUE.
| Returns | |
|---|---|
char | |
getKeycode
public int getKeycode ()
Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the base character was set instead, returns KeyEvent.KEYCODE_UNKNOWN. Valid keycodes are defined as constants in KeyEvent.
| Returns | |
|---|---|
int | |
getLabel
public CharSequence getLabel ()
Returns the label to be used to describe this shortcut.
| Returns | |
|---|---|
CharSequence | This value may be null. |
getModifiers
public int getModifiers ()
Returns the set of modifiers that, combined with the key, trigger this shortcut. These can be a combination of KeyEvent.META_CTRL_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_META_ON, KeyEvent.META_ALT_ON, KeyEvent.META_FUNCTION_ON and KeyEvent.META_SYM_ON.
| Returns | |
|---|---|
int | |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest | Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags | int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |