1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.launcher3.model.data;
18 
19 import com.android.launcher3.icons.BitmapInfo;
20 
21 /**
22  * Represents an ItemInfo which also holds an icon.
23  */
24 public abstract class ItemInfoWithIcon extends ItemInfo {
25 
26     public static final String TAG = "ItemInfoDebug";
27 
28     /**
29      * The bitmap for the application icon
30      */
31     public BitmapInfo bitmap = BitmapInfo.LOW_RES_INFO;
32 
33     /**
34      * Indicates that the icon is disabled due to safe mode restrictions.
35      */
36     public static final int FLAG_DISABLED_SAFEMODE = 1 << 0;
37 
38     /**
39      * Indicates that the icon is disabled as the app is not available.
40      */
41     public static final int FLAG_DISABLED_NOT_AVAILABLE = 1 << 1;
42 
43     /**
44      * Indicates that the icon is disabled as the app is suspended
45      */
46     public static final int FLAG_DISABLED_SUSPENDED = 1 << 2;
47 
48     /**
49      * Indicates that the icon is disabled as the user is in quiet mode.
50      */
51     public static final int FLAG_DISABLED_QUIET_USER = 1 << 3;
52 
53     /**
54      * Indicates that the icon is disabled as the publisher has disabled the actual shortcut.
55      */
56     public static final int FLAG_DISABLED_BY_PUBLISHER = 1 << 4;
57 
58     /**
59      * Indicates that the icon is disabled as the user partition is currently locked.
60      */
61     public static final int FLAG_DISABLED_LOCKED_USER = 1 << 5;
62 
63     public static final int FLAG_DISABLED_MASK = FLAG_DISABLED_SAFEMODE
64             | FLAG_DISABLED_NOT_AVAILABLE | FLAG_DISABLED_SUSPENDED
65             | FLAG_DISABLED_QUIET_USER | FLAG_DISABLED_BY_PUBLISHER | FLAG_DISABLED_LOCKED_USER;
66 
67     /**
68      * The item points to a system app.
69      */
70     public static final int FLAG_SYSTEM_YES = 1 << 6;
71 
72     /**
73      * The item points to a non system app.
74      */
75     public static final int FLAG_SYSTEM_NO = 1 << 7;
76 
77     public static final int FLAG_SYSTEM_MASK = FLAG_SYSTEM_YES | FLAG_SYSTEM_NO;
78 
79     /**
80      * Flag indicating that the icon is an {@link android.graphics.drawable.AdaptiveIconDrawable}
81      * that can be optimized in various way.
82      */
83     public static final int FLAG_ADAPTIVE_ICON = 1 << 8;
84 
85     /**
86      * Flag indicating that the icon is badged.
87      */
88     public static final int FLAG_ICON_BADGED = 1 << 9;
89 
90     /**
91      * Status associated with the system state of the underlying item. This is calculated every
92      * time a new info is created and not persisted on the disk.
93      */
94     public int runtimeStatusFlags = 0;
95 
ItemInfoWithIcon()96     protected ItemInfoWithIcon() { }
97 
ItemInfoWithIcon(ItemInfoWithIcon info)98     protected ItemInfoWithIcon(ItemInfoWithIcon info) {
99         super(info);
100         bitmap = info.bitmap;
101         runtimeStatusFlags = info.runtimeStatusFlags;
102     }
103 
104     @Override
isDisabled()105     public boolean isDisabled() {
106         return (runtimeStatusFlags & FLAG_DISABLED_MASK) != 0;
107     }
108 
109     /**
110      * Indicates whether we're using a low res icon
111      */
usingLowResIcon()112     public boolean usingLowResIcon() {
113         return bitmap.isLowRes();
114     }
115 
116     /**
117      * @return a copy of this
118      */
clone()119     public abstract ItemInfoWithIcon clone();
120 }
121