Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 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 | |
| 17 | package com.android.documentsui; |
| 18 | |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 19 | import static com.android.documentsui.base.Shared.DEBUG; |
Aga Wronska | c32a299 | 2016-03-08 11:20:39 -0800 | [diff] [blame] | 20 | |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 21 | import android.annotation.IntDef; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 22 | import android.app.Activity; |
| 23 | import android.support.v4.app.ActionBarDrawerToggle; |
| 24 | import android.support.v4.widget.DrawerLayout; |
| 25 | import android.support.v4.widget.DrawerLayout.DrawerListener; |
Aga Wronska | c32a299 | 2016-03-08 11:20:39 -0800 | [diff] [blame] | 26 | import android.util.Log; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 27 | import android.view.View; |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 28 | import android.widget.Toolbar; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 29 | |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 30 | import com.android.documentsui.base.Display; |
| 31 | |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 32 | import java.lang.annotation.Retention; |
| 33 | import java.lang.annotation.RetentionPolicy; |
| 34 | |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 35 | /** |
| 36 | * A facade over the various pieces comprising "roots fragment in a Drawer". |
| 37 | * |
| 38 | * @see DrawerController#create(DrawerLayout) |
| 39 | */ |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 40 | public abstract class DrawerController implements DrawerListener { |
Aga Wronska | c32a299 | 2016-03-08 11:20:39 -0800 | [diff] [blame] | 41 | public static final String TAG = "DrawerController"; |
| 42 | |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 43 | // Drawer opening triggered by tapping the navigation icon |
| 44 | public static final int OPENED_HAMBURGER = 0; |
| 45 | // Drawer opening triggered by swiping right from the edge of the screen |
| 46 | public static final int OPENED_SWIPE = 1; |
| 47 | // Mostly programmatically forced drawer opening |
| 48 | public static final int OPENED_OTHER = 2; |
| 49 | |
| 50 | @IntDef(flag = true, value = { |
| 51 | OPENED_HAMBURGER, |
| 52 | OPENED_SWIPE, |
| 53 | OPENED_OTHER |
| 54 | }) |
| 55 | @Retention(RetentionPolicy.SOURCE) |
| 56 | public @interface Trigger {} |
| 57 | |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 58 | public abstract void update(); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 59 | /** |
| 60 | * Toggles the drawer and sets the OPENED_OTHER as the action that causes opening the drawer. |
| 61 | * @param open |
| 62 | */ |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 63 | public abstract void setOpen(boolean open); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 64 | |
| 65 | /** |
| 66 | * Toggles the drawer. |
| 67 | * @param open |
| 68 | * @param trigger Indicates what action caused opening the drawer. It is ignored for closing. |
| 69 | */ |
| 70 | abstract void setOpen(boolean open, @Trigger int trigger); |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 71 | public abstract boolean isPresent(); |
| 72 | public abstract boolean isOpen(); |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 73 | abstract void setTitle(String title); |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 74 | |
| 75 | /** |
| 76 | * Returns a controller suitable for {@code Layout}. |
| 77 | */ |
Garfield Tan | 208945c | 2016-10-04 14:36:38 -0700 | [diff] [blame] | 78 | public static DrawerController create(Activity activity, ActivityConfig activityConfig) { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 79 | |
| 80 | DrawerLayout layout = (DrawerLayout) activity.findViewById(R.id.drawer_layout); |
| 81 | |
| 82 | if (layout == null) { |
| 83 | return new DummyDrawerController(); |
| 84 | } |
| 85 | |
| 86 | View drawer = activity.findViewById(R.id.drawer_roots); |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 87 | Toolbar toolbar = (Toolbar) activity.findViewById(R.id.roots_toolbar); |
Aga Wronska | e20925f | 2016-04-06 13:57:28 -0700 | [diff] [blame] | 88 | |
Aga Wronska | c32a299 | 2016-03-08 11:20:39 -0800 | [diff] [blame] | 89 | drawer.getLayoutParams().width = calculateDrawerWidth(activity); |
| 90 | |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 91 | ActionBarDrawerToggle toggle = new ActionBarDrawerToggle( |
| 92 | activity, |
| 93 | layout, |
| 94 | R.drawable.ic_hamburger, |
| 95 | R.string.drawer_open, |
| 96 | R.string.drawer_close); |
| 97 | |
Garfield Tan | 208945c | 2016-10-04 14:36:38 -0700 | [diff] [blame] | 98 | return new RuntimeDrawerController(layout, drawer, toggle, toolbar, activityConfig); |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Returns a controller suitable for {@code Layout}. |
| 103 | */ |
| 104 | static DrawerController createDummy() { |
| 105 | return new DummyDrawerController(); |
| 106 | } |
| 107 | |
Aga Wronska | c32a299 | 2016-03-08 11:20:39 -0800 | [diff] [blame] | 108 | private static int calculateDrawerWidth(Activity activity) { |
| 109 | // Material design specification for navigation drawer: |
| 110 | // https://www.google.com/design/spec/patterns/navigation-drawer.html |
| 111 | float width = Display.screenWidth(activity) - Display.actionBarHeight(activity); |
| 112 | float maxWidth = activity.getResources().getDimension(R.dimen.max_drawer_width); |
| 113 | int finalWidth = (int) ((width > maxWidth ? maxWidth : width)); |
| 114 | |
| 115 | if (DEBUG) |
| 116 | Log.d(TAG, "Calculated drawer width:" + (finalWidth / Display.density(activity))); |
| 117 | |
| 118 | return finalWidth; |
| 119 | } |
| 120 | |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 121 | /** |
| 122 | * Runtime controller that manages a real drawer. |
| 123 | */ |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 124 | private static final class RuntimeDrawerController extends DrawerController |
| 125 | implements ItemDragListener.DragHost { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 126 | private final ActionBarDrawerToggle mToggle; |
| 127 | private DrawerLayout mLayout; |
| 128 | private View mDrawer; |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 129 | private Toolbar mToolbar; |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 130 | private @Trigger int mTrigger = OPENED_OTHER; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 131 | |
| 132 | public RuntimeDrawerController( |
Garfield Tan | 208945c | 2016-10-04 14:36:38 -0700 | [diff] [blame] | 133 | DrawerLayout layout, |
| 134 | View drawer, |
| 135 | ActionBarDrawerToggle toggle, |
| 136 | Toolbar drawerToolbar, |
| 137 | ActivityConfig activityConfig) { |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 138 | mToolbar = drawerToolbar; |
Steve McKay | 0af8afd | 2016-02-25 13:34:03 -0800 | [diff] [blame] | 139 | assert(layout != null); |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 140 | |
| 141 | mLayout = layout; |
| 142 | mDrawer = drawer; |
| 143 | mToggle = toggle; |
| 144 | |
| 145 | mLayout.setDrawerListener(this); |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 146 | |
Garfield Tan | 208945c | 2016-10-04 14:36:38 -0700 | [diff] [blame] | 147 | if (activityConfig.dragAndDropEnabled()) { |
| 148 | View edge = layout.findViewById(R.id.drawer_edge); |
| 149 | edge.setOnDragListener(new ItemDragListener<>(this)); |
| 150 | } |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public void runOnUiThread(Runnable runnable) { |
| 155 | mDrawer.post(runnable); |
| 156 | } |
| 157 | |
| 158 | @Override |
Ben Lin | 166c5c6 | 2016-11-01 12:14:38 -0700 | [diff] [blame] | 159 | public void setDropTargetHighlight(View v, Object localState, boolean highlight) { |
Ben Lin | 7f72a3c | 2016-09-27 16:37:28 -0700 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | @Override |
Ben Lin | 1c45629 | 2016-10-07 16:43:18 -0700 | [diff] [blame] | 163 | public void onDragEntered(View v, Object localState) { |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 164 | assert (v.getId() == R.id.drawer_edge); |
| 165 | |
Ben Lin | 7f72a3c | 2016-09-27 16:37:28 -0700 | [diff] [blame] | 166 | setOpen(true); |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | @Override |
Ben Lin | d020212 | 2016-11-10 18:00:12 -0800 | [diff] [blame] | 170 | public void onDragExited(View v, Object localState) { |
| 171 | // do nothing |
| 172 | } |
| 173 | |
| 174 | @Override |
Garfield, Tan | 7d66a86 | 2016-05-11 10:28:41 -0700 | [diff] [blame] | 175 | public void onViewHovered(View v) { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 179 | public void setOpen(boolean open) { |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 180 | setOpen(open, OPENED_OTHER); |
| 181 | } |
| 182 | |
| 183 | @Override |
| 184 | void setOpen(boolean open, @Trigger int trigger) { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 185 | if (open) { |
| 186 | mLayout.openDrawer(mDrawer); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 187 | mTrigger = trigger; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 188 | } else { |
| 189 | mLayout.closeDrawer(mDrawer); |
| 190 | } |
| 191 | } |
| 192 | |
| 193 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 194 | public boolean isOpen() { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 195 | return mLayout.isDrawerOpen(mDrawer); |
| 196 | } |
| 197 | |
| 198 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 199 | public boolean isPresent() { |
Steve McKay | 0fbfc65 | 2015-08-20 16:48:49 -0700 | [diff] [blame] | 200 | return true; |
| 201 | } |
| 202 | |
| 203 | @Override |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 204 | void setTitle(String title) { |
| 205 | mToolbar.setTitle(title); |
| 206 | } |
| 207 | |
| 208 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 209 | public void update() { |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 210 | mToggle.syncState(); |
| 211 | } |
| 212 | |
| 213 | @Override |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 214 | public void onDrawerSlide(View drawerView, float slideOffset) { |
| 215 | mToggle.onDrawerSlide(drawerView, slideOffset); |
| 216 | } |
| 217 | |
| 218 | @Override |
| 219 | public void onDrawerOpened(View drawerView) { |
| 220 | mToggle.onDrawerOpened(drawerView); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 221 | Metrics.logDrawerOpened(mToolbar.getContext(), mTrigger); |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 222 | } |
| 223 | |
| 224 | @Override |
| 225 | public void onDrawerClosed(View drawerView) { |
| 226 | mToggle.onDrawerClosed(drawerView); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 227 | mTrigger = OPENED_OTHER; |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | @Override |
| 231 | public void onDrawerStateChanged(int newState) { |
| 232 | mToggle.onDrawerStateChanged(newState); |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 233 | if (newState == DrawerLayout.STATE_DRAGGING) { |
| 234 | mTrigger = OPENED_SWIPE; |
| 235 | } |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 236 | } |
| 237 | } |
| 238 | |
| 239 | /* |
| 240 | * Dummy controller useful with clients that don't host a real drawer. |
| 241 | */ |
| 242 | private static final class DummyDrawerController extends DrawerController { |
| 243 | |
| 244 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 245 | public void setOpen(boolean open) {} |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 246 | |
Aga Wronska | 441b9be | 2016-03-29 16:57:10 -0700 | [diff] [blame] | 247 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 248 | public void setOpen(boolean open, @Trigger int trigger) {} |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 249 | |
| 250 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 251 | public boolean isOpen() { |
Steve McKay | 0fbfc65 | 2015-08-20 16:48:49 -0700 | [diff] [blame] | 252 | return false; |
| 253 | } |
| 254 | |
| 255 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 256 | public boolean isPresent() { |
Steve McKay | 0fbfc65 | 2015-08-20 16:48:49 -0700 | [diff] [blame] | 257 | return false; |
| 258 | } |
| 259 | |
| 260 | @Override |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 261 | void setTitle(String title) {} |
| 262 | |
| 263 | @Override |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 264 | public void update() {} |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 265 | |
| 266 | @Override |
| 267 | public void onDrawerSlide(View drawerView, float slideOffset) {} |
| 268 | |
| 269 | @Override |
| 270 | public void onDrawerOpened(View drawerView) {} |
| 271 | |
| 272 | @Override |
| 273 | public void onDrawerClosed(View drawerView) {} |
| 274 | |
| 275 | @Override |
| 276 | public void onDrawerStateChanged(int newState) {} |
Steve McKay | 6bbed4d | 2015-08-17 13:18:05 -0700 | [diff] [blame] | 277 | } |
| 278 | } |