summaryrefslogtreecommitdiff
path: root/packages/SystemUI/src/com/android/systemui/statusbar/notification/icon/IconPack.java
blob: 054e381f096a7e87d2581f95f377a52cf457ff16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.systemui.statusbar.notification.icon;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.android.internal.statusbar.StatusBarIcon;
import com.android.systemui.statusbar.StatusBarIconView;

/**
 * Data class for storing icons associated with a notification
 */
public final class IconPack {

    private final boolean mAreIconsAvailable;
    @Nullable private final StatusBarIconView mStatusBarIcon;
    @Nullable private final StatusBarIconView mShelfIcon;
    @Nullable private final StatusBarIconView mAodIcon;
    @Nullable private final StatusBarIconView mCenteredIcon;

    @Nullable private StatusBarIcon mSmallIconDescriptor;
    @Nullable private StatusBarIcon mPeopleAvatarDescriptor;

    private boolean mIsImportantConversation;

    /**
     * Builds an empty instance of IconPack that doesn't have any icons (because either they
     * haven't been inflated yet or there was an error while inflating them).
     */
    public static IconPack buildEmptyPack(@Nullable IconPack fromSource) {
        return new IconPack(false, null, null, null, null, fromSource);
    }

    /**
     * Builds an instance of an IconPack that contains successfully-inflated icons
     */
    public static IconPack buildPack(
            @NonNull StatusBarIconView statusBarIcon,
            @NonNull StatusBarIconView shelfIcon,
            @NonNull StatusBarIconView aodIcon,
            @Nullable StatusBarIconView centeredIcon,
            @Nullable IconPack source) {
        return new IconPack(true, statusBarIcon, shelfIcon, aodIcon, centeredIcon, source);
    }

    private IconPack(
            boolean areIconsAvailable,
            @Nullable StatusBarIconView statusBarIcon,
            @Nullable StatusBarIconView shelfIcon,
            @Nullable StatusBarIconView aodIcon,
            @Nullable StatusBarIconView centeredIcon,
            @Nullable IconPack source) {
        mAreIconsAvailable = areIconsAvailable;
        mStatusBarIcon = statusBarIcon;
        mShelfIcon = shelfIcon;
        mCenteredIcon = centeredIcon;
        mAodIcon = aodIcon;
        if (source != null) {
            mIsImportantConversation = source.mIsImportantConversation;
        }
    }

    /** The version of the notification icon that appears in the status bar. */
    @Nullable
    public StatusBarIconView getStatusBarIcon() {
        return mStatusBarIcon;
    }

    /**
     * The version of the icon that appears in the "shelf" at the bottom of the notification shade.
     * In general, this icon also appears somewhere on the notification and is "sucked" into the
     * shelf as the scrolls beyond it.
     */
    @Nullable
    public StatusBarIconView getShelfIcon() {
        return mShelfIcon;
    }

    @Nullable
    public StatusBarIconView getCenteredIcon() {
        return mCenteredIcon;
    }

    /** The version of the icon that's shown when pulsing (in AOD). */
    @Nullable
    public StatusBarIconView getAodIcon() {
        return mAodIcon;
    }

    @Nullable
    StatusBarIcon getSmallIconDescriptor() {
        return mSmallIconDescriptor;
    }

    void setSmallIconDescriptor(@Nullable StatusBarIcon smallIconDescriptor) {
        mSmallIconDescriptor = smallIconDescriptor;
    }

    @Nullable
    StatusBarIcon getPeopleAvatarDescriptor() {
        return mPeopleAvatarDescriptor;
    }

    void setPeopleAvatarDescriptor(@Nullable StatusBarIcon peopleAvatarDescriptor) {
        mPeopleAvatarDescriptor = peopleAvatarDescriptor;
    }

    boolean isImportantConversation() {
        return mIsImportantConversation;
    }

    void setImportantConversation(boolean importantConversation) {
        mIsImportantConversation = importantConversation;
    }

    public boolean getAreIconsAvailable() {
        return mAreIconsAvailable;
    }
}