1dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev/** 2dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Copyright (C) 2016 The Android Open Source Project 3dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 4dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Licensed under the Apache License, Version 2.0 (the "License"); 5dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * you may not use this file except in compliance with the License. 6dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * You may obtain a copy of the License at 7dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 8dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * http://www.apache.org/licenses/LICENSE-2.0 9dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 10dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Unless required by applicable law or agreed to in writing, software 11dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * distributed under the License is distributed on an "AS IS" BASIS, 12dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * See the License for the specific language governing permissions and 14dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * limitations under the License. 15dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 16dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 17dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheevpackage android.support.v4.view; 18dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 19aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikasimport static android.os.Build.VERSION.SDK_INT; 208e10080c914d1ad0784394fa3026b85535535847Aurimas Liutikasimport static android.support.annotation.RestrictTo.Scope.LIBRARY_GROUP; 218e10080c914d1ad0784394fa3026b85535535847Aurimas Liutikas 22dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheevimport android.content.Context; 23dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheevimport android.content.res.Resources; 24dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheevimport android.graphics.Bitmap; 25c39d9c75590eca86a5e7e32a8824ba04a0d42e9bAlan Viveretteimport android.support.annotation.RestrictTo; 26aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikasimport android.view.PointerIcon; 27dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 28dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev/** 29aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas * Helper for accessing features in {@link android.view.PointerIcon} in a backwards compatible 30aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas * fashion. 31dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 32dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheevpublic final class PointerIconCompat { 33202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_NULL} */ 34202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_NULL = 0; 35dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 36202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_ARROW} */ 37202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_ARROW = 1000; 38dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 39202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_CONTEXT_MENU} */ 40202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_CONTEXT_MENU = 1001; 41dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 42202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_HAND} */ 43202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_HAND = 1002; 44dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 45202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_HELP} */ 46202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_HELP = 1003; 47dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 48202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_WAIT} */ 49202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_WAIT = 1004; 50dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 51202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_CELL} */ 52202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_CELL = 1006; 53dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 54202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_CROSSHAIR} */ 55202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_CROSSHAIR = 1007; 56dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 57202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_TEXT} */ 58202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_TEXT = 1008; 59dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 60202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_VERTICAL_TEXT} */ 61202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_VERTICAL_TEXT = 1009; 62dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 63202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_ALIAS} */ 64202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_ALIAS = 1010; 65dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 66202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_COPY} */ 67202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_COPY = 1011; 68dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 69202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_NO_DROP} */ 70202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_NO_DROP = 1012; 71dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 72202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_ALL_SCROLL} */ 73202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_ALL_SCROLL = 1013; 74dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 75202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_HORIZONTAL_DOUBLE_ARROW} */ 76202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_HORIZONTAL_DOUBLE_ARROW = 1014; 77dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 78202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_VERTICAL_DOUBLE_ARROW} */ 79202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_VERTICAL_DOUBLE_ARROW = 1015; 80dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 81202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_TOP_RIGHT_DIAGONAL_DOUBLE_ARROW} */ 82202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_TOP_RIGHT_DIAGONAL_DOUBLE_ARROW = 1016; 83dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 84202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_TOP_LEFT_DIAGONAL_DOUBLE_ARROW} */ 85202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_TOP_LEFT_DIAGONAL_DOUBLE_ARROW = 1017; 86dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 87202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_ZOOM_IN} */ 88202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_ZOOM_IN = 1018; 89dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 90202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_ZOOM_OUT} */ 91202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_ZOOM_OUT = 1019; 92dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 93202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_GRAB} */ 94202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_GRAB = 1020; 95dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 96202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_GRABBING} */ 97202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_GRABBING = 1021; 98dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 99202c10031a653cc8b7003cbc714330564c26d99fChet Haase /** Synonym for {@link android.view.PointerIcon#TYPE_DEFAULT} */ 100202c10031a653cc8b7003cbc714330564c26d99fChet Haase public static final int TYPE_DEFAULT = TYPE_ARROW; 101dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 102dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 103dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev private Object mPointerIcon; 104dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 105dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev private PointerIconCompat(Object pointerIcon) { 106dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev mPointerIcon = pointerIcon; 107dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev } 108dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 109dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev /** 110dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @hide 111dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 1128e10080c914d1ad0784394fa3026b85535535847Aurimas Liutikas @RestrictTo(LIBRARY_GROUP) 113dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev public Object getPointerIcon() { 114dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev return mPointerIcon; 115dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev } 116dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 117dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev /** 118dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Gets a system pointer icon for the given style. 119dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * If style is not recognized, returns the default pointer icon. 120dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 121dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param context The context. 122dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param style The pointer icon style. 123dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @return The pointer icon. 124dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 125dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @throws IllegalArgumentException if context is null. 126dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 127dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev public static PointerIconCompat getSystemIcon(Context context, int style) { 128aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas if (SDK_INT >= 24) { 129aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(PointerIcon.getSystemIcon(context, style)); 130aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } else { 131aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(null); 132aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } 133dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev } 134dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 135dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev /** 136dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Creates a custom pointer from the given bitmap and hotspot information. 137dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 138dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param bitmap The bitmap for the icon. 139dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param hotSpotX The X offset of the pointer icon hotspot in the bitmap. 140dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Must be within the [0, bitmap.getWidth()) range. 141dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param hotSpotY The Y offset of the pointer icon hotspot in the bitmap. 142dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Must be within the [0, bitmap.getHeight()) range. 143dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @return A pointer icon for this bitmap. 144dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 145dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @throws IllegalArgumentException if bitmap is null, or if the x/y hotspot 146dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * parameters are invalid. 147dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 1485265345192fe12c768ff1cd1e6a37404eaec2fdaMichael Wright public static PointerIconCompat create(Bitmap bitmap, float hotSpotX, float hotSpotY) { 149aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas if (SDK_INT >= 24) { 150aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(PointerIcon.create(bitmap, hotSpotX, hotSpotY)); 151aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } else { 152aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(null); 153aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } 154dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev } 155dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev 156dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev /** 157dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * Loads a custom pointer icon from an XML resource. 158dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * <p> 159dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * The XML resource should have the following form: 160dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * <code> 161dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * <?xml version="1.0" encoding="utf-8"?> 162dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * <pointer-icon xmlns:android="http://schemas.android.com/apk/res/android" 163dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * android:bitmap="@drawable/my_pointer_bitmap" 164dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * android:hotSpotX="24" 165dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * android:hotSpotY="24" /> 166dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * </code> 167dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * </p> 168dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 169dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param resources The resources object. 170dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @param resourceId The resource id. 171dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @return The pointer icon. 172dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * 173dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @throws IllegalArgumentException if resources is null. 174dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * @throws Resources.NotFoundException if the resource was not found or the drawable 175dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev * linked in the resource was not found. 176dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev */ 1775265345192fe12c768ff1cd1e6a37404eaec2fdaMichael Wright public static PointerIconCompat load(Resources resources, int resourceId) { 178aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas if (SDK_INT >= 24) { 179aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(PointerIcon.load(resources, resourceId)); 180aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } else { 181aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas return new PointerIconCompat(null); 182aaa6f05a9af31601e21ae76ab005a5b4b966ca2cAurimas Liutikas } 183dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev } 184dd6652c3b47a245703ea2156b5b5712e2bbed23aVladislav Kaznacheev} 185