Define ASCollectionView interface, ASCollectionViewDataSource and ASCollectionViewDelegate protocols.

2025-12-23 06:35:51 +00:00 · 2014-11-10 22:52:38 +02:00
parent 6c9e499875
commit 8e0c49a909
4 changed files with 185 additions and 0 deletions
--- a/AsyncDisplayKit.xcodeproj/project.pbxproj
+++ b/AsyncDisplayKit.xcodeproj/project.pbxproj
@@ -122,6 +122,9 @@
 		05A6D05B19D0EB64002DD95E /* ASDealloc2MainObject.m in Sources */ = {isa = PBXBuildFile; fileRef = 05A6D05919D0EB64002DD95E /* ASDealloc2MainObject.m */; settings = {COMPILER_FLAGS = "-fno-objc-arc"; }; };
 		3C9C128519E616EF00E942A0 /* ASTableViewTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C9C128419E616EF00E942A0 /* ASTableViewTests.m */; settings = {COMPILER_FLAGS = "-fno-objc-arc"; }; };
 		6BDC61F61979037800E50D21 /* AsyncDisplayKit.h in Headers */ = {isa = PBXBuildFile; fileRef = 6BDC61F51978FEA400E50D21 /* AsyncDisplayKit.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		AC3C4A511A1139C100143C57 /* ASCollectionView.h in Headers */ = {isa = PBXBuildFile; fileRef = AC3C4A4F1A1139C100143C57 /* ASCollectionView.h */; };
+		AC3C4A521A1139C100143C57 /* ASCollectionView.m in Sources */ = {isa = PBXBuildFile; fileRef = AC3C4A501A1139C100143C57 /* ASCollectionView.m */; };
+		AC3C4A541A113EEC00143C57 /* ASCollectionViewProtocols.h in Headers */ = {isa = PBXBuildFile; fileRef = AC3C4A531A113EEC00143C57 /* ASCollectionViewProtocols.h */; };
 		DB7121BCD50849C498C886FB /* libPods-AsyncDisplayKitTests.a in Frameworks */ = {isa = PBXBuildFile; fileRef = EFA731F0396842FF8AB635EE /* libPods-AsyncDisplayKitTests.a */; };
 /* End PBXBuildFile section */

@@ -241,6 +244,9 @@
 		05A6D05919D0EB64002DD95E /* ASDealloc2MainObject.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = ASDealloc2MainObject.m; path = ../Details/ASDealloc2MainObject.m; sourceTree = "<group>"; };
 		3C9C128419E616EF00E942A0 /* ASTableViewTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASTableViewTests.m; sourceTree = "<group>"; };
 		6BDC61F51978FEA400E50D21 /* AsyncDisplayKit.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AsyncDisplayKit.h; sourceTree = "<group>"; };
+		AC3C4A4F1A1139C100143C57 /* ASCollectionView.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASCollectionView.h; sourceTree = "<group>"; };
+		AC3C4A501A1139C100143C57 /* ASCollectionView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASCollectionView.m; sourceTree = "<group>"; };
+		AC3C4A531A113EEC00143C57 /* ASCollectionViewProtocols.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASCollectionViewProtocols.h; sourceTree = "<group>"; };
 		D3779BCFF841AD3EB56537ED /* Pods-AsyncDisplayKitTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-AsyncDisplayKitTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-AsyncDisplayKitTests/Pods-AsyncDisplayKitTests.release.xcconfig"; sourceTree = "<group>"; };
 		EFA731F0396842FF8AB635EE /* libPods-AsyncDisplayKitTests.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-AsyncDisplayKitTests.a"; sourceTree = BUILT_PRODUCTS_DIR; };
 		FB07EABBCF28656C6297BC2D /* Pods-AsyncDisplayKitTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-AsyncDisplayKitTests.debug.xcconfig"; path = "Pods/Target Support Files/Pods-AsyncDisplayKitTests/Pods-AsyncDisplayKitTests.debug.xcconfig"; sourceTree = "<group>"; };
@@ -320,6 +326,9 @@
 				055F1A3219ABD3E3004DAFF1 /* ASTableView.h */,
 				0574D5E119C110610097DC25 /* ASTableViewProtocols.h */,
 				055F1A3319ABD3E3004DAFF1 /* ASTableView.m */,
+				AC3C4A4F1A1139C100143C57 /* ASCollectionView.h */,
+				AC3C4A531A113EEC00143C57 /* ASCollectionViewProtocols.h */,
+				AC3C4A501A1139C100143C57 /* ASCollectionView.m */,
 				055F1A3A19ABD43F004DAFF1 /* ASCellNode.h */,
 				055F1A3B19ABD43F004DAFF1 /* ASCellNode.m */,
 				058D09E1195D050800B7D73C /* Details */,
@@ -472,6 +481,7 @@
 				058D0A48195D05CB00B7D73C /* ASControlNode.m in Headers */,
 				058D0A49195D05CB00B7D73C /* ASControlNode+Subclasses.h in Headers */,
 				058D0A4A195D05CB00B7D73C /* ASDisplayNode.h in Headers */,
+				AC3C4A511A1139C100143C57 /* ASCollectionView.h in Headers */,
 				058D0A4B195D05CB00B7D73C /* ASDisplayNode.mm in Headers */,
 				058D0A4C195D05CB00B7D73C /* ASDisplayNode+Subclasses.h in Headers */,
 				058D0A4D195D05CB00B7D73C /* ASDisplayNodeExtras.h in Headers */,
@@ -535,6 +545,7 @@
 				058D0A7F195D05F900B7D73C /* ASSentinel.h in Headers */,
 				058D0A80195D05F900B7D73C /* ASSentinel.m in Headers */,
 				058D0A81195D05F900B7D73C /* ASThread.h in Headers */,
+				AC3C4A541A113EEC00143C57 /* ASCollectionViewProtocols.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -665,6 +676,7 @@
 				055F1A3519ABD3E3004DAFF1 /* ASTableView.m in Sources */,
 				058D0A1D195D050800B7D73C /* ASTextNodeRenderer.mm in Sources */,
 				058D0A2A195D050800B7D73C /* ASDisplayNode+UIViewBridge.mm in Sources */,
+				AC3C4A521A1139C100143C57 /* ASCollectionView.m in Sources */,
 				058D0A20195D050800B7D73C /* ASTextNodeWordKerner.m in Sources */,
 				058D0A1A195D050800B7D73C /* ASHighlightOverlayLayer.mm in Sources */,
 				058D0A28195D050800B7D73C /* ASDisplayNode+AsyncDisplay.mm in Sources */,
--- a/AsyncDisplayKit/ASCollectionView.h
+++ b/AsyncDisplayKit/ASCollectionView.h
@@ -0,0 +1,104 @@
+/* Copyright (c) 2014-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <UIKit/UIKit.h>
+
+#import <AsyncDisplayKit/ASRangeController.h>
+#import <AsyncDisplayKit/ASCollectionViewProtocols.h>
+
+@class ASCellNode;
+@protocol ASCollectionViewDataSource;
+@protocol ASCollectionViewDelegate;
+
+
+/**
+ * Node-based collection view.
+ *
+ * ASCollectionView is a version of UICollectionView that uses nodes -- specifically, ASCellNode subclasses -- with asynchronous
+ * pre-rendering instead of synchronously loading UICollectionViewCells.
+ */
+@interface ASCollectionView : UICollectionView
+
+@property (nonatomic, weak) id<ASCollectionViewDataSource> asyncDataSource;
+@property (nonatomic, weak) id<ASCollectionViewDelegate> asyncDelegate;
+
+/**
+ * Tuning parameters for the working range.
+ *
+ * Defaults to a trailing buffer of one screenful and a leading buffer of two screenfuls.
+ */
+@property (nonatomic, assign) ASRangeTuningParameters rangeTuningParameters;
+
+/**
+ * Reload everything from scratch, destroying the working range and all cached nodes.
+ *
+ * @warning This method is substantially more expensive than UICollectionView's version.
+ */
+- (void)reloadData;
+
+/**
+ * WARNING:  ASCollectionView's update/editing support is not yet implemented.  Use of these methods will fire an assertion.
+ *
+ * This initial version of ASCollectionView only supports appending nodes (see below).  If you'd like to see full-fledged
+ * support for data source updates and interactive editing, please file a GitHub issue -- AsyncDisplayKit can do it,
+ * we just haven't built it out yet.  :]
+ */
+//- (void)insertSections:(NSIndexSet *)sections;
+//- (void)deleteSections:(NSIndexSet *)sections;
+//- (void)reloadSections:(NSIndexSet *)sections;
+//- (void)moveSection:(NSInteger)section toSection:(NSInteger)newSection;
+//
+//- (void)insertItemsAtIndexPaths:(NSArray *)indexPaths;
+//- (void)deleteItemsAtIndexPaths:(NSArray *)indexPaths;
+//- (void)reloadItemsAtIndexPaths:(NSArray *)indexPaths;
+//- (void)moveItemAtIndexPath:(NSIndexPath *)indexPath toIndexPath:(NSIndexPath *)newIndexPath;
+
+/**
+ * Append nodes.
+ *
+ * As with UICollectionView, the asyncDataSource must be updated to reflect the new nodes before this method is called.
+ *
+ * @param indexPaths Ordered array of index paths corresponding to the nodes to be added.
+ */
+- (void)appendNodesWithIndexPaths:(NSArray *)indexPaths;
+
+@end
+
+
+/**
+ * This is a node-based UICollectionViewDataSource.
+ */
+@protocol ASCollectionViewDataSource <ASCommonCollectionViewDataSource, NSObject>
+
+/**
+ * Similar to -collectionView:cellForItemAtIndexPath:.
+ *
+ * @param collection The sender.
+ *
+ * @param indexPath The index path of the requested node.
+ *
+ * @returns a node for display at this indexpath.  Must be thread-safe (can be called on the main thread or a background
+ * queue) and should not implement reuse (it will be called once per row).  Unlike UICollectionView's version, this method
+ * is not called when the row is about to display.
+ */
+- (ASCellNode *)collectionView:(ASCollectionView *)collectionView nodeForItemAtIndexPath:(NSIndexPath *)indexPath;
+
+@end
+
+
+/**
+ * This is a node-based UICollectionViewDelegate.
+ */
+@protocol ASCollectionViewDelegate <ASCommonCollectionViewDelegate, NSObject>
+
+@optional
+
+- (void)collectionView:(UICollectionView *)collectionView willDisplayNodeForItemAtIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didEndDisplayingNodeForItemAtIndexPath:(NSIndexPath*)indexPath;
+
+@end
--- a/AsyncDisplayKit/ASCollectionView.m
+++ b/AsyncDisplayKit/ASCollectionView.m
@@ -0,0 +1,13 @@
+/* Copyright (c) 2014-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "ASCollectionView.h"
+
+@implementation ASCollectionView
+
+@end
--- a/AsyncDisplayKit/ASCollectionViewProtocols.h
+++ b/AsyncDisplayKit/ASCollectionViewProtocols.h
@@ -0,0 +1,56 @@
+/* Copyright (c) 2014-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+/**
+ * This is a subset of UICollectionViewDataSource.
+ *
+ * @see ASCollectionViewDataSource
+ */
+@protocol ASCommonCollectionViewDataSource <NSObject>
+
+@required
+
+- (NSInteger)collectionView:(UICollectionView *)collectionView numberOfItemsInSection:(NSInteger)section;
+
+@optional
+
+- (NSInteger)numberOfSectionsInCollectionView:(UICollectionView *)collectionView;
+
+- (UICollectionReusableView *)collectionView:(UICollectionView *)collectionView viewForSupplementaryElementOfKind:(NSString *)kind atIndexPath:(NSIndexPath *)indexPath;
+
+@end
+
+
+/**
+ * This is a subset of UICollectionViewDelegate.
+ *
+ * @see ASCollectionViewDelegate
+ */
+@protocol ASCommonCollectionViewDelegate <NSObject, UIScrollViewDelegate>
+
+@optional
+
+- (UICollectionViewTransitionLayout *)collectionView:(UICollectionView *)collectionView transitionLayoutForOldLayout:(UICollectionViewLayout *)fromLayout newLayout:(UICollectionViewLayout *)toLayout;
+
+- (void)collectionView:(UICollectionView *)collectionView willDisplaySupplementaryView:(UICollectionReusableView *)view forElementKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didEndDisplayingSupplementaryView:(UICollectionReusableView *)view forElementOfKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)indexPath;
+
+- (BOOL)collectionView:(UICollectionView *)collectionView shouldHighlightItemAtIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didHighlightItemAtIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didUnhighlightItemAtIndexPath:(NSIndexPath *)indexPath;
+
+- (BOOL)collectionView:(UICollectionView *)collectionView shouldSelectItemAtIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didSelectItemAtIndexPath:(NSIndexPath *)indexPath;
+- (BOOL)collectionView:(UICollectionView *)collectionView shouldDeselectItemAtIndexPath:(NSIndexPath *)indexPath;
+- (void)collectionView:(UICollectionView *)collectionView didDeselectItemAtIndexPath:(NSIndexPath *)indexPath;
+
+- (BOOL)collectionView:(UICollectionView *)collectionView shouldShowMenuForItemAtIndexPath:(NSIndexPath *)indexPath;
+- (BOOL)collectionView:(UICollectionView *)collectionView canPerformAction:(SEL)action forItemAtIndexPath:(NSIndexPath *)indexPath withSender:(id)sender;
+- (void)collectionView:(UICollectionView *)collectionView performAction:(SEL)action forItemAtIndexPath:(NSIndexPath *)indexPath withSender:(id)sender;
+
+@end