DRCollectionViewTableLayoutManager.h

//
//  DRCollectionViewTableLayoutManager.h
//  DRCollectionViewTableLayout
//
//  Created by Dariusz Rybicki on 09.05.2014.
//  Copyright (c) 2014 Darrarski. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "DRCollectionViewTableLayout.h"

@class DRCollectionViewTableLayoutManager;

/**
 *  Collection View Table Layout Manager Delegate
 */
@protocol DRCollectionViewTableLayoutManagerDelegate <NSObject>

/**
 *  Return number of sections in given collection view
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *
 *  @return Number of sections
 */
- (NSUInteger)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
              numberOfSectionsInCollectionView:(UICollectionView *)collectionView;

/**
 *  Return number of layout's columns in given collection view section
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Number of layout's columns
 */
- (NSUInteger)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                collectionView:(UICollectionView *)collectionView
                      numberOfColumnsInSection:(NSUInteger)section;

/**
 *  Return number of layout's rows in given collection view section
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Number of layout's rows
 */
- (NSUInteger)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                collectionView:(UICollectionView *)collectionView
                         numberOfRowsInSection:(NSUInteger)section;

/**
 *  Return width for layout's column in given collection view section
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param column         Layout's column index
 *  @param section        Collection View section
 *
 *  @return Column width
 */
- (CGFloat)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                             collectionView:(UICollectionView *)collectionView
                             widthForColumn:(NSUInteger)column
                                  inSection:(NSUInteger)section;

/**
 *  Return height for layout's row in given collection view section
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row index
 *  @param section        Collection View section
 *
 *  @return Row height
 */
- (CGFloat)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                collectionView:(UICollectionView *)collectionView
                               heightForRow:(NSUInteger)row
                                  inSection:(NSUInteger)section;

/**
 *  Return cell for given row and column in collection view
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row
 *  @param column         Layout's column
 *  @param indexPath      Collection View Cell index path
 *
 *  @return Collection View Cell
 */
- (UICollectionViewCell *)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                            collectionView:(UICollectionView *)collectionView
                                                cellForRow:(NSUInteger)row
                                                    column:(NSUInteger)column
                                                 indexPath:(NSIndexPath *)indexPath;

@optional

/**
 *  Return width for row headers. Return 0 to disable row headers.
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Row headers width
 */
- (CGFloat)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                             collectionView:(UICollectionView *)collectionView
                 widthForRowHeaderInSection:(NSUInteger)section;

/**
 *  Return height for column headers. Return 0 to disable column headers.
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Column headers height
 */
- (CGFloat)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                             collectionView:(UICollectionView *)collectionView
             heightForColumnHeaderInSection:(NSUInteger)section;

/**
 *  Return view for column header
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param column         Layout's column
 *  @param indexPath      Collection View Supplementary View index path
 *
 *  @return Collection Reusable View
 */
- (UICollectionReusableView *)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                                collectionView:(UICollectionView *)collectionView
                                           headerViewForColumn:(NSUInteger)column
                                                     indexPath:(NSIndexPath *)indexPath;

/**
 *  Return view for row header
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row
 *  @param indexPath      Collection View Supplementary View index path
 *
 *  @return Collection Reusable View
 */
- (UICollectionReusableView *)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                                                collectionView:(UICollectionView *)collectionView
                                              headerViewForRow:(NSUInteger)row
                                                     indexPath:(NSIndexPath *)indexPath;

/**
 *  Return YES if row headers in given section should stick to left edge
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Boolean value
 */
- (BOOL)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                          collectionView:(UICollectionView *)collectionView
              stickyRowHeadersForSection:(NSUInteger)section;

/**
 *  Return YES if column headers in given section should stick to top edge
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param section        Collection View section
 *
 *  @return Boolean value
 */
- (BOOL)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                          collectionView:(UICollectionView *)collectionView
           stickyColumnHeadersForSection:(NSUInteger)section;

/**
 *  Will be called when user selects cell
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row
 *  @param column         Layout's column
 *  @param indexPath      Collection View Cell index path
 */
- (void)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                          collectionView:(UICollectionView *)collectionView
                      didSelectCellAtRow:(NSUInteger)row
                                  column:(NSUInteger)column
                               indexPath:(NSIndexPath *)indexPath;

/**
 *  Will be called when user deselects cell
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row
 *  @param column         Layout's column
 *  @param indexPath      Collection View Cell index path
 */
- (void)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                          collectionView:(UICollectionView *)collectionView
                    didDeselectCellAtRow:(NSUInteger)row
                                  column:(NSUInteger)column
                               indexPath:(NSIndexPath *)indexPath;

/**
 *  Will be called in order to decide if the cell has to be selected or not
 *
 *  @param manager        Collection View Table Layout Manager
 *  @param collectionView Collection View
 *  @param row            Layout's row
 *  @param column         Layout's column
 *  @param indexPath      Collection View Cell index path
 */
- (BOOL)collectionViewTableLayoutManager:(DRCollectionViewTableLayoutManager *)manager
                          collectionView:(UICollectionView *)collectionView
                   shouldSelectItemAtRow:(NSUInteger)row
                                  column:(NSUInteger)column
                               indexPath:(NSIndexPath *)indexPath;

@end

/**
 *  Collection View Table Layout Manager
 */
@interface DRCollectionViewTableLayoutManager : NSObject <UICollectionViewDataSource, DRCollectionViewTableLayoutDelegate, UICollectionViewDelegate>

/**
 *  Collection View Table Layout Manager Delegate
 */
@property (weak, nonatomic) id<DRCollectionViewTableLayoutManagerDelegate> delegate;

@end