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