FileDocCategorySizeDatePackage
KeyboardLayout.javaAPI DocAndroid 5.1 API3650Thu Mar 12 22:22:10 GMT 2015android.hardware.input

KeyboardLayout

public final class KeyboardLayout extends Object implements Comparable, android.os.Parcelable
Describes a keyboard layout.
hide

Fields Summary
private final String
mDescriptor
private final String
mLabel
private final String
mCollection
private final int
mPriority
public static final Parcelable.Creator
CREATOR
Constructors Summary
public KeyboardLayout(String descriptor, String label, String collection, int priority)


             
        mDescriptor = descriptor;
        mLabel = label;
        mCollection = collection;
        mPriority = priority;
    
private KeyboardLayout(android.os.Parcel source)

        mDescriptor = source.readString();
        mLabel = source.readString();
        mCollection = source.readString();
        mPriority = source.readInt();
    
Methods Summary
public intcompareTo(android.hardware.input.KeyboardLayout another)

        // Note that these arguments are intentionally flipped since you want higher priority
        // keyboards to be listed before lower priority keyboards.
        int result = Integer.compare(another.mPriority, mPriority);
        if (result == 0) {
            result = mLabel.compareToIgnoreCase(another.mLabel);
        }
        if (result == 0) {
            result = mCollection.compareToIgnoreCase(another.mCollection);
        }
        return result;
    
public intdescribeContents()

        return 0;
    
public java.lang.StringgetCollection()
Gets the name of the collection to which the keyboard layout belongs. This is the label of the broadcast receiver or application that provided the keyboard layout.

return
The keyboard layout collection name.

        return mCollection;
    
public java.lang.StringgetDescriptor()
Gets the keyboard layout descriptor, which can be used to retrieve the keyboard layout again later using {@link InputManager#getKeyboardLayout(String)}.

return
The keyboard layout descriptor.

        return mDescriptor;
    
public java.lang.StringgetLabel()
Gets the keyboard layout descriptive label to show in the user interface.

return
The keyboard layout descriptive label.

        return mLabel;
    
public java.lang.StringtoString()

        if (mCollection.isEmpty()) {
            return mLabel;
        }
        return mLabel + " - " + mCollection;
    
public voidwriteToParcel(android.os.Parcel dest, int flags)

        dest.writeString(mDescriptor);
        dest.writeString(mLabel);
        dest.writeString(mCollection);
        dest.writeInt(mPriority);