File: RoundedCorner.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 326,084 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 120; sed: 19
file content (233 lines) | stat: -rw-r--r-- 6,953 bytes parent folder | download | duplicates (2)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*
 * 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 android.view;

import android.annotation.IntDef;
import android.annotation.NonNull;
import android.graphics.Point;
import android.os.Parcel;
import android.os.Parcelable;

import com.android.internal.annotations.VisibleForTesting;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Represents a rounded corner of the display.
 * <p>
 * <img src="{@docRoot}reference/android/images/rounded_corner/rounded-corner-info.png" height="120"
 * alt="A figure to describe what the rounded corner radius and the center point are. "/>
 * </p>
 *
 * <p>Note: The rounded corner formed by the radius and the center is an approximation.</p>
 *
 * <p>{@link RoundedCorner} is immutable.</p>
 */
public final class RoundedCorner implements Parcelable {

    /**
     * The rounded corner is at the top-left of the screen.
     */
    public static final int POSITION_TOP_LEFT = 0;
    /**
     * The rounded corner is at the top-right of the screen.
     */
    public static final int POSITION_TOP_RIGHT = 1;
    /**
     * The rounded corner is at the bottom-right of the screen.
     */
    public static final int POSITION_BOTTOM_RIGHT = 2;
    /**
     * The rounded corner is at the bottom-left of the screen.
     */
    public static final int POSITION_BOTTOM_LEFT = 3;

    /**
     * @hide
     */
    @IntDef(prefix = { "POSITION_" }, value = {
            POSITION_TOP_LEFT,
            POSITION_TOP_RIGHT,
            POSITION_BOTTOM_RIGHT,
            POSITION_BOTTOM_LEFT
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface Position {}

    private final @Position int mPosition;
    private final int mRadius;
    @NonNull
    private final Point mCenter;

    /**
     * Creates an empty {@link RoundedCorner} on the given position.
     * @hide
     */
    @VisibleForTesting
    public RoundedCorner(@Position int position) {
        mPosition = position;
        mRadius = 0;
        mCenter = new Point(0, 0);
    }

    /**
     * Creates a {@link RoundedCorner}.
     *
     * <p>Note that this is only useful for tests. For production code, developers should always
     * use a {@link RoundedCorner} obtained from the system via
     * {@link WindowInsets#getRoundedCorner} or {@link Display#getRoundedCorner}.</p>
     *
     * @param position the position of the rounded corner.
     * @param radius the radius of the rounded corner.
     * @param centerX the x of center point of the rounded corner.
     * @param centerY the y of center point of the rounded corner.
     *
     */
    public RoundedCorner(@Position int position, int radius, int centerX,
            int centerY) {
        mPosition = position;
        mRadius = radius;
        mCenter = new Point(centerX, centerY);
    }

    /**
     * Creates a {@link RoundedCorner} from a passed in {@link RoundedCorner}.
     *
     * @hide
     */
    RoundedCorner(RoundedCorner rc) {
        mPosition = rc.getPosition();
        mRadius = rc.getRadius();
        mCenter = new Point(rc.getCenter());
    }

    /**
     * Get the position of this {@link RoundedCorner}.
     *
     * @see #POSITION_TOP_LEFT
     * @see #POSITION_TOP_RIGHT
     * @see #POSITION_BOTTOM_RIGHT
     * @see #POSITION_BOTTOM_LEFT
     */
    public @Position int getPosition() {
        return mPosition;
    }

    /**
     * Returns the radius of a quarter circle approximation of this {@link RoundedCorner}.
     *
     * @return the rounded corner radius of this {@link RoundedCorner}. Returns 0 if there is no
     * rounded corner.
     */
    public int getRadius() {
        return mRadius;
    }

    /**
     * Returns the circle center of a quarter circle approximation of this {@link RoundedCorner}.
     *
     * @return the center point of this {@link RoundedCorner} in the application's coordinate.
     */
    @NonNull
    public Point getCenter() {
        return new Point(mCenter);
    }

    /**
     * Checks whether this {@link RoundedCorner} exists and is inside the application's bounds.
     *
     * @return {@code false} if there is a rounded corner and is contained in the application's
     *                       bounds. Otherwise return {@code true}.
     *
     * @hide
     */
    public boolean isEmpty() {
        return mRadius == 0 || mCenter.x <= 0 || mCenter.y <= 0;
    }

    private String getPositionString(@Position int position) {
        switch (position) {
            case POSITION_TOP_LEFT:
                return "TopLeft";
            case POSITION_TOP_RIGHT:
                return "TopRight";
            case POSITION_BOTTOM_RIGHT:
                return "BottomRight";
            case POSITION_BOTTOM_LEFT:
                return "BottomLeft";
            default:
                return "Invalid";
        }
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (o instanceof RoundedCorner) {
            RoundedCorner r = (RoundedCorner) o;
            return mPosition == r.mPosition && mRadius == r.mRadius
                    && mCenter.equals(r.mCenter);
        }
        return false;
    }

    @Override
    public int hashCode() {
        int result = 0;
        result = 31 * result + mPosition;
        result = 31 * result + mRadius;
        result = 31 * result + mCenter.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return "RoundedCorner{"
                + "position=" + getPositionString(mPosition)
                + ", radius=" + mRadius
                + ", center=" + mCenter
                + '}';
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(@NonNull Parcel out, int flags) {
        out.writeInt(mPosition);
        out.writeInt(mRadius);
        out.writeInt(mCenter.x);
        out.writeInt(mCenter.y);
    }

    public static final @NonNull Creator<RoundedCorner> CREATOR = new Creator<RoundedCorner>() {
        @Override
        public RoundedCorner createFromParcel(Parcel in) {
            return new RoundedCorner(in.readInt(), in.readInt(), in.readInt(), in.readInt());
        }

        @Override
        public RoundedCorner[] newArray(int size) {
            return new RoundedCorner[size];
        }
    };
}