1 /*
2  * Copyright (C) 2021 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 package com.android.launcher3.util;
17 
18 import android.util.FloatProperty;
19 
20 /**
21  * Allows the implementing view to add insets to the left and right.
22  */
23 public interface HorizontalInsettableView {
24 
25     /**
26      * Sets left and right insets for the view so it looks like the width of the view is
27      * reduced when inset is increased.
28      *
29      * The inset is calculated based on the width of the view: e.g. when the width of
30      * the view is 100px then if we apply 0.15f horizontal inset percentage the rendered width
31      * of the view will be 70px with 15px of padding on the left and right sides.
32      *
33      * @param insetPercentage width percentage to inset the content from the left and from the right
34      */
setHorizontalInsets(float insetPercentage)35     void setHorizontalInsets(float insetPercentage);
36 
37     /**
38      * Returns the width percentage to inset the content from the left and from the right. See
39      * {@link #setHorizontalInsets};
40      */
getHorizontalInsets()41     float getHorizontalInsets();
42 
43     FloatProperty<HorizontalInsettableView> HORIZONTAL_INSETS =
44             new FloatProperty<HorizontalInsettableView>("horizontalInsets") {
45                 @Override
46                 public Float get(HorizontalInsettableView view) {
47                     return view.getHorizontalInsets();
48                 }
49 
50                 @Override
51                 public void setValue(HorizontalInsettableView view, float insetPercentage) {
52                     view.setHorizontalInsets(insetPercentage);
53                 }
54             };
55 }
56