NavigationMenuPresenter.java revision a63940ca14cd3ad9620e94f709930bb968525c57
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 17package android.support.design.internal; 18 19import android.content.Context; 20import android.content.res.ColorStateList; 21import android.content.res.Resources; 22import android.graphics.drawable.ColorDrawable; 23import android.graphics.drawable.Drawable; 24import android.os.Bundle; 25import android.os.Parcelable; 26import android.support.annotation.LayoutRes; 27import android.support.annotation.NonNull; 28import android.support.annotation.Nullable; 29import android.support.design.R; 30import android.support.v7.internal.view.menu.MenuBuilder; 31import android.support.v7.internal.view.menu.MenuItemImpl; 32import android.support.v7.internal.view.menu.MenuPresenter; 33import android.support.v7.internal.view.menu.MenuView; 34import android.support.v7.internal.view.menu.SubMenuBuilder; 35import android.util.SparseArray; 36import android.view.LayoutInflater; 37import android.view.MenuItem; 38import android.view.SubMenu; 39import android.view.View; 40import android.view.ViewGroup; 41import android.widget.AdapterView; 42import android.widget.BaseAdapter; 43import android.widget.LinearLayout; 44import android.widget.TextView; 45 46import java.util.ArrayList; 47 48/** 49 * @hide 50 */ 51public class NavigationMenuPresenter implements MenuPresenter, AdapterView.OnItemClickListener { 52 53 private static final String STATE_HIERARCHY = "android:menu:list"; 54 55 private NavigationMenuView mMenuView; 56 private LinearLayout mHeader; 57 58 private Callback mCallback; 59 private MenuBuilder mMenu; 60 private int mId; 61 62 private NavigationMenuAdapter mAdapter; 63 private LayoutInflater mLayoutInflater; 64 65 private ColorStateList mTextColor; 66 private ColorStateList mIconTintList; 67 private Drawable mItemBackground; 68 69 /** 70 * Padding to be inserted at the top of the list to avoid the first menu item 71 * from being placed underneath the status bar. 72 */ 73 private int mPaddingTopDefault; 74 75 /** 76 * Padding for separators between items 77 */ 78 private int mPaddingSeparator; 79 80 @Override 81 public void initForMenu(Context context, MenuBuilder menu) { 82 mLayoutInflater = LayoutInflater.from(context); 83 mMenu = menu; 84 Resources res = context.getResources(); 85 mPaddingTopDefault = res.getDimensionPixelOffset(R.dimen.navigation_padding_top_default); 86 mPaddingSeparator = res.getDimensionPixelOffset( 87 R.dimen.navigation_separator_vertical_padding); 88 } 89 90 @Override 91 public MenuView getMenuView(ViewGroup root) { 92 if (mMenuView == null) { 93 mMenuView = (NavigationMenuView) mLayoutInflater.inflate( 94 R.layout.design_navigation_menu, root, false); 95 if (mAdapter == null) { 96 mAdapter = new NavigationMenuAdapter(); 97 } 98 mHeader = (LinearLayout) mLayoutInflater.inflate(R.layout.design_navigation_item_header, 99 mMenuView, false); 100 mMenuView.addHeaderView(mHeader); 101 mMenuView.setAdapter(mAdapter); 102 mMenuView.setOnItemClickListener(this); 103 } 104 return mMenuView; 105 } 106 107 @Override 108 public void updateMenuView(boolean cleared) { 109 if (mAdapter != null) { 110 mAdapter.notifyDataSetChanged(); 111 } 112 } 113 114 @Override 115 public void setCallback(Callback cb) { 116 mCallback = cb; 117 } 118 119 @Override 120 public boolean onSubMenuSelected(SubMenuBuilder subMenu) { 121 return false; 122 } 123 124 @Override 125 public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) { 126 if (mCallback != null) { 127 mCallback.onCloseMenu(menu, allMenusAreClosing); 128 } 129 } 130 131 @Override 132 public boolean flagActionItems() { 133 return false; 134 } 135 136 @Override 137 public boolean expandItemActionView(MenuBuilder menu, MenuItemImpl item) { 138 return false; 139 } 140 141 @Override 142 public boolean collapseItemActionView(MenuBuilder menu, MenuItemImpl item) { 143 return false; 144 } 145 146 @Override 147 public int getId() { 148 return mId; 149 } 150 151 public void setId(int id) { 152 mId = id; 153 } 154 155 @Override 156 public Parcelable onSaveInstanceState() { 157 Bundle state = new Bundle(); 158 SparseArray<Parcelable> hierarchy = new SparseArray<>(); 159 if (mMenuView != null) { 160 mMenuView.saveHierarchyState(hierarchy); 161 } 162 state.putSparseParcelableArray(STATE_HIERARCHY, hierarchy); 163 return state; 164 } 165 166 @Override 167 public void onRestoreInstanceState(Parcelable parcelable) { 168 Bundle state = (Bundle) parcelable; 169 SparseArray<Parcelable> hierarchy = state.getSparseParcelableArray(STATE_HIERARCHY); 170 if (hierarchy != null) { 171 mMenuView.restoreHierarchyState(hierarchy); 172 } 173 } 174 175 @Override 176 public void onItemClick(AdapterView<?> parent, View view, int position, long id) { 177 int positionInAdapter = position - mMenuView.getHeaderViewsCount(); 178 if (positionInAdapter >= 0) { 179 mMenu.performItemAction(mAdapter.getItem(positionInAdapter).getMenuItem(), this, 0); 180 } 181 } 182 183 public View inflateHeaderView(@LayoutRes int res) { 184 View view = mLayoutInflater.inflate(res, mHeader, false); 185 addHeaderView(view); 186 return view; 187 } 188 189 public void addHeaderView(@NonNull View view) { 190 mHeader.addView(view); 191 // The padding on top should be cleared. 192 mMenuView.setPadding(0, 0, 0, mMenuView.getPaddingBottom()); 193 } 194 195 public void removeHeaderView(@NonNull View view) { 196 mHeader.removeView(view); 197 if (mHeader.getChildCount() == 0) { 198 mMenuView.setPadding(0, mPaddingTopDefault, 0, mMenuView.getPaddingBottom()); 199 } 200 } 201 202 @Nullable 203 public ColorStateList getItemTintList() { 204 return mIconTintList; 205 } 206 207 public void setItemIconTintList(@Nullable ColorStateList tint) { 208 mIconTintList = tint; 209 } 210 211 @Nullable 212 public ColorStateList getItemTextColor() { 213 return mTextColor; 214 } 215 216 public void setItemTextColor(@Nullable ColorStateList textColor) { 217 mTextColor = textColor; 218 } 219 220 public Drawable getItemBackground() { 221 return mItemBackground; 222 } 223 224 public void setItemBackground(Drawable itemBackground) { 225 mItemBackground = itemBackground; 226 } 227 228 private class NavigationMenuAdapter extends BaseAdapter { 229 private static final int VIEW_TYPE_NORMAL = 0; 230 private static final int VIEW_TYPE_SUBHEADER = 1; 231 private static final int VIEW_TYPE_SEPARATOR = 2; 232 233 private final ArrayList<NavigationMenuItem> mItems = new ArrayList<>(); 234 private ColorDrawable mTransparentIcon; 235 236 NavigationMenuAdapter() { 237 prepareMenuItems(); 238 } 239 240 @Override 241 public int getCount() { 242 return mItems.size(); 243 } 244 245 @Override 246 public NavigationMenuItem getItem(int position) { 247 return mItems.get(position); 248 } 249 250 @Override 251 public long getItemId(int position) { 252 return position; 253 } 254 255 @Override 256 public int getViewTypeCount() { 257 return 3; 258 } 259 260 @Override 261 public int getItemViewType(int position) { 262 NavigationMenuItem item = getItem(position); 263 if (item.isSeparator()) { 264 return VIEW_TYPE_SEPARATOR; 265 } else if (item.getMenuItem().hasSubMenu()) { 266 return VIEW_TYPE_SUBHEADER; 267 } else { 268 return VIEW_TYPE_NORMAL; 269 } 270 } 271 272 @Override 273 public View getView(int position, View convertView, ViewGroup parent) { 274 NavigationMenuItem item = getItem(position); 275 int viewType = getItemViewType(position); 276 switch (viewType) { 277 case VIEW_TYPE_NORMAL: 278 if (convertView == null) { 279 convertView = mLayoutInflater.inflate(R.layout.design_navigation_item, 280 parent, false); 281 } 282 NavigationMenuItemView itemView = (NavigationMenuItemView) convertView; 283 itemView.setIconTintList(mIconTintList); 284 itemView.setTextColor(mTextColor); 285 itemView.setBackground(mItemBackground); 286 itemView.initialize(item.getMenuItem(), 0); 287 break; 288 case VIEW_TYPE_SUBHEADER: 289 if (convertView == null) { 290 convertView = mLayoutInflater.inflate( 291 R.layout.design_navigation_item_subheader, parent, false); 292 } 293 TextView subHeader = (TextView) convertView; 294 subHeader.setText(item.getMenuItem().getTitle()); 295 break; 296 case VIEW_TYPE_SEPARATOR: 297 if (convertView == null) { 298 convertView = mLayoutInflater.inflate( 299 R.layout.design_navigation_item_separator, parent, false); 300 } 301 convertView.setPadding(0, item.getPaddingTop(), 0, 302 item.getPaddingBottom()); 303 break; 304 } 305 return convertView; 306 } 307 308 @Override 309 public boolean areAllItemsEnabled() { 310 return false; 311 } 312 313 @Override 314 public boolean isEnabled(int position) { 315 return getItem(position).isEnabled(); 316 } 317 318 @Override 319 public void notifyDataSetChanged() { 320 prepareMenuItems(); 321 super.notifyDataSetChanged(); 322 } 323 324 /** 325 * Flattens the visible menu items of {@link #mMenu} into {@link #mItems}, 326 * while inserting separators between items when necessary. 327 */ 328 private void prepareMenuItems() { 329 mItems.clear(); 330 int currentGroupId = -1; 331 int currentGroupStart = 0; 332 boolean currentGroupHasIcon = false; 333 for (int i = 0, totalSize = mMenu.getVisibleItems().size(); i < totalSize; i++) { 334 MenuItemImpl item = mMenu.getVisibleItems().get(i); 335 if (item.hasSubMenu()) { 336 SubMenu subMenu = item.getSubMenu(); 337 if (subMenu.hasVisibleItems()) { 338 if (i != 0) { 339 mItems.add(NavigationMenuItem.separator(mPaddingSeparator, 0)); 340 } 341 mItems.add(NavigationMenuItem.of(item)); 342 boolean subMenuHasIcon = false; 343 int subMenuStart = mItems.size(); 344 for (int j = 0, size = subMenu.size(); j < size; j++) { 345 MenuItem subMenuItem = subMenu.getItem(j); 346 if (subMenuItem.isVisible()) { 347 if (!subMenuHasIcon && subMenuItem.getIcon() != null) { 348 subMenuHasIcon = true; 349 } 350 mItems.add(NavigationMenuItem.of((MenuItemImpl) subMenuItem)); 351 } 352 } 353 if (subMenuHasIcon) { 354 appendTransparentIconIfMissing(subMenuStart, mItems.size()); 355 } 356 } 357 } else { 358 int groupId = item.getGroupId(); 359 if (groupId != currentGroupId) { // first item in group 360 currentGroupStart = mItems.size(); 361 currentGroupHasIcon = item.getIcon() != null; 362 if (i != 0) { 363 currentGroupStart++; 364 mItems.add(NavigationMenuItem.separator( 365 mPaddingSeparator, mPaddingSeparator)); 366 } 367 } else if (!currentGroupHasIcon && item.getIcon() != null) { 368 currentGroupHasIcon = true; 369 appendTransparentIconIfMissing(currentGroupStart, mItems.size()); 370 } 371 if (currentGroupHasIcon && item.getIcon() == null) { 372 item.setIcon(android.R.color.transparent); 373 } 374 mItems.add(NavigationMenuItem.of(item)); 375 currentGroupId = groupId; 376 } 377 } 378 } 379 380 private void appendTransparentIconIfMissing(int startIndex, int endIndex) { 381 for (int i = startIndex; i < endIndex; i++) { 382 MenuItem item = mItems.get(i).getMenuItem(); 383 if (item.getIcon() == null) { 384 if (mTransparentIcon == null) { 385 mTransparentIcon = new ColorDrawable(android.R.color.transparent); 386 } 387 item.setIcon(mTransparentIcon); 388 } 389 } 390 } 391 } 392 393 /** 394 * Wraps {@link MenuItemImpl}. This allows separators to be counted as items in list. 395 */ 396 private static class NavigationMenuItem { 397 398 /** The item; null for separators */ 399 private final MenuItemImpl mMenuItem; 400 401 /** Padding top; used only for separators */ 402 private final int mPaddingTop; 403 404 /** Padding bottom; used only for separators */ 405 private final int mPaddingBottom; 406 407 private NavigationMenuItem(MenuItemImpl item, int paddingTop, int paddingBottom) { 408 mMenuItem = item; 409 mPaddingTop = paddingTop; 410 mPaddingBottom = paddingBottom; 411 } 412 413 public static NavigationMenuItem of(MenuItemImpl item) { 414 return new NavigationMenuItem(item, 0, 0); 415 } 416 417 public static NavigationMenuItem separator(int paddingTop, int paddingBottom) { 418 return new NavigationMenuItem(null, paddingTop, paddingBottom); 419 } 420 421 public boolean isSeparator() { 422 return mMenuItem == null; 423 } 424 425 public int getPaddingTop() { 426 return mPaddingTop; 427 } 428 429 public int getPaddingBottom() { 430 return mPaddingBottom; 431 } 432 433 public MenuItemImpl getMenuItem() { 434 return mMenuItem; 435 } 436 437 public boolean isEnabled() { 438 // Separators and subheaders never respond to click 439 return mMenuItem != null && !mMenuItem.hasSubMenu() && mMenuItem.isEnabled(); 440 } 441 442 } 443 444} 445