Add button to switch the Catalog app in and out of edge to edge mode.

wcshi · cketcham · commit 4e78a5904166 · 2019-08-16T15:33:44.000-04:00
PiperOrigin-RevId: 262378430
diff --git a/catalog/baseline.xml b/catalog/baseline.xml
@@ -1427,17 +1427,6 @@
             column="4"/>
     </issue>
 
-    <issue
-        id="ContentDescription"
-        message="Missing `contentDescription` attribute on image"
-        errorLine1="  &lt;ImageButton"
-        errorLine2="   ~~~~~~~~~~~">
-        <location
-            file="java/io/material/catalog/tableofcontents/res/layout/cat_toc_header.xml"
-            line="45"
-            column="4"/>
-    </issue>
-
     <issue
         id="KeyboardInaccessibleWidget"
         message="&apos;clickable&apos; attribute found, please also add &apos;focusable&apos;"
diff --git a/catalog/build.gradle b/catalog/build.gradle
@@ -57,7 +57,8 @@ def srcDirs = [
   'textfield',
   'themeswitcher',
   'topappbar',
-  'transformation'
+  'transformation',
+  'windowpreferences'
 ]
 
 android {
diff --git a/catalog/java/io/material/catalog/application/theme/res/values/ids.xml b/catalog/java/io/material/catalog/application/theme/res/values/ids.xml
@@ -17,5 +17,6 @@
 <resources>
 
   <item name="cat_toc_theme_button" type="id"/>
+  <item name="cat_edge_to_edge_button" type="id"/>
 
 </resources>
diff --git a/catalog/java/io/material/catalog/application/theme/res/values/styles.xml b/catalog/java/io/material/catalog/application/theme/res/values/styles.xml
@@ -26,15 +26,24 @@
     <item name="navigationIcon">@drawable/ic_close_vd_theme_24px</item>
   </style>
 
-  <style name="Widget.Catalog.ChooseThemeButton" parent="Widget.AppCompat.ImageButton">
-    <item name="android:id">@id/cat_toc_theme_button</item>
+  <style name="Widget.Catalog.TocButton" parent="Widget.AppCompat.ImageButton">
     <item name="android:layout_width">@dimen/mtrl_min_touch_target_size</item>
     <item name="android:layout_height">@dimen/mtrl_min_touch_target_size</item>
-    <item name="android:layout_gravity">center_vertical|end</item>
     <item name="android:background">?attr/actionBarItemBackground</item>
+  </style>
+
+  <style name="Widget.Catalog.ChooseThemeButton" parent="Widget.Catalog.TocButton">
+    <item name="android:id">@id/cat_toc_theme_button</item>
+    <item name="android:layout_gravity">center_vertical|end</item>
     <item name="srcCompat">@drawable/abc_ic_menu_overflow_material</item>
   </style>
 
+  <style name="Widget.Catalog.EdgeToEdgeButton" parent="Widget.Catalog.TocButton">
+    <item name="android:id">@id/cat_edge_to_edge_button</item>
+    <item name="android:layout_gravity">center_vertical</item>
+    <item name="srcCompat">@drawable/ic_edge_to_edge_enable_24dp</item>
+  </style>
+
   <style name="ThemeOverlay.Catalog.AppBarLayout" parent="">
     <item name="android:textColorPrimary">?attr/colorOnPrimarySurface</item>
     <item name="colorControlNormal">?attr/colorOnPrimarySurface</item>
diff --git a/catalog/java/io/material/catalog/assets/res/drawable/ic_edge_to_edge_disable_24dp.xml b/catalog/java/io/material/catalog/assets/res/drawable/ic_edge_to_edge_disable_24dp.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+    Copyright (C) 2019 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.
+-->
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="?attr/colorControlNormal"
+    android:viewportHeight="24.0"
+    android:viewportWidth="24.0">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M5,16h3v3h2v-5L5,14v2zM8,8L5,8v2h5L10,5L8,5v3zM14,19h2v-3h3v-2h-5v5zM16,8L16,5h-2v5h5L19,8h-3z"/>
+</vector>
diff --git a/catalog/java/io/material/catalog/assets/res/drawable/ic_edge_to_edge_enable_24dp.xml b/catalog/java/io/material/catalog/assets/res/drawable/ic_edge_to_edge_enable_24dp.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+    Copyright (C) 2019 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.
+-->
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportHeight="24.0"
+    android:viewportWidth="24.0"
+    android:tint="?attr/colorControlNormal">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M7,14L5,14v5h5v-2L7,17v-3zM5,10h2L7,7h3L10,5L5,5v5zM17,17h-3v2h5v-5h-2v3zM14,5v2h3v3h2L19,5h-5z"/>
+</vector>
diff --git a/catalog/java/io/material/catalog/main/MainActivity.java b/catalog/java/io/material/catalog/main/MainActivity.java
@@ -35,6 +35,7 @@
 import io.material.catalog.tableofcontents.TocModule;
 import io.material.catalog.themeswitcher.ThemeOverlayUtils;
 import io.material.catalog.themeswitcher.ThemeSwitcherHelper.ThemeSwitcherActivity;
+import io.material.catalog.windowpreferences.WindowPreferencesManager;
 import javax.inject.Inject;
 
 /**
@@ -49,8 +50,10 @@ public class MainActivity extends DaggerAppCompatActivity implements ThemeSwitch
   @Override
   protected void onCreate(Bundle savedInstanceState) {
     ThemeOverlayUtils.applyThemeOverlays(this);
-
     super.onCreate(savedInstanceState);
+    WindowPreferencesManager windowPreferencesManager = new WindowPreferencesManager(this);
+    windowPreferencesManager.applyEdgeToEdgePreference(getWindow());
+
     setContentView(R.layout.cat_main_activity);
 
     if (savedInstanceState == null) {
diff --git a/catalog/java/io/material/catalog/tableofcontents/TocFragment.java b/catalog/java/io/material/catalog/tableofcontents/TocFragment.java
@@ -40,6 +40,7 @@
 import io.material.catalog.feature.FeatureDemoUtils;
 import io.material.catalog.themeswitcher.ThemePreferencesManager;
 import io.material.catalog.themeswitcher.ThemeSwitcherResourceProvider;
+import io.material.catalog.windowpreferences.WindowPreferencesManager;
 import java.text.Collator;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -58,17 +59,20 @@ public class TocFragment extends DaggerFragment {
   @Inject ThemeSwitcherResourceProvider themeSwitcherResourceProvider;
 
   private ThemePreferencesManager themePreferencesManager;
+  private WindowPreferencesManager windowPreferencesManager;
   private AppBarLayout appBarLayout;
   private View gridTopDivider;
   private RecyclerView recyclerView;
   private ImageButton themeButton;
+  private ImageButton edgeToEdgeButton;
 
   @Override
   public void onCreate(@Nullable Bundle bundle) {
     super.onCreate(bundle);
 
     themePreferencesManager =
         new ThemePreferencesManager(getContext(), themeSwitcherResourceProvider);
+    windowPreferencesManager = new WindowPreferencesManager(getContext());
 
     String defaultDemo = FeatureDemoUtils.getDefaultDemo(getContext());
     if (!defaultDemo.isEmpty() && bundle == null) {
@@ -102,6 +106,7 @@ public View onCreateView(
     gridTopDivider = view.findViewById(R.id.cat_toc_grid_top_divider);
     recyclerView = view.findViewById(R.id.cat_toc_grid);
     themeButton = view.findViewById(R.id.cat_toc_theme_button);
+    edgeToEdgeButton = view.findViewById(R.id.cat_edge_to_edge_button);
 
     if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
       addGridTopDividerVisibilityListener();
@@ -133,6 +138,7 @@ public View onCreateView(
 
     initThemeButton();
 
+    initEdgeToEdgeButton();
     return view;
   }
 
@@ -168,4 +174,26 @@ private void initThemeButton() {
     themePreferencesManager.applyTheme();
     themeButton.setOnClickListener(v -> themePreferencesManager.showChooseThemePopup(themeButton));
   }
+
+  private void initEdgeToEdgeButton() {
+    if (VERSION.SDK_INT < VERSION_CODES.LOLLIPOP) {
+      // Hide button because setting system ui flags is not supported pre-Lollipop.
+      edgeToEdgeButton.setVisibility(View.GONE);
+      return;
+    }
+    edgeToEdgeButton.setImageResource(
+        windowPreferencesManager.isEdgeToEdgeEnabled()
+            ? R.drawable.ic_edge_to_edge_disable_24dp
+            : R.drawable.ic_edge_to_edge_enable_24dp);
+    edgeToEdgeButton.setContentDescription(
+        getString(
+            windowPreferencesManager.isEdgeToEdgeEnabled()
+                ? R.string.cat_edge_to_edge_enable_description
+                : R.string.cat_edge_to_edge_disable_description));
+    edgeToEdgeButton.setOnClickListener(
+        v -> {
+          windowPreferencesManager.toggleEdgeToEdgeEnabled();
+          getActivity().recreate();
+        });
+  }
 }
diff --git a/catalog/java/io/material/catalog/tableofcontents/res/layout/cat_toc_header.xml b/catalog/java/io/material/catalog/tableofcontents/res/layout/cat_toc_header.xml
@@ -29,8 +29,8 @@
     <ImageView
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_marginRight="4dp"
         android:layout_marginEnd="4dp"
+        android:layout_marginRight="4dp"
         android:contentDescription="@null"
         android:importantForAccessibility="no"
         app:srcCompat="@drawable/ic_logo_components_48px"/>
@@ -43,5 +43,11 @@
   </LinearLayout>
 
   <ImageButton
-      style="@style/Widget.Catalog.ChooseThemeButton"/>
+      style="@style/Widget.Catalog.EdgeToEdgeButton"
+      android:contentDescription="@string/cat_choose_theme_description"/>
+
+  <ImageButton
+      style="@style/Widget.Catalog.ChooseThemeButton"
+      android:contentDescription="@string/cat_edge_to_edge_enable_description"/>
+
 </FrameLayout>
diff --git a/catalog/java/io/material/catalog/tableofcontents/res/values/strings.xml b/catalog/java/io/material/catalog/tableofcontents/res/values/strings.xml
@@ -18,4 +18,7 @@
 <resources>
   <string name="cat_toc_title">Material Components</string>
   <string name="cat_toc_status_wip">WIP</string>
+  <string name="cat_edge_to_edge_enable_description">Enable edge to edge</string>
+  <string name="cat_edge_to_edge_disable_description">Disable edge to edge</string>
+  <string name="cat_choose_theme_description">Choose theme</string>
 </resources>
diff --git a/catalog/java/io/material/catalog/windowpreferences/WindowPreferencesManager.java b/catalog/java/io/material/catalog/windowpreferences/WindowPreferencesManager.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2019 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 io.material.catalog.windowpreferences;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.graphics.Color;
+import android.os.Build.VERSION;
+import android.os.Build.VERSION_CODES;
+import androidx.annotation.RequiresApi;
+import android.view.View;
+import android.view.Window;
+import com.google.android.material.color.MaterialColors;
+
+/** Helper that saves the current window preferences for the Catalog. */
+public class WindowPreferencesManager {
+
+  private static final String PREFERENCES_NAME = "window_preferences";
+  private static final String KEY_EDGE_TO_EDGE_ENABLED = "edge_to_edge_enabled";
+
+  @RequiresApi(VERSION_CODES.LOLLIPOP)
+  private static final int EDGE_TO_EDGE_FLAGS =
+      View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_LAYOUT_STABLE;
+
+  private final Context context;
+
+  public WindowPreferencesManager(Context context) {
+    this.context = context;
+  }
+
+  @SuppressWarnings("ApplySharedPref")
+  public void toggleEdgeToEdgeEnabled() {
+    getSharedPreferences()
+        .edit()
+        .putBoolean(KEY_EDGE_TO_EDGE_ENABLED, !isEdgeToEdgeEnabled())
+        .commit();
+  }
+
+  public boolean isEdgeToEdgeEnabled() {
+    return getSharedPreferences().getBoolean(KEY_EDGE_TO_EDGE_ENABLED, false);
+  }
+
+  @SuppressWarnings("RestrictTo")
+  public void applyEdgeToEdgePreference(Window window) {
+    if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
+      if (isEdgeToEdgeEnabled()) {
+        window.setStatusBarColor(Color.TRANSPARENT);
+        window.setNavigationBarColor(Color.TRANSPARENT);
+        window.getDecorView().setSystemUiVisibility(EDGE_TO_EDGE_FLAGS);
+      } else {
+        window.setStatusBarColor(
+            MaterialColors.getColor(context, android.R.attr.statusBarColor, Color.BLACK));
+        window.setNavigationBarColor(
+            MaterialColors.getColor(context, android.R.attr.navigationBarColor, Color.BLACK));
+        window.getDecorView().setSystemUiVisibility(View.SYSTEM_UI_FLAG_VISIBLE);
+      }
+    }
+  }
+
+  private SharedPreferences getSharedPreferences() {
+    return context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_PRIVATE);
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,8 @@ def srcDirs = [`
`57`	`57`	`'textfield',`
`58`	`58`	`'themeswitcher',`
`59`	`59`	`'topappbar',`
`60`		`- 'transformation'`
	`60`	`+ 'transformation',`
	`61`	`+ 'windowpreferences'`
`61`	`62`	`]`
`62`	`63`
`63`	`64`	`android {`