// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.chrome.browser.compositor.scene_layer;
import androidx.annotation.ColorInt;
import org.jni_zero.JNINamespace;
import org.jni_zero.NativeMethods;
import org.chromium.cc.input.OffsetTag;
import org.chromium.chrome.browser.compositor.LayerTitleCache;
import org.chromium.chrome.browser.compositor.layouts.components.CompositorButton;
import org.chromium.chrome.browser.compositor.layouts.components.TintedCompositorButton;
import org.chromium.chrome.browser.compositor.overlays.strip.StripLayoutGroupTitle;
import org.chromium.chrome.browser.compositor.overlays.strip.StripLayoutHelperManager;
import org.chromium.chrome.browser.compositor.overlays.strip.StripLayoutTab;
import org.chromium.chrome.browser.flags.ChromeFeatureList;
import org.chromium.chrome.browser.layouts.scene_layer.SceneLayer;
import org.chromium.chrome.browser.layouts.scene_layer.SceneOverlayLayer;
import org.chromium.ui.resources.ResourceManager;
/**
* The Java component of what is basically a CC Layer that manages drawing the Tab Strip (which is
* composed of {@link StripLayoutTab}s) to the screen. This object keeps the layers up to date and
* removes/creates children as necessary. This object is built by its native counterpart.
*/
@JNINamespace("android")
public class TabStripSceneLayer extends SceneOverlayLayer {
private static boolean sTestFlag;
private long mNativePtr;
private final float mDpToPx;
/**
* @param density Density for Dp to Px conversion.
*/
public TabStripSceneLayer(float density) {
mDpToPx = density;
}
public static void setTestFlag(boolean testFlag) {
sTestFlag = testFlag;
}
@Override
protected void initializeNative() {
if (mNativePtr == 0) {
mNativePtr = TabStripSceneLayerJni.get().init(TabStripSceneLayer.this);
}
// Set flag for testing
if (!sTestFlag) {
assert mNativePtr != 0;
}
}
@Override
public void setContentTree(SceneLayer contentTree) {
TabStripSceneLayerJni.get()
.setContentTree(mNativePtr, TabStripSceneLayer.this, contentTree);
}
/**
* Pushes all relevant {@link StripLayoutTab}s to the CC Layer tree. This also pushes any other
* assets required to draw the Tab Strip. This should only be called when the Compositor has
* disabled ScheduleComposite calls as this will change the tree and could subsequently cause
* unnecessary follow up renders.
*
* @param layoutHelper A layout helper for the tab strip.
* @param layerTitleCache A layer title cache.
* @param resourceManager A resource manager.
* @param stripLayoutTabsToRender Array of strip layout tabs.
* @param yOffset Current browser controls offset in dp.
* @param selectedTabId The ID of the selected tab.
* @param hoveredTabId The ID of the hovered tab, if any. If no tab is hovered on, this ID will
* be invalid.
* @param scrimColor The color of the scrim overlay that covers the tab strip.
* @param scrimOpacity The opacity of the scrim overlay that covers the tab strip.
*/
public void pushAndUpdateStrip(
StripLayoutHelperManager layoutHelper,
LayerTitleCache layerTitleCache,
ResourceManager resourceManager,
StripLayoutTab[] stripLayoutTabsToRender,
StripLayoutGroupTitle[] stripLayoutGroupTitlesToRender,
float yOffset,
int selectedTabId,
int hoveredTabId,
int scrimColor,
float scrimOpacity,
float leftPaddingDp,
float rightPaddingDp,
float topPaddingDp) {
if (mNativePtr == 0) return;
final boolean visible = yOffset > -layoutHelper.getHeight();
// When BrowserControlsInViz is enabled, this function will be called sparingly during a
// scroll to reduce/remove browser frames. If the tab strip isn't visible,
// beginBuildingFrame would cause the layer tree to be hidden. Later, when the TabStrip is
// scrolled back into view, beginBuildingFrame would need to be called again to unhide the
// layer tree, but we don't want either of these 2 calls to happen because it would result
// in 2 more browser frames. So, we short circuit to keep the layer tree always visible.
if (ChromeFeatureList.sBrowserControlsInViz.isEnabled() && !visible) {
return;
}
// This will hide the tab strips if necessary.
TabStripSceneLayerJni.get()
.beginBuildingFrame(mNativePtr, TabStripSceneLayer.this, visible);
// When strip tabs are completely off screen, we don't need to update it.
if (visible) {
// Ceil the padding to avoid off-by-one issues similar to crbug/329722454. This is
// required since these values are originated from Android UI.
float leftPaddingPx = (float) Math.ceil(leftPaddingDp * mDpToPx);
float rightPaddingPx = (float) Math.ceil(rightPaddingDp * mDpToPx);
float topPaddingPx = (float) Math.ceil(topPaddingDp * mDpToPx);
pushButtonsAndBackground(
layoutHelper,
resourceManager,
yOffset,
scrimColor,
scrimOpacity,
leftPaddingPx,
rightPaddingPx,
topPaddingPx);
pushStripTabs(
layoutHelper,
layerTitleCache,
resourceManager,
stripLayoutTabsToRender,
selectedTabId,
hoveredTabId);
pushGroupIndicators(stripLayoutGroupTitlesToRender, layerTitleCache);
}
TabStripSceneLayerJni.get().finishBuildingFrame(mNativePtr, TabStripSceneLayer.this);
}
public void updateOffsetTag(OffsetTag offsetTag) {
TabStripSceneLayerJni.get().updateOffsetTag(mNativePtr, TabStripSceneLayer.this, offsetTag);
}
private void pushButtonsAndBackground(
StripLayoutHelperManager layoutHelper,
ResourceManager resourceManager,
float yOffset,
@ColorInt int scrimColor,
float scrimOpacity,
float leftPaddingPx,
float rightPaddingPx,
float topPaddingPx) {
final int width = Math.round(layoutHelper.getWidth() * mDpToPx);
final int height = Math.round(layoutHelper.getHeight() * mDpToPx);
TabStripSceneLayerJni.get()
.updateTabStripLayer(
mNativePtr,
TabStripSceneLayer.this,
width,
height,
yOffset * mDpToPx,
layoutHelper.getBackgroundColor(),
scrimColor,
scrimOpacity,
leftPaddingPx,
rightPaddingPx,
topPaddingPx);
TintedCompositorButton newTabButton = layoutHelper.getNewTabButton();
boolean newTabButtonVisible = newTabButton.isVisible();
TabStripSceneLayerJni.get()
.updateNewTabButton(
mNativePtr,
TabStripSceneLayer.this,
newTabButton.getResourceId(),
newTabButton.getBackgroundResourceId(),
newTabButton.getDrawX() * mDpToPx,
newTabButton.getDrawY() * mDpToPx,
topPaddingPx,
layoutHelper.getNewTabBtnVisualOffset() * mDpToPx,
newTabButtonVisible,
newTabButton.getShouldApplyHoverBackground(),
newTabButton.getTint(),
newTabButton.getBackgroundTint(),
newTabButton.getOpacity(),
resourceManager);
CompositorButton modelSelectorButton = layoutHelper.getModelSelectorButton();
if (modelSelectorButton != null) {
boolean modelSelectorButtonVisible = modelSelectorButton.isVisible();
TabStripSceneLayerJni.get()
.updateModelSelectorButton(
mNativePtr,
TabStripSceneLayer.this,
modelSelectorButton.getResourceId(),
((TintedCompositorButton) modelSelectorButton)
.getBackgroundResourceId(),
modelSelectorButton.getDrawX() * mDpToPx,
modelSelectorButton.getDrawY() * mDpToPx,
modelSelectorButtonVisible,
modelSelectorButton.getShouldApplyHoverBackground(),
((TintedCompositorButton) modelSelectorButton).getTint(),
((TintedCompositorButton) modelSelectorButton).getBackgroundTint(),
modelSelectorButton.getOpacity(),
resourceManager);
}
TabStripSceneLayerJni.get()
.updateTabStripLeftFade(
mNativePtr,
TabStripSceneLayer.this,
layoutHelper.getLeftFadeDrawable(),
layoutHelper.getLeftFadeOpacity(),
resourceManager,
layoutHelper.getBackgroundColor(),
leftPaddingPx);
TabStripSceneLayerJni.get()
.updateTabStripRightFade(
mNativePtr,
TabStripSceneLayer.this,
layoutHelper.getRightFadeDrawable(),
layoutHelper.getRightFadeOpacity(),
resourceManager,
layoutHelper.getBackgroundColor(),
rightPaddingPx);
}
private void pushStripTabs(
StripLayoutHelperManager layoutHelper,
LayerTitleCache layerTitleCache,
ResourceManager resourceManager,
StripLayoutTab[] stripTabs,
int selectedTabId,
int hoveredTabId) {
final int tabsCount = stripTabs != null ? stripTabs.length : 0;
// TODO(crbug.com/40270147): Cleanup params, as some don't change and others are now
// unused.
for (int i = 0; i < tabsCount; i++) {
final StripLayoutTab st = stripTabs[i];
boolean isSelected = st.getTabId() == selectedTabId;
boolean isHovered = st.getTabId() == hoveredTabId;
boolean shouldShowOutline = layoutHelper.shouldShowTabOutline(st);
// TODO(b/326301060): Update tab outline placeholder color with color picker.
TabStripSceneLayerJni.get()
.putStripTabLayer(
mNativePtr,
TabStripSceneLayer.this,
st.getTabId(),
st.getCloseButton().getResourceId(),
st.getCloseButton().getBackgroundResourceId(),
st.getDividerResourceId(),
st.getResourceId(),
st.getOutlineResourceId(),
st.getCloseButton().getTint(),
st.getCloseButton().getBackgroundTint(),
st.getDividerTint(),
st.getTint(isSelected, isHovered),
layoutHelper.getSelectedOutlineGroupTint(
st.getTabId(), shouldShowOutline),
isSelected,
shouldShowOutline,
st.getClosePressed(),
layoutHelper.getWidth() * mDpToPx,
st.getDrawX() * mDpToPx,
st.getDrawY() * mDpToPx,
st.getWidth() * mDpToPx,
st.getHeight() * mDpToPx,
st.getContentOffsetY() * mDpToPx,
st.getDividerOffsetX() * mDpToPx,
st.getBottomMargin() * mDpToPx,
st.getTopMargin() * mDpToPx,
st.getCloseButtonPadding() * mDpToPx,
st.getCloseButton().getOpacity(),
st.isStartDividerVisible(),
st.isEndDividerVisible(),
st.isLoading(),
st.getLoadingSpinnerRotation(),
st.getContainerOpacity(),
layerTitleCache,
resourceManager);
}
}
private void pushGroupIndicators(
StripLayoutGroupTitle[] groupTitles, LayerTitleCache layerTitleCache) {
final int titlesCount = groupTitles != null ? groupTitles.length : 0;
for (int i = 0; i < titlesCount; i++) {
final StripLayoutGroupTitle gt = groupTitles[i];
TabStripSceneLayerJni.get()
.putGroupIndicatorLayer(
mNativePtr,
TabStripSceneLayer.this,
gt.isIncognito(),
gt.getRootId(),
gt.getTint(),
gt.getPaddedX() * mDpToPx,
gt.getPaddedY() * mDpToPx,
gt.getPaddedWidth() * mDpToPx,
gt.getPaddedHeight() * mDpToPx,
gt.getTitleTextPadding() * mDpToPx,
gt.getCornerRadius() * mDpToPx,
gt.getBottomIndicatorWidth() * mDpToPx,
gt.getBottomIndicatorHeight() * mDpToPx,
layerTitleCache);
}
}
@Override
public void destroy() {
super.destroy();
mNativePtr = 0;
}
@NativeMethods
public interface Natives {
long init(TabStripSceneLayer caller);
void beginBuildingFrame(
long nativeTabStripSceneLayer, TabStripSceneLayer caller, boolean visible);
void finishBuildingFrame(long nativeTabStripSceneLayer, TabStripSceneLayer caller);
void updateOffsetTag(
long nativeTabStripSceneLayer, TabStripSceneLayer caller, OffsetTag offsetTag);
void updateTabStripLayer(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int width,
int height,
float yOffset,
@ColorInt int backgroundColor,
@ColorInt int scrimColor,
float scrimOpacity,
float leftPaddingPx,
float rightPaddingPx,
float topPaddingPx);
void updateNewTabButton(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int resourceId,
int backgroundResourceId,
float x,
float y,
float topPadding,
float touchTargetOffset,
boolean visible,
boolean isHovered,
int tint,
int backgroundTint,
float buttonAlpha,
ResourceManager resourceManager);
void updateModelSelectorButton(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int resourceId,
int backgroundResourceId,
float x,
float y,
boolean visible,
boolean isHovered,
int tint,
int backgroundTint,
float buttonAlpha,
ResourceManager resourceManager);
void updateTabStripLeftFade(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int resourceId,
float opacity,
ResourceManager resourceManager,
@ColorInt int leftFadeColor,
float leftPaddingPx);
void updateTabStripRightFade(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int resourceId,
float opacity,
ResourceManager resourceManager,
@ColorInt int rightFadeColor,
float rightPaddingPx);
void putStripTabLayer(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
int id,
int closeResourceId,
int closeBackgroundResourceId,
int dividerResourceId,
int handleResourceId,
int handleOutlineResourceId,
int closeTint,
int closeHoverBackgroundTint,
int dividerTint,
int handleTint,
int handleOutlineTint,
boolean foreground,
boolean shouldShowTabOutline,
boolean closePressed,
float toolbarWidth,
float x,
float y,
float width,
float height,
float contentOffsetY,
float dividerOffsetX,
float bottomMargin,
float topMargin,
float closeButtonPadding,
float closeButtonAlpha,
boolean isStartDividerVisible,
boolean isEndDividerVisible,
boolean isLoading,
float spinnerRotation,
float opacity,
LayerTitleCache layerTitleCache,
ResourceManager resourceManager);
void putGroupIndicatorLayer(
long nativeTabStripSceneLayer,
TabStripSceneLayer caller,
boolean incognito,
int id,
int tint,
float x,
float y,
float width,
float height,
float titleTextPadding,
float cornerRadius,
float bottomIndicatorWidth,
float bottomIndicatorHeight,
LayerTitleCache layerTitleCache);
void setContentTree(
long nativeTabStripSceneLayer, TabStripSceneLayer caller, SceneLayer contentTree);
}
public void initializeNativeForTesting() {
this.initializeNative();
}
}
Codebase Browser
chromium