FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
AsyncDisplayKit/AsyncDisplayKit/ASCollectionView.h at master · clooth/AsyncDisplayKit · GitHub
clooth
/
AsyncDisplayKit
Public
forked from
facebookarchive/AsyncDisplayKit
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
AsyncDisplayKit
/
AsyncDisplayKit
/
ASCollectionView.h
Copy path
More file actions
More file actions
Latest commit
History
History
History
222 lines (186 loc) · 8.28 KB
Breadcrumbs
AsyncDisplayKit
/
AsyncDisplayKit
/
ASCollectionView.h
Copy path
File metadata and controls
222 lines (186 loc) · 8.28 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
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
>
#
import
<
AsyncDisplayKit/ASBaseDefines.h
>
#
import
<
AsyncDisplayKit/ASBatchContext.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;
//
must not be nil
/*
*
* Tuning parameters for a range.
*
* @param range The range to get the tuning parameters for.
*
* @returns A tuning parameter value for the given range.
*
* Defaults to the render range having one sceenful both leading and trailing and the preload range having two
* screenfuls in both directions.
*/
- (ASRangeTuningParameters)
tuningParametersForRangeType
:
(ASLayoutRangeType)
rangeType
;
/*
*
* Set the tuning parameters for a range.
*
* @param tuningParameters The tuning parameters to store for a range.
* @param range The range to set the tuning parameters for.
*/
- (
void
)
setTuningParameters
:
(ASRangeTuningParameters)
tuningParameters
forRangeType
:
(ASLayoutRangeType)
rangeType
;
/*
*
* Initializer.
*
* @discussion If asyncDataFetching is enabled, the `AScollectionView` will fetch data through `collectionView:numberOfRowsInSection:` and
* `collectionView:nodeForRowAtIndexPath:` in async mode from background thread. Otherwise, the methods will be invoked synchronically
* from calling thread.
* Enabling asyncDataFetching could avoid blocking main thread for `ASCellNode` allocation, which is frequently reported issue for
* large scale data. On another hand, the application code need take the responsibility to avoid data inconsistence. Specifically,
* we will lock the data source through `collectionViewLockDataSource`, and unlock it by `collectionViewUnlockDataSource` after the data fetching.
* The application should not update the data source while the data source is locked, to keep data consistence.
*/
- (
instancetype
)
initWithFrame
:
(CGRect)
frame
collectionViewLayout
:
(UICollectionViewLayout *)
layout
asyncDataFetching
:
(
BOOL
)
asyncDataFetchingEnabled
;
/*
*
* The number of screens left to scroll before the delegate -collectionView:beginBatchFetchingWithContext: is called.
*
* Defaults to one screenful.
*/
@property
(
nonatomic
,
assign
) CGFloat leadingScreensForBatching;
/*
*
* Reload everything from scratch, destroying the working range and all cached nodes.
*
* @param completion block to run on completion of asynchronous loading or nil. If supplied, the block is run on
* the main thread.
* @warning This method is substantially more expensive than UICollectionView's version.
*/
- (
void
)
reloadDataWithCompletion
:
(
void
(^)())
completion
;
/*
*
* 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
;
/*
*
* Section updating.
*
* All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI collection
* view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.
*/
- (
void
)
insertSections
:
(
NSIndexSet
*)
sections
;
- (
void
)
deleteSections
:
(
NSIndexSet
*)
sections
;
- (
void
)
reloadSections
:
(
NSIndexSet
*)
sections
;
- (
void
)
moveSection
:
(
NSInteger
)
section
toSection
:
(
NSInteger
)
newSection
;
/*
*
* Items updating.
*
* All operations are asynchronous and thread safe. You can call it from background thread (it is recommendated) and the UI collection
* view will be updated asynchronously. The asyncDataSource must be updated to reflect the changes before these methods are called.
*/
- (
void
)
insertItemsAtIndexPaths
:
(
NSArray
*)
indexPaths
;
- (
void
)
deleteItemsAtIndexPaths
:
(
NSArray
*)
indexPaths
;
- (
void
)
reloadItemsAtIndexPaths
:
(
NSArray
*)
indexPaths
;
- (
void
)
moveItemAtIndexPath
:
(
NSIndexPath
*)
indexPath
toIndexPath
:
(
NSIndexPath
*)
newIndexPath
;
/*
*
* Similar to -cellForItemAtIndexPath:.
*
* @param indexPath The index path of the requested node.
*
* @returns a node for display at this indexpath.
*/
- (ASCellNode *)
nodeForItemAtIndexPath
:
(
NSIndexPath
*)
indexPath
;
/*
*
* Similar to -visibleCells.
*
* @returns an array containing the nodes being displayed on screen.
*/
- (
NSArray
*)
visibleNodes
;
/*
*
* Query the sized node at `indexPath` for its calculatedSize.
*
* @param indexPath The index path for the node of interest.
*/
- (CGSize)
calculatedSizeForNodeAtIndexPath
:
(
NSIndexPath
*)
indexPath
;
@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
;
@optional
/*
*
* Indicator to lock the data source for data fetching in async mode.
* We should not update the data source until the data source has been unlocked. Otherwise, it will incur data inconsistence or exception
* due to the data access in async mode.
*
* @param collectionView The sender.
*/
- (
void
)
collectionViewLockDataSource
:
(ASCollectionView *)
collectionView
;
/*
*
* Indicator to unlock the data source for data fetching in async mode.
* We should not update the data source until the data source has been unlocked. Otherwise, it will incur data inconsistence or exception
* due to the data access in async mode.
*
* @param collectionView The sender.
*/
- (
void
)
collectionViewUnlockDataSource
:
(ASCollectionView *)
collectionView
;
@end
/*
*
* This is a node-based UICollectionViewDelegate.
*/
@protocol
ASCollectionViewDelegate
<ASCommonCollectionViewDelegate,
NSObject
>
@optional
- (
void
)
collectionView
:
(ASCollectionView *)
collectionView
willDisplayNodeForItemAtIndexPath
:
(
NSIndexPath
*)
indexPath
;
- (
void
)
collectionView
:
(ASCollectionView *)
collectionView
didEndDisplayingNodeForItemAtIndexPath
:
(
NSIndexPath
*)
indexPath
;
/*
*
* Receive a message that the collectionView is near the end of its data set and more data should be fetched if
* necessary.
*
* @param collectionView The sender.
* @param context A context object that must be notified when the batch fetch is completed.
*
* @discussion You must eventually call -completeBatchFetching: with an argument of YES in order to receive future
* notifications to do batch fetches. This method is called on a background queue.
*
* UICollectionView currently only supports batch events for tail loads. If you require a head load, consider
* implementing a UIRefreshControl.
*/
- (
void
)
collectionView
:
(ASCollectionView *)
collectionView
willBeginBatchFetchWithContext
:
(ASBatchContext *)
context
;
/*
*
* Tell the collectionView if batch fetching should begin.
*
* @param collectionView The sender.
*
* @discussion Use this method to conditionally fetch batches. Example use cases are: limiting the total number of
* objects that can be fetched or no network connection.
*
* If not implemented, the collectionView assumes that it should notify its asyncDelegate when batch fetching
* should occur.
*/
- (
BOOL
)
shouldBatchFetchForCollectionView
:
(ASCollectionView *)
collectionView
;
@end
@interface
ASCollectionView
(Deprecated)
@property
(
nonatomic
,
assign
) ASRangeTuningParameters rangeTuningParameters
ASDISPLAYNODE_DEPRECATED
;
@end
Back
|
FazBrowse Home
|
New Git URL