blob: 4697b82f8124fc0ba22d2e9adbe3eadff89132b3 [file] [log] [blame]
/*
* Copyright (C) 2017 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;
import static android.view.View.IMPORTANT_FOR_ACCESSIBILITY_AUTO;
import static android.view.View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS;
import static android.view.accessibility.AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED;
import static com.android.launcher3.anim.Interpolators.ACCEL_2;
import static com.android.launcher3.states.RotationHelper.REQUEST_NONE;
import android.view.View;
import android.view.animation.Interpolator;
import com.android.launcher3.states.SpringLoadedState;
import com.android.launcher3.uioverrides.AllAppsState;
import com.android.launcher3.uioverrides.FastOverviewState;
import com.android.launcher3.uioverrides.OverviewState;
import com.android.launcher3.uioverrides.UiFactory;
import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
import java.util.Arrays;
/**
* Base state for various states used for the Launcher
*/
public class LauncherState {
/**
* Set of elements indicating various workspace elements which change visibility across states
* Note that workspace is not included here as in that case, we animate individual pages
*/
public static final int NONE = 0;
public static final int HOTSEAT_ICONS = 1 << 0;
public static final int HOTSEAT_SEARCH_BOX = 1 << 1;
public static final int ALL_APPS_HEADER = 1 << 2;
public static final int ALL_APPS_HEADER_EXTRA = 1 << 3; // e.g. app predictions
public static final int ALL_APPS_CONTENT = 1 << 4;
public static final int DRAG_HANDLE_INDICATOR = 1 << 5;
protected static final int FLAG_SHOW_SCRIM = 1 << 0;
protected static final int FLAG_MULTI_PAGE = 1 << 1;
protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 2;
protected static final int FLAG_DISABLE_RESTORE = 1 << 3;
protected static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = 1 << 4;
protected static final int FLAG_DISABLE_PAGE_CLIPPING = 1 << 5;
protected static final int FLAG_PAGE_BACKGROUNDS = 1 << 6;
protected static final int FLAG_ALL_APPS_SCRIM = 1 << 7;
protected static final int FLAG_DISABLE_INTERACTION = 1 << 8;
protected static final int FLAG_OVERVIEW_UI = 1 << 9;
protected static final int FLAG_HIDE_BACK_BUTTON = 1 << 10;
protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
new PageAlphaProvider(ACCEL_2) {
@Override
public float getPageAlpha(int pageIndex) {
return 1;
}
};
private static final LauncherState[] sAllStates = new LauncherState[5];
/**
* TODO: Create a separate class for NORMAL state.
*/
public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE,
0, FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HIDE_BACK_BUTTON);
/**
* Various Launcher states arranged in the increasing order of UI layers
*/
public static final LauncherState SPRING_LOADED = new SpringLoadedState(1);
public static final LauncherState OVERVIEW = new OverviewState(2);
public static final LauncherState FAST_OVERVIEW = new FastOverviewState(3);
public static final LauncherState ALL_APPS = new AllAppsState(4);
public final int ordinal;
/**
* Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
*/
public final int containerType;
/**
* True if the state can be persisted across activity restarts.
*/
public final boolean disableRestore;
/**
* True if workspace has multiple pages visible.
*/
public final boolean hasMultipleVisiblePages;
/**
* Accessibility flag for workspace and its pages.
* @see android.view.View#setImportantForAccessibility(int)
*/
public final int workspaceAccessibilityFlag;
/**
* Properties related to state transition animation
*
* @see WorkspaceStateTransitionAnimation
*/
public final boolean hasScrim;
public final boolean hasWorkspacePageBackground;
public final boolean hasAllAppsScrim;
public final int transitionDuration;
/**
* True if the state allows workspace icons to be dragged.
*/
public final boolean workspaceIconsCanBeDragged;
/**
* True if the workspace pages should not be clipped relative to the workspace bounds
* for this state.
*/
public final boolean disablePageClipping;
/**
* True if launcher can not be directly interacted in this state;
*/
public final boolean disableInteraction;
/**
* True if the state has overview panel visible.
*/
public final boolean overviewUi;
/**
* True if the back button should be hidden when in this state (assuming no floating views are
* open, launcher has window focus, etc).
*/
public final boolean hideBackButton;
public LauncherState(int id, int containerType, int transitionDuration, int flags) {
this.containerType = containerType;
this.transitionDuration = transitionDuration;
this.hasScrim = (flags & FLAG_SHOW_SCRIM) != 0;
this.hasWorkspacePageBackground = (flags & FLAG_PAGE_BACKGROUNDS) != 0;
this.hasAllAppsScrim = (flags & FLAG_ALL_APPS_SCRIM) != 0;
this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
: IMPORTANT_FOR_ACCESSIBILITY_AUTO;
this.disableRestore = (flags & FLAG_DISABLE_RESTORE) != 0;
this.workspaceIconsCanBeDragged = (flags & FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED) != 0;
this.disablePageClipping = (flags & FLAG_DISABLE_PAGE_CLIPPING) != 0;
this.disableInteraction = (flags & FLAG_DISABLE_INTERACTION) != 0;
this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
this.hideBackButton = (flags & FLAG_HIDE_BACK_BUTTON) != 0;
this.ordinal = id;
sAllStates[id] = this;
}
public static LauncherState[] values() {
return Arrays.copyOf(sAllStates, sAllStates.length);
}
public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
return new float[] {1, 0, 0};
}
/**
* Returns 2 floats designating how to transition overview:
* scale for the current and adjacent pages
* translationY factor where 0 is top aligned and 0.5 is centered vertically
*/
public float[] getOverviewScaleAndTranslationYFactor(Launcher launcher) {
return new float[] {1.2f, 0.2f};
}
public void onStateEnabled(Launcher launcher) {
dispatchWindowStateChanged(launcher);
}
public void onStateDisabled(Launcher launcher) { }
public View getFinalFocus(Launcher launcher) {
return launcher.getWorkspace();
}
public int getVisibleElements(Launcher launcher) {
if (launcher.getDeviceProfile().isVerticalBarLayout()) {
return HOTSEAT_ICONS | DRAG_HANDLE_INDICATOR;
}
return HOTSEAT_ICONS | DRAG_HANDLE_INDICATOR | HOTSEAT_SEARCH_BOX;
}
/**
* Fraction shift in the vertical translation UI and related properties
*
* @see com.android.launcher3.allapps.AllAppsTransitionController
*/
public float getVerticalProgress(Launcher launcher) {
return 1f;
}
public String getDescription(Launcher launcher) {
return launcher.getWorkspace().getCurrentPageDescription();
}
public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
if (this != NORMAL || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
return DEFAULT_ALPHA_PROVIDER;
}
final int centerPage = launcher.getWorkspace().getNextPage();
return new PageAlphaProvider(ACCEL_2) {
@Override
public float getPageAlpha(int pageIndex) {
return pageIndex != centerPage ? 0 : 1f;
}
};
}
public LauncherState getHistoryForState(LauncherState previousState) {
// No history is supported
return NORMAL;
}
/**
* Called when the start transition ends and the user settles on this particular state.
*/
public void onStateTransitionEnd(Launcher launcher) {
if (this == NORMAL) {
UiFactory.resetOverview(launcher);
// Clear any rotation locks when going to normal state
launcher.getRotationHelper().setCurrentStateRequest(REQUEST_NONE);
}
}
protected static void dispatchWindowStateChanged(Launcher launcher) {
launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
}
public static abstract class PageAlphaProvider {
public final Interpolator interpolator;
public PageAlphaProvider(Interpolator interpolator) {
this.interpolator = interpolator;
}
public abstract float getPageAlpha(int pageIndex);
}
}