fbaron
aa1a462d0e
* 2 methods covered * Adding tests for PageIndicatorDots.java Bug: 353303621 Test: Not Applicable Flag: TEST_ONLY Change-Id: Ie30c0fb0e5efb041eb805e474d6d824d61238a3d
546 lines
18 KiB
Java
546 lines
18 KiB
Java
/*
|
|
* Copyright (C) 2016 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.launcher3.pageindicators;
|
|
|
|
import static com.android.launcher3.config.FeatureFlags.FOLDABLE_SINGLE_PAGE;
|
|
|
|
import android.animation.Animator;
|
|
import android.animation.AnimatorListenerAdapter;
|
|
import android.animation.AnimatorSet;
|
|
import android.animation.ObjectAnimator;
|
|
import android.animation.ValueAnimator;
|
|
import android.animation.ValueAnimator.AnimatorUpdateListener;
|
|
import android.content.Context;
|
|
import android.graphics.Canvas;
|
|
import android.graphics.Outline;
|
|
import android.graphics.Paint;
|
|
import android.graphics.Paint.Style;
|
|
import android.graphics.Rect;
|
|
import android.graphics.RectF;
|
|
import android.os.Handler;
|
|
import android.os.Looper;
|
|
import android.util.AttributeSet;
|
|
import android.util.FloatProperty;
|
|
import android.util.IntProperty;
|
|
import android.view.View;
|
|
import android.view.ViewConfiguration;
|
|
import android.view.ViewOutlineProvider;
|
|
import android.view.animation.Interpolator;
|
|
import android.view.animation.OvershootInterpolator;
|
|
|
|
import androidx.annotation.Nullable;
|
|
import androidx.annotation.VisibleForTesting;
|
|
|
|
import com.android.launcher3.Insettable;
|
|
import com.android.launcher3.R;
|
|
import com.android.launcher3.Utilities;
|
|
import com.android.launcher3.util.Themes;
|
|
|
|
/**
|
|
* {@link PageIndicator} which shows dots per page. The active page is shown with the current
|
|
* accent color.
|
|
*/
|
|
public class PageIndicatorDots extends View implements Insettable, PageIndicator {
|
|
|
|
private static final float SHIFT_PER_ANIMATION = 0.5f;
|
|
private static final float SHIFT_THRESHOLD = 0.1f;
|
|
private static final long ANIMATION_DURATION = 150;
|
|
private static final int PAGINATION_FADE_DELAY = ViewConfiguration.getScrollDefaultDelay();
|
|
private static final int PAGINATION_FADE_IN_DURATION = 83;
|
|
private static final int PAGINATION_FADE_OUT_DURATION = 167;
|
|
|
|
private static final int ENTER_ANIMATION_START_DELAY = 300;
|
|
private static final int ENTER_ANIMATION_STAGGERED_DELAY = 150;
|
|
private static final int ENTER_ANIMATION_DURATION = 400;
|
|
|
|
private static final int PAGE_INDICATOR_ALPHA = 255;
|
|
private static final int DOT_ALPHA = 128;
|
|
private static final float DOT_ALPHA_FRACTION = 0.5f;
|
|
private static final int DOT_GAP_FACTOR = 4;
|
|
private static final int VISIBLE_ALPHA = 255;
|
|
private static final int INVISIBLE_ALPHA = 0;
|
|
private Paint mPaginationPaint;
|
|
|
|
// This value approximately overshoots to 1.5 times the original size.
|
|
private static final float ENTER_ANIMATION_OVERSHOOT_TENSION = 4.9f;
|
|
|
|
private static final RectF sTempRect = new RectF();
|
|
|
|
private static final FloatProperty<PageIndicatorDots> CURRENT_POSITION =
|
|
new FloatProperty<PageIndicatorDots>("current_position") {
|
|
@Override
|
|
public Float get(PageIndicatorDots obj) {
|
|
return obj.mCurrentPosition;
|
|
}
|
|
|
|
@Override
|
|
public void setValue(PageIndicatorDots obj, float pos) {
|
|
obj.mCurrentPosition = pos;
|
|
obj.invalidate();
|
|
obj.invalidateOutline();
|
|
}
|
|
};
|
|
|
|
private static final IntProperty<PageIndicatorDots> PAGINATION_ALPHA =
|
|
new IntProperty<PageIndicatorDots>("pagination_alpha") {
|
|
@Override
|
|
public Integer get(PageIndicatorDots obj) {
|
|
return obj.mPaginationPaint.getAlpha();
|
|
}
|
|
|
|
@Override
|
|
public void setValue(PageIndicatorDots obj, int alpha) {
|
|
obj.mPaginationPaint.setAlpha(alpha);
|
|
obj.invalidate();
|
|
}
|
|
};
|
|
|
|
private final Handler mDelayedPaginationFadeHandler = new Handler(Looper.getMainLooper());
|
|
private final float mDotRadius;
|
|
private final float mCircleGap;
|
|
private final boolean mIsRtl;
|
|
|
|
private int mNumPages;
|
|
private int mActivePage;
|
|
private int mTotalScroll;
|
|
private boolean mShouldAutoHide;
|
|
private int mToAlpha;
|
|
|
|
/**
|
|
* The current position of the active dot including the animation progress.
|
|
* For ex:
|
|
* 0.0 => Active dot is at position 0
|
|
* 0.33 => Active dot is at position 0 and is moving towards 1
|
|
* 0.50 => Active dot is at position [0, 1]
|
|
* 0.77 => Active dot has left position 0 and is collapsing towards position 1
|
|
* 1.0 => Active dot is at position 1
|
|
*/
|
|
private float mCurrentPosition;
|
|
private float mFinalPosition;
|
|
private boolean mIsScrollPaused;
|
|
@VisibleForTesting
|
|
boolean mIsTwoPanels;
|
|
private ObjectAnimator mAnimator;
|
|
private @Nullable ObjectAnimator mAlphaAnimator;
|
|
|
|
private float[] mEntryAnimationRadiusFactors;
|
|
|
|
private final Runnable mHidePaginationRunnable =
|
|
() -> animatePaginationToAlpha(INVISIBLE_ALPHA);
|
|
|
|
public PageIndicatorDots(Context context) {
|
|
this(context, null);
|
|
}
|
|
|
|
public PageIndicatorDots(Context context, AttributeSet attrs) {
|
|
this(context, attrs, 0);
|
|
}
|
|
|
|
public PageIndicatorDots(Context context, AttributeSet attrs, int defStyleAttr) {
|
|
super(context, attrs, defStyleAttr);
|
|
|
|
mPaginationPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
|
|
mPaginationPaint.setStyle(Style.FILL);
|
|
mPaginationPaint.setColor(Themes.getAttrColor(context, R.attr.pageIndicatorDotColor));
|
|
mDotRadius = getResources().getDimension(R.dimen.page_indicator_dot_size) / 2;
|
|
mCircleGap = DOT_GAP_FACTOR * mDotRadius;
|
|
setOutlineProvider(new MyOutlineProver());
|
|
mIsRtl = Utilities.isRtl(getResources());
|
|
}
|
|
|
|
@Override
|
|
public void setScroll(int currentScroll, int totalScroll) {
|
|
if (currentScroll == 0 && totalScroll == 0) {
|
|
CURRENT_POSITION.set(this, (float) mActivePage);
|
|
return;
|
|
}
|
|
|
|
if (mNumPages <= 1) {
|
|
return;
|
|
}
|
|
|
|
// Skip scroll update during binding. We will update it when binding completes.
|
|
if (mIsScrollPaused) {
|
|
return;
|
|
}
|
|
|
|
if (mShouldAutoHide) {
|
|
animatePaginationToAlpha(VISIBLE_ALPHA);
|
|
}
|
|
|
|
if (mIsRtl) {
|
|
currentScroll = totalScroll - currentScroll;
|
|
}
|
|
|
|
mTotalScroll = totalScroll;
|
|
|
|
int scrollPerPage = totalScroll / (mNumPages - 1);
|
|
int pageToLeft = scrollPerPage == 0 ? 0 : currentScroll / scrollPerPage;
|
|
int pageToLeftScroll = pageToLeft * scrollPerPage;
|
|
int pageToRightScroll = pageToLeftScroll + scrollPerPage;
|
|
|
|
float scrollThreshold = SHIFT_THRESHOLD * scrollPerPage;
|
|
if (currentScroll < pageToLeftScroll + scrollThreshold) {
|
|
// scroll is within the left page's threshold
|
|
animateToPosition(pageToLeft);
|
|
if (mShouldAutoHide) {
|
|
hideAfterDelay();
|
|
}
|
|
} else if (currentScroll > pageToRightScroll - scrollThreshold) {
|
|
// scroll is far enough from left page to go to the right page
|
|
animateToPosition(pageToLeft + 1);
|
|
if (mShouldAutoHide) {
|
|
hideAfterDelay();
|
|
}
|
|
} else {
|
|
// scroll is between left and right page
|
|
animateToPosition(pageToLeft + SHIFT_PER_ANIMATION);
|
|
if (mShouldAutoHide) {
|
|
mDelayedPaginationFadeHandler.removeCallbacksAndMessages(null);
|
|
}
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void setShouldAutoHide(boolean shouldAutoHide) {
|
|
mShouldAutoHide = shouldAutoHide;
|
|
if (shouldAutoHide && mPaginationPaint.getAlpha() > INVISIBLE_ALPHA) {
|
|
hideAfterDelay();
|
|
} else if (!shouldAutoHide) {
|
|
mDelayedPaginationFadeHandler.removeCallbacksAndMessages(null);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void setPaintColor(int color) {
|
|
mPaginationPaint.setColor(color);
|
|
}
|
|
|
|
private void hideAfterDelay() {
|
|
mDelayedPaginationFadeHandler.removeCallbacksAndMessages(null);
|
|
mDelayedPaginationFadeHandler.postDelayed(mHidePaginationRunnable, PAGINATION_FADE_DELAY);
|
|
}
|
|
|
|
private void animatePaginationToAlpha(int alpha) {
|
|
if (alpha == mToAlpha) {
|
|
// Ignore the new animation if it is going to the same alpha as the current animation.
|
|
return;
|
|
}
|
|
|
|
if (mAlphaAnimator != null) {
|
|
mAlphaAnimator.cancel();
|
|
}
|
|
mAlphaAnimator = ObjectAnimator.ofInt(this, PAGINATION_ALPHA,
|
|
alpha);
|
|
// If we are animating to decrease the alpha, then it's a fade out animation
|
|
// whereas if we are animating to increase the alpha, it's a fade in animation.
|
|
mAlphaAnimator.setDuration(alpha < mToAlpha
|
|
? PAGINATION_FADE_OUT_DURATION
|
|
: PAGINATION_FADE_IN_DURATION);
|
|
mAlphaAnimator.addListener(new AnimatorListenerAdapter() {
|
|
@Override
|
|
public void onAnimationEnd(Animator animation) {
|
|
mAlphaAnimator = null;
|
|
}
|
|
});
|
|
mAlphaAnimator.start();
|
|
mToAlpha = alpha;
|
|
}
|
|
|
|
/**
|
|
* Pauses all currently running animations.
|
|
*/
|
|
@Override
|
|
public void pauseAnimations() {
|
|
if (mAlphaAnimator != null) {
|
|
mAlphaAnimator.pause();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Force-ends all currently running or paused animations.
|
|
*/
|
|
@Override
|
|
public void skipAnimationsToEnd() {
|
|
if (mAlphaAnimator != null) {
|
|
mAlphaAnimator.end();
|
|
}
|
|
}
|
|
|
|
private void animateToPosition(float position) {
|
|
mFinalPosition = position;
|
|
if (Math.abs(mCurrentPosition - mFinalPosition) < SHIFT_THRESHOLD) {
|
|
mCurrentPosition = mFinalPosition;
|
|
}
|
|
if (mAnimator == null && Float.compare(mCurrentPosition, mFinalPosition) != 0) {
|
|
float positionForThisAnim = mCurrentPosition > mFinalPosition ?
|
|
mCurrentPosition - SHIFT_PER_ANIMATION : mCurrentPosition + SHIFT_PER_ANIMATION;
|
|
mAnimator = ObjectAnimator.ofFloat(this, CURRENT_POSITION, positionForThisAnim);
|
|
mAnimator.addListener(new AnimationCycleListener());
|
|
mAnimator.setDuration(ANIMATION_DURATION);
|
|
mAnimator.start();
|
|
}
|
|
}
|
|
|
|
public void stopAllAnimations() {
|
|
if (mAnimator != null) {
|
|
mAnimator.cancel();
|
|
mAnimator = null;
|
|
}
|
|
mFinalPosition = mActivePage;
|
|
CURRENT_POSITION.set(this, mFinalPosition);
|
|
}
|
|
|
|
/**
|
|
* Sets up up the page indicator to play the entry animation.
|
|
* {@link #playEntryAnimation()} must be called after this.
|
|
*/
|
|
public void prepareEntryAnimation() {
|
|
mEntryAnimationRadiusFactors = new float[mNumPages];
|
|
invalidate();
|
|
}
|
|
|
|
public void playEntryAnimation() {
|
|
int count = mEntryAnimationRadiusFactors.length;
|
|
if (count == 0) {
|
|
mEntryAnimationRadiusFactors = null;
|
|
invalidate();
|
|
return;
|
|
}
|
|
|
|
Interpolator interpolator = new OvershootInterpolator(ENTER_ANIMATION_OVERSHOOT_TENSION);
|
|
AnimatorSet animSet = new AnimatorSet();
|
|
for (int i = 0; i < count; i++) {
|
|
ValueAnimator anim = ValueAnimator.ofFloat(0, 1).setDuration(ENTER_ANIMATION_DURATION);
|
|
final int index = i;
|
|
anim.addUpdateListener(new AnimatorUpdateListener() {
|
|
@Override
|
|
public void onAnimationUpdate(ValueAnimator animation) {
|
|
mEntryAnimationRadiusFactors[index] = (Float) animation.getAnimatedValue();
|
|
invalidate();
|
|
}
|
|
});
|
|
anim.setInterpolator(interpolator);
|
|
anim.setStartDelay(ENTER_ANIMATION_START_DELAY + ENTER_ANIMATION_STAGGERED_DELAY * i);
|
|
animSet.play(anim);
|
|
}
|
|
|
|
animSet.addListener(new AnimatorListenerAdapter() {
|
|
|
|
@Override
|
|
public void onAnimationEnd(Animator animation) {
|
|
mEntryAnimationRadiusFactors = null;
|
|
invalidateOutline();
|
|
invalidate();
|
|
}
|
|
});
|
|
animSet.start();
|
|
}
|
|
|
|
@Override
|
|
public void setActiveMarker(int activePage) {
|
|
// In unfolded foldables, every page has two CellLayouts, so we need to halve the active
|
|
// page for it to be accurate.
|
|
if (mIsTwoPanels && !FOLDABLE_SINGLE_PAGE.get()) {
|
|
activePage = activePage / 2;
|
|
}
|
|
|
|
if (mActivePage != activePage) {
|
|
mActivePage = activePage;
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void setMarkersCount(int numMarkers) {
|
|
mNumPages = numMarkers;
|
|
|
|
// If the last page gets removed we want to go to the previous page.
|
|
if (mNumPages > 0 && mNumPages == mActivePage) {
|
|
mActivePage--;
|
|
CURRENT_POSITION.set(this, (float) mActivePage);
|
|
}
|
|
|
|
requestLayout();
|
|
}
|
|
|
|
@Override
|
|
public void setPauseScroll(boolean pause, boolean isTwoPanels) {
|
|
mIsTwoPanels = isTwoPanels;
|
|
|
|
// Reapply correct current position which was skipped during setScroll.
|
|
if (mIsScrollPaused && !pause) {
|
|
CURRENT_POSITION.set(this, (float) mActivePage);
|
|
}
|
|
|
|
mIsScrollPaused = pause;
|
|
}
|
|
|
|
@Override
|
|
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
|
|
// Add extra spacing of mDotRadius on all sides so than entry animation could be run.
|
|
int width = MeasureSpec.getMode(widthMeasureSpec) == MeasureSpec.EXACTLY ?
|
|
MeasureSpec.getSize(widthMeasureSpec) : (int) ((mNumPages * 3 + 2) * mDotRadius);
|
|
int height = MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.EXACTLY
|
|
? MeasureSpec.getSize(heightMeasureSpec) : (int) (4 * mDotRadius);
|
|
setMeasuredDimension(width, height);
|
|
}
|
|
|
|
@Override
|
|
protected void onDraw(Canvas canvas) {
|
|
if (mNumPages < 2) {
|
|
return;
|
|
}
|
|
|
|
if (mShouldAutoHide && mTotalScroll == 0) {
|
|
mPaginationPaint.setAlpha(INVISIBLE_ALPHA);
|
|
return;
|
|
}
|
|
|
|
// Draw all page indicators;
|
|
float circleGap = mCircleGap;
|
|
float startX = ((float) getWidth() / 2)
|
|
- (mCircleGap * (((float) mNumPages - 1) / 2))
|
|
- mDotRadius;
|
|
|
|
float x = startX + mDotRadius;
|
|
float y = getHeight() / 2;
|
|
|
|
if (mEntryAnimationRadiusFactors != null) {
|
|
// During entry animation, only draw the circles
|
|
if (mIsRtl) {
|
|
x = getWidth() - x;
|
|
circleGap = -circleGap;
|
|
}
|
|
for (int i = 0; i < mEntryAnimationRadiusFactors.length; i++) {
|
|
mPaginationPaint.setAlpha(i == mActivePage ? PAGE_INDICATOR_ALPHA : DOT_ALPHA);
|
|
canvas.drawCircle(x, y, mDotRadius * mEntryAnimationRadiusFactors[i],
|
|
mPaginationPaint);
|
|
x += circleGap;
|
|
}
|
|
} else {
|
|
int alpha = mPaginationPaint.getAlpha();
|
|
|
|
// Here we draw the dots
|
|
mPaginationPaint.setAlpha((int) (alpha * DOT_ALPHA_FRACTION));
|
|
for (int i = 0; i < mNumPages; i++) {
|
|
canvas.drawCircle(x, y, mDotRadius, mPaginationPaint);
|
|
x += circleGap;
|
|
}
|
|
|
|
// Here we draw the current page indicator
|
|
mPaginationPaint.setAlpha(alpha);
|
|
canvas.drawRoundRect(getActiveRect(), mDotRadius, mDotRadius, mPaginationPaint);
|
|
}
|
|
}
|
|
|
|
private RectF getActiveRect() {
|
|
float startCircle = (int) mCurrentPosition;
|
|
float delta = mCurrentPosition - startCircle;
|
|
float diameter = 2 * mDotRadius;
|
|
float startX = ((float) getWidth() / 2)
|
|
- (mCircleGap * (((float) mNumPages - 1) / 2))
|
|
- mDotRadius;
|
|
sTempRect.top = (getHeight() * 0.5f) - mDotRadius;
|
|
sTempRect.bottom = (getHeight() * 0.5f) + mDotRadius;
|
|
sTempRect.left = startX + (startCircle * mCircleGap);
|
|
sTempRect.right = sTempRect.left + diameter;
|
|
|
|
if (delta < SHIFT_PER_ANIMATION) {
|
|
// dot is capturing the right circle.
|
|
sTempRect.right += delta * mCircleGap * 2;
|
|
} else {
|
|
// Dot is leaving the left circle.
|
|
sTempRect.right += mCircleGap;
|
|
|
|
delta -= SHIFT_PER_ANIMATION;
|
|
sTempRect.left += delta * mCircleGap * 2;
|
|
}
|
|
|
|
if (mIsRtl) {
|
|
float rectWidth = sTempRect.width();
|
|
sTempRect.right = getWidth() - sTempRect.left;
|
|
sTempRect.left = sTempRect.right - rectWidth;
|
|
}
|
|
|
|
return sTempRect;
|
|
}
|
|
|
|
@VisibleForTesting
|
|
int getActivePage() {
|
|
return mActivePage;
|
|
}
|
|
|
|
@VisibleForTesting
|
|
int getNumPages() {
|
|
return mNumPages;
|
|
}
|
|
|
|
@VisibleForTesting
|
|
float getCurrentPosition() {
|
|
return mCurrentPosition;
|
|
}
|
|
|
|
private class MyOutlineProver extends ViewOutlineProvider {
|
|
|
|
@Override
|
|
public void getOutline(View view, Outline outline) {
|
|
if (mEntryAnimationRadiusFactors == null) {
|
|
RectF activeRect = getActiveRect();
|
|
outline.setRoundRect(
|
|
(int) activeRect.left,
|
|
(int) activeRect.top,
|
|
(int) activeRect.right,
|
|
(int) activeRect.bottom,
|
|
mDotRadius
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Listener for keep running the animation until the final state is reached.
|
|
*/
|
|
private class AnimationCycleListener extends AnimatorListenerAdapter {
|
|
|
|
private boolean mCancelled = false;
|
|
|
|
@Override
|
|
public void onAnimationCancel(Animator animation) {
|
|
mCancelled = true;
|
|
}
|
|
|
|
@Override
|
|
public void onAnimationEnd(Animator animation) {
|
|
if (!mCancelled) {
|
|
if (mShouldAutoHide) {
|
|
hideAfterDelay();
|
|
}
|
|
mAnimator = null;
|
|
animateToPosition(mFinalPosition);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* We need to override setInsets to prevent InsettableFrameLayout from applying different
|
|
* margins on the pagination.
|
|
*/
|
|
@Override
|
|
public void setInsets(Rect insets) {
|
|
}
|
|
}
|