// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#import "ios/chrome/browser/shared/ui/table_view/legacy_chrome_table_view_controller.h"
#import "base/apple/foundation_util.h"
#import "base/check.h"
#import "ios/chrome/browser/shared/ui/table_view/cells/table_view_cell.h"
#import "ios/chrome/browser/shared/ui/table_view/cells/table_view_header_footer_item.h"
#import "ios/chrome/browser/shared/ui/table_view/cells/table_view_item.h"
#import "ios/chrome/browser/shared/ui/table_view/chrome_empty_table_view_background.h"
#import "ios/chrome/browser/shared/ui/table_view/legacy_chrome_table_view_styler.h"
#import "ios/chrome/browser/shared/ui/table_view/table_view_empty_view.h"
#import "ios/chrome/browser/shared/ui/table_view/table_view_illustrated_empty_view.h"
#import "ios/chrome/browser/shared/ui/table_view/table_view_loading_view.h"
#import "ios/chrome/browser/shared/ui/table_view/table_view_model.h"
#import "ios/chrome/browser/shared/ui/util/uikit_ui_util.h"
#import "ios/chrome/common/ui/colors/semantic_color_names.h"
const CGFloat kTableViewSeparatorInset = 16;
const CGFloat kTableViewSeparatorInsetWithIcon = 60;
@interface LegacyChromeTableViewController ()
// The loading displayed by [self startLoadingIndicatorWithLoadingMessage:].
@property(nonatomic, strong) TableViewLoadingView* loadingView;
// The view displayed by [self addEmptyTableViewWith...:].
@property(nonatomic, strong) UIView<ChromeEmptyTableViewBackground>* emptyView;
@end
@implementation LegacyChromeTableViewController
@synthesize emptyView = _emptyView;
@synthesize loadingView = _loadingView;
@synthesize styler = _styler;
@synthesize tableViewModel = _tableViewModel;
- (instancetype)initWithStyle:(UITableViewStyle)style {
if ((self = [super initWithStyle:style])) {
_styler = [[ChromeTableViewStyler alloc] init];
}
return self;
}
- (instancetype)init {
return [self initWithStyle:UITableViewStylePlain];
}
#pragma mark - UIViewController
- (void)viewDidLoad {
[super viewDidLoad];
[self.tableView setBackgroundColor:self.styler.tableViewBackgroundColor];
[self.tableView
setSeparatorInset:UIEdgeInsetsMake(0, kTableViewSeparatorInsetWithIcon, 0,
0)];
}
- (void)viewWillTransitionToSize:(CGSize)size
withTransitionCoordinator:
(id<UIViewControllerTransitionCoordinator>)coordinator {
// Make sure the large title appears after rotating back to portrait
// mode.
[coordinator
animateAlongsideTransition:^(
id<UIViewControllerTransitionCoordinatorContext> context) {
[self.navigationController.navigationBar sizeToFit];
}
completion:nil];
}
#pragma mark - UITableViewDelegate
- (NSIndexPath*)tableView:(UITableView*)tableView
willSelectRowAtIndexPath:(NSIndexPath*)indexPath {
if (self.editing && ![self tableView:tableView
canEditRowAtIndexPath:indexPath]) {
return nil;
}
return indexPath;
}
#pragma mark - Accessors
- (void)setStyler:(ChromeTableViewStyler*)styler {
DCHECK(![self isViewLoaded]);
_styler = styler;
}
- (void)setEmptyView:(TableViewEmptyView*)emptyView {
if (_emptyView == emptyView) {
return;
}
_emptyView = emptyView;
[self updateEmptyViewInsets];
self.tableView.backgroundView = _emptyView;
// Since this would replace any loadingView, set it to nil.
self.loadingView = nil;
}
- (void)setEmptyViewTopOffset:(CGFloat)offset {
_emptyViewTopOffset = offset;
[self updateEmptyViewInsets];
}
#pragma mark - Public
- (void)loadModel {
_tableViewModel = [[TableViewModel alloc] init];
}
- (void)viewSafeAreaInsetsDidChange {
[super viewSafeAreaInsetsDidChange];
// The safe area insets aren't propagated to the inner scroll view. Manually
// set the content insets.
[self updateEmptyViewInsets];
}
- (void)startLoadingIndicatorWithLoadingMessage:(NSString*)loadingMessage {
if (!self.loadingView) {
self.loadingView =
[[TableViewLoadingView alloc] initWithFrame:self.view.bounds
loadingMessage:loadingMessage];
self.tableView.backgroundView = self.loadingView;
[self.loadingView startLoadingIndicator];
// Since this would replace any emptyView, set it to nil.
self.emptyView = nil;
}
}
- (void)stopLoadingIndicatorWithCompletion:(ProceduralBlock)completion {
if (self.loadingView) {
[self.loadingView stopLoadingIndicatorWithCompletion:^{
if (completion) {
completion();
}
[self.loadingView removeFromSuperview];
// Check that the tableView.backgroundView hasn't been modified
// before its removed.
DCHECK(self.tableView.backgroundView == self.loadingView);
self.tableView.backgroundView = nil;
self.loadingView = nil;
}];
}
}
- (void)addEmptyTableViewWithMessage:(NSString*)message image:(UIImage*)image {
self.emptyView = [[TableViewEmptyView alloc] initWithFrame:self.view.bounds
message:message
image:image];
self.emptyView.tintColor = [UIColor colorNamed:kPlaceholderImageTintColor];
}
- (void)addEmptyTableViewWithAttributedMessage:
(NSAttributedString*)attributedMessage
image:(UIImage*)image {
self.emptyView = [[TableViewEmptyView alloc] initWithFrame:self.view.bounds
attributedMessage:attributedMessage
image:image];
self.emptyView.tintColor = [UIColor colorNamed:kPlaceholderImageTintColor];
}
- (void)addEmptyTableViewWithImage:(UIImage*)image
title:(NSString*)title
subtitle:(NSString*)subtitle {
self.emptyView =
[[TableViewIllustratedEmptyView alloc] initWithFrame:self.view.bounds
image:image
title:title
subtitle:subtitle];
}
- (void)addEmptyTableViewWithImage:(UIImage*)image
title:(NSString*)title
attributedSubtitle:(NSAttributedString*)subtitle
delegate:(id<TableViewIllustratedEmptyViewDelegate>)
delegate {
TableViewIllustratedEmptyView* illustratedEmptyView =
[[TableViewIllustratedEmptyView alloc] initWithFrame:self.view.bounds
image:image
title:title
attributedSubtitle:subtitle];
illustratedEmptyView.delegate = delegate;
self.emptyView = illustratedEmptyView;
}
- (void)updateEmptyTableViewAccessibilityLabel:(NSString*)newLabel {
self.emptyView.viewAccessibilityLabel = newLabel;
}
- (void)removeEmptyTableView {
if (self.emptyView) {
// Check that the tableView.backgroundView hasn't been modified
// before its removed.
DCHECK(self.tableView.backgroundView == self.emptyView);
self.tableView.backgroundView = nil;
self.emptyView = nil;
}
}
- (void)performBatchTableViewUpdates:(void (^)(void))updates
completion:(void (^)(BOOL finished))completion {
[self.tableView performBatchUpdates:updates completion:completion];
}
- (void)removeFromModelItemAtIndexPaths:(NSArray<NSIndexPath*>*)indexPaths {
// Sort and enumerate in reverse order to delete the items from the collection
// view model.
NSArray* sortedIndexPaths =
[indexPaths sortedArrayUsingSelector:@selector(compare:)];
for (NSIndexPath* indexPath in [sortedIndexPaths reverseObjectEnumerator]) {
NSInteger sectionIdentifier = [self.tableViewModel
sectionIdentifierForSectionIndex:indexPath.section];
NSInteger itemType = [self.tableViewModel itemTypeForIndexPath:indexPath];
NSUInteger index =
[self.tableViewModel indexInItemTypeForIndexPath:indexPath];
[self.tableViewModel removeItemWithType:itemType
fromSectionWithIdentifier:sectionIdentifier
atIndex:index];
}
}
#pragma mark - LegacyChromeTableViewConsumer
- (void)reconfigureCellsForItems:(NSArray*)items {
for (TableViewItem* item in items) {
if ([self.tableViewModel hasItem:item]) {
NSIndexPath* indexPath = [self.tableViewModel indexPathForItem:item];
UITableViewCell* cell = [self.tableView cellForRowAtIndexPath:indexPath];
// `cell` may be nil if the row is not currently on screen.
if (cell) {
TableViewCell* tableViewCell =
base::apple::ObjCCastStrict<TableViewCell>(cell);
[item configureCell:tableViewCell withStyler:self.styler];
}
}
}
}
- (void)reloadCellsForItems:(NSArray*)items
withRowAnimation:(UITableViewRowAnimation)rowAnimation {
if (![items count]) {
return;
}
NSMutableArray* indexPathsToReload = [[NSMutableArray alloc] init];
for (TableViewItem* item in items) {
NSIndexPath* indexPath = [self.tableViewModel indexPathForItem:item];
[indexPathsToReload addObject:indexPath];
}
if ([indexPathsToReload count]) {
[self.tableView reloadRowsAtIndexPaths:indexPathsToReload
withRowAnimation:rowAnimation];
}
}
#pragma mark - UITableViewDataSource
- (UITableViewCell*)tableView:(UITableView*)tableView
cellForRowAtIndexPath:(NSIndexPath*)indexPath {
TableViewItem* item = [self.tableViewModel itemAtIndexPath:indexPath];
Class cellClass = [item cellClass];
NSString* reuseIdentifier = NSStringFromClass(cellClass);
[self.tableView registerClass:cellClass
forCellReuseIdentifier:reuseIdentifier];
UITableViewCell* cell =
[self.tableView dequeueReusableCellWithIdentifier:reuseIdentifier
forIndexPath:indexPath];
TableViewCell* tableViewCell =
base::apple::ObjCCastStrict<TableViewCell>(cell);
[item configureCell:tableViewCell withStyler:self.styler];
// Enabling `exclusiveTouch` for all cells to prevent simultanoeus cell
// selection. Not blocking simultaneous cell selection can lead to starting
// one or more of a coordinator's child coordinators multiple times, which
// can result in multiple view controllers being presented back-to-back. If
// there's a need for `exclusiveTouch` to be disabled for some cells,
// `exclusiveTouch` can be overridden for those cells in the
// LegacyChromeTableViewController subclass that implments them.
// TODO(crbug.com/40926228): Make Chrome Coordinators robust against the
// launch of multiple child coordinators.
cell.exclusiveTouch = YES;
return cell;
}
- (NSInteger)tableView:(UITableView*)tableView
numberOfRowsInSection:(NSInteger)section {
return [self.tableViewModel numberOfItemsInSection:section];
}
- (NSInteger)numberOfSectionsInTableView:(UITableView*)tableView {
return [self.tableViewModel numberOfSections];
}
#pragma mark - UITableViewDelegate
- (UIView*)tableView:(UITableView*)tableView
viewForHeaderInSection:(NSInteger)section {
TableViewHeaderFooterItem* item =
[self.tableViewModel headerForSectionIndex:section];
if (!item) {
return [[UIView alloc] initWithFrame:CGRectZero];
}
Class headerFooterClass = [item cellClass];
NSString* reuseIdentifier = NSStringFromClass(headerFooterClass);
[self.tableView registerClass:headerFooterClass
forHeaderFooterViewReuseIdentifier:reuseIdentifier];
UITableViewHeaderFooterView* view = [self.tableView
dequeueReusableHeaderFooterViewWithIdentifier:reuseIdentifier];
[item configureHeaderFooterView:view withStyler:self.styler];
return view;
}
- (UIView*)tableView:(UITableView*)tableView
viewForFooterInSection:(NSInteger)section {
TableViewHeaderFooterItem* item =
[self.tableViewModel footerForSectionIndex:section];
if (!item) {
return [[UIView alloc] initWithFrame:CGRectZero];
}
Class headerFooterClass = [item cellClass];
NSString* reuseIdentifier = NSStringFromClass(headerFooterClass);
[self.tableView registerClass:headerFooterClass
forHeaderFooterViewReuseIdentifier:reuseIdentifier];
UITableViewHeaderFooterView* view = [self.tableView
dequeueReusableHeaderFooterViewWithIdentifier:reuseIdentifier];
[item configureHeaderFooterView:view withStyler:self.styler];
return view;
}
#pragma mark - Private
// Sets the empty view's insets to the sum of the top offset and the safe area
// insets.
- (void)updateEmptyViewInsets {
UIEdgeInsets safeAreaInsets = self.view.safeAreaInsets;
_emptyView.scrollViewContentInsets = UIEdgeInsetsMake(
safeAreaInsets.top + self.emptyViewTopOffset, safeAreaInsets.left,
safeAreaInsets.bottom, safeAreaInsets.right);
}
@end
Codebase Browser
chromium