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 package com.android.launcher3.pageindicators; 17 18 /** 19 * Base class for a page indicator. 20 */ 21 public interface PageIndicator { 22 setScroll(int currentScroll, int totalScroll)23 void setScroll(int currentScroll, int totalScroll); 24 setActiveMarker(int activePage)25 void setActiveMarker(int activePage); 26 setMarkersCount(int numMarkers)27 void setMarkersCount(int numMarkers); 28 29 /** 30 * Sets flag to indicate when the screens are in the process of binding so that we don't animate 31 * during that period. 32 */ setAreScreensBinding(boolean areScreensBinding)33 default void setAreScreensBinding(boolean areScreensBinding) { 34 // No-op by default 35 } 36 37 /** 38 * Sets the flag if the Page Indicator should autohide. 39 */ setShouldAutoHide(boolean shouldAutoHide)40 default void setShouldAutoHide(boolean shouldAutoHide) { 41 // No-op by default 42 } 43 44 /** 45 * Pauses all currently running animations. 46 */ pauseAnimations()47 default void pauseAnimations() { 48 // No-op by default 49 } 50 51 /** 52 * Force-ends all currently running or paused animations. 53 */ skipAnimationsToEnd()54 default void skipAnimationsToEnd() { 55 // No-op by default 56 } 57 58 /** 59 * Sets the paint color. 60 */ setPaintColor(int color)61 default void setPaintColor(int color) { 62 // No-op by default 63 } 64 } 65