1/*
2 * Copyright (C) 2016 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
17package androidx.transition;
18
19import android.graphics.drawable.Drawable;
20
21import androidx.annotation.NonNull;
22
23interface ViewOverlayImpl {
24
25    /**
26     * Adds a Drawable to the overlay. The bounds of the drawable should be relative to
27     * the host view. Any drawable added to the overlay should be removed when it is no longer
28     * needed or no longer visible.
29     *
30     * @param drawable The Drawable to be added to the overlay. This drawable will be
31     *                 drawn when the view redraws its overlay.
32     * @see #remove(Drawable)
33     */
34    void add(@NonNull Drawable drawable);
35
36    /**
37     * Removes all content from the overlay.
38     */
39    void clear();
40
41    /**
42     * Removes the specified Drawable from the overlay.
43     *
44     * @param drawable The Drawable to be removed from the overlay.
45     * @see #add(Drawable)
46     */
47    void remove(@NonNull Drawable drawable);
48
49}
50