summaryrefslogtreecommitdiff
path: root/src/com/android/launcher3/statemanager/BaseState.java
blob: 122573cfa1f3dea87b9217111e9b6ce1fa19d222 (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
/*
 * 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.launcher3.statemanager;

import android.content.Context;

import com.android.launcher3.DeviceProfile;

/**
 * Interface representing a state of a StatefulActivity
 */
public interface BaseState<T extends BaseState> {

    // Flag to indicate that Launcher is non-interactive in this state
    int FLAG_NON_INTERACTIVE = 1 << 0;
    int FLAG_DISABLE_RESTORE = 1 << 1;

    static int getFlag(int index) {
        // reserve few spots to base flags
        return 1 << (index + 2);
    }

    /**
     * @return How long the animation to this state should take (or from this state to NORMAL).
     */
    int getTransitionDuration(Context context);

    /**
     * Returns the state to go back to from this state
     */
    T getHistoryForState(T previousState);

    /**
     * @return true if the state can be persisted across activity restarts.
     */
    default boolean shouldDisableRestore() {
        return hasFlag(FLAG_DISABLE_RESTORE);
    }

    /**
     * Returns if the state has the provided flag
     */
    boolean hasFlag(int flagMask);

    /**
     * For this state, whether tasks should layout as a grid rather than a list.
     */
    default boolean displayOverviewTasksAsGrid(DeviceProfile deviceProfile) {
        return false;
    }
}