src/com/android/wallpaper/model/CustomizationSectionController.java


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

/*
 * Copyright (C) 2021 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.wallpaper.model;

import android.content.Context;
import android.os.Bundle;

import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;

import com.android.wallpaper.picker.SectionView;

/**
 * The interface for the behavior of section in the customization picker.
 *
 * @param <T> the {@link SectionView} to create for the section
 */
public interface CustomizationSectionController<T extends SectionView> {

    /** Interface for customization section navigation. */
    interface CustomizationSectionNavigationController {
        /** Navigates to the given {@code fragment}. */
        void navigateTo(Fragment fragment);

        /** Navigates to a {@code fragment} that maps to the given destination ID. */
        void navigateTo(String destinationId);
    }

    /** Returns {@code true} if the customization section is available. */
    boolean isAvailable(@Nullable Context context);

    /**
     * Returns a newly created {@link SectionView} for the section.
     *
     * @param context The {@link Context} to inflate view.
     * @param isOnLockScreen Whether we are on the lock screen.
     */
    default T createView(Context context, boolean isOnLockScreen) {
        return createView(context);
    }

    /**
     * Returns a newly created {@link SectionView} for the section.
     *
     * @param context the {@link Context} to inflate view
     */
    T createView(Context context);

    /** Saves the view state for configuration changes. */
    default void onSaveInstanceState(Bundle savedInstanceState) {}

    /** Releases the controller. */
    default void release() {}

    /** Gets called when the section gets transitioned out. */
    default void onTransitionOut() {}

    /** Notifies when the screen was switched. */
    default void onScreenSwitched(boolean isOnLockScreen) {}
}