-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathintroduction.html
More file actions
293 lines (276 loc) · 14.7 KB
/
introduction.html
File metadata and controls
293 lines (276 loc) · 14.7 KB
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html>
<html lang="en">
<head>
<title>Introduction Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<meta name="viewport" content="width=device-width, viewport-fit=cover, initial-scale=1.0" />
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a title="Introduction Reference"></a>
<header>
<div class="content-wrapper">
<p>
<a href="index.html">CollectionView Docs</a>
<span class="no-mobile"> (63% documented)</span>
</p>
<p class="header-right">
<a href="https://github.com/TheNounProject/CollectionView">
<img src="img/gh.png"/>
<span class="no-mobile">View on GitHub</span>
</a>
</p>
</div>
</header>
<div id="breadcrumbs-container">
<div class="content-wrapper">
<p id="breadcrumbs">
<span class="no-mobile">
<a href="index.html">CollectionView Reference</a>
<img id="carat" src="img/carat.png" />
</span>
Introduction Reference
</p>
</div>
</div>
<div class="wrapper">
<div class="article-wrapper">
<article class="main-content">
<section>
<section class="section">
<h1 id='collection-view-basics' class='heading'>Collection View Basics</h1>
<p>A collection view coordinatess many different objects to display content. For basic usage most of these can be used as is leaving your app to provide only a few pieces of information. Each component can then be highly customized to meet your specific needs.</p>
<p>Let’s start with an overview of these components, then the other guides will go into more detail about how to use and customize each of them.</p>
<hr>
<h2 id='the-collectionview' class='heading'>The CollectionView</h2>
<p>The collection view itself is the container and coordinator that brings all the information together to preset something on the screen. Its primary resources are the data source and layout object.</p>
<p>A <code><a href="Classes/CollectionViewController.html">CollectionViewController</a></code> provides a controller preconfiguerd with a collection view.</p>
<h2 id='datasource-and-delegate' class='heading'>DataSource and Delegate</h2>
<p>The data source is the key input <strong>required</strong> by your app to display a collection view. The data source manages the content to be displayed and provides the cells that represent each member of that content on screen.</p>
<p>While the data source provides for the collection view, the delegate lets you optionally react to messages and customize behavior. Selection, highlight and scroll events for example are reported to the delegate. All delegate methods are optional.</p>
<p>The <code><a href="Protocols/CollectionViewDragDelegate.html">CollectionViewDragDelegate</a></code> is an extension of the standard delegate protocol that allows forwarding dragging events to the delegate.</p>
<h2 id='presentation' class='heading'>Presentation</h2>
<p><code><a href="Classes/CollectionReusableView.html">CollectionReusableView</a></code> are used to represent the content of your collection view on screen. This class provides the mechanisms for layout and reusability of views to maintain adequate performance.</p>
<p>The <code><a href="Classes/CollectionViewCell.html">CollectionViewCell</a></code> is a special type of reusable view used to display The main elements of your data.</p>
<h2 id='layout' class='heading'>Layout</h2>
<p>Subclasses of <code><a href="Classes/CollectionViewLayout.html">CollectionViewLayout</a></code> are used to manage the location, size, and visual attributes of each reusable view (and cell) in the collection view.</p>
<p>The layout creates layout attributes (<code><a href="Classes/CollectionViewLayoutAttributes.html">CollectionViewLayoutAttributes</a></code>) for each cell and resuable view which are then used by the collection view.</p>
</section>
</section>
</article>
</div>
<div class="nav-wrapper">
<nav class="nav-bottom">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="introduction.html">Introduction</a>
</li>
<li class="nav-group-task">
<a href="basic-setup.html">Basic Setup</a>
</li>
<li class="nav-group-task">
<a href="supplementary-views.html">Supplementary Views</a>
</li>
<li class="nav-group-task">
<a href="layouts.html">Layouts</a>
</li>
<li class="nav-group-task">
<a href="drag--drop.html">Drag & Drop</a>
</li>
<li class="nav-group-task">
<a href="content-updates.html">Content Updates</a>
</li>
<li class="nav-group-task">
<a href="results-controller.html">Results Controller</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Collection View.html">Collection View</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/CollectionView.html">CollectionView</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionView.html#/s:14CollectionViewAAC13SelectionModeO">– SelectionMode</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDataSource.html">CollectionViewDataSource</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDelegate.html">CollectionViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDragDelegate.html">CollectionViewDragDelegate</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewCell.html">CollectionViewCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionReusableView.html">CollectionReusableView</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewController.html">CollectionViewController</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView0aB17LayoutElementKindV">CollectionViewLayoutElementKind</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView0A15ElementCategoryO">CollectionElementCategory</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView0aB9DirectionO">CollectionViewDirection</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView0aB15ScrollDirectionO">CollectionViewScrollDirection</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView0aB14ScrollPositionO">CollectionViewScrollPosition</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewPreviewCell.html">CollectionViewPreviewCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewPreviewController.html">CollectionViewPreviewController</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewPreviewTransitionCell.html">CollectionViewPreviewTransitionCell</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewPreviewControllerDelegate.html">CollectionViewPreviewControllerDelegate</a>
</li>
<li class="nav-group-task">
<a href="Collection View.html#/s:14CollectionView19AnimationCompletiona">AnimationCompletion</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Collection View Layouts.html">Collection View Layouts</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/CollectionViewLayout.html">CollectionViewLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewLayoutAttributes.html">CollectionViewLayoutAttributes</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewListLayout.html">CollectionViewListLayout</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDelegateListLayout.html">CollectionViewDelegateListLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewColumnLayout.html">CollectionViewColumnLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewColumnLayout.html#/s:14CollectionView0aB12ColumnLayoutC0D8StrategyO">– LayoutStrategy</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDelegateColumnLayout.html">CollectionViewDelegateColumnLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewFlowLayout.html">CollectionViewFlowLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewFlowLayout.html#/s:14CollectionView0aB10FlowLayoutC12RowTransformO">– RowTransform</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewFlowLayout/ItemStyle.html">– ItemStyle</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDelegateFlowLayout.html">CollectionViewDelegateFlowLayout</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewHorizontalListLayout.html">CollectionViewHorizontalListLayout</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CollectionViewDelegateHorizontalListLayout.html">CollectionViewDelegateHorizontalListLayout</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Results Controller.html">Results Controller</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/ResultsController.html">ResultsController</a>
</li>
<li class="nav-group-task">
<a href="Protocols/ResultsControllerDelegate.html">ResultsControllerDelegate</a>
</li>
<li class="nav-group-task">
<a href="Classes/MutableResultsController.html">MutableResultsController</a>
</li>
<li class="nav-group-task">
<a href="Classes/FetchedResultsController.html">FetchedResultsController</a>
</li>
<li class="nav-group-task">
<a href="Classes/RelationalResultsController.html">RelationalResultsController</a>
</li>
<li class="nav-group-task">
<a href="Classes/FetchedSetController.html">FetchedSetController</a>
</li>
<li class="nav-group-task">
<a href="Results Controller.html#/s:14CollectionView27ResultsControllerChangeTypeO">ResultsControllerChangeType</a>
</li>
<li class="nav-group-task">
<a href="Results Controller.html#/s:14CollectionView22ResultsControllerErrorO">ResultsControllerError</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewProvider.html">CollectionViewProvider</a>
</li>
<li class="nav-group-task">
<a href="Classes/CollectionViewResultsProxy.html">CollectionViewResultsProxy</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/SortDescriptorResult.html">SortDescriptorResult</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Extensions.html">Other Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/IndexPath.html">IndexPath</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Other Protocols.html#/s:14CollectionView30CustomDisplayStringConvertibleP">CustomDisplayStringConvertible</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/SortDescriptor.html">SortDescriptor</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>© 2018 <a class="link" href="" target="_blank" rel="external">Noun Project</a>. All rights reserved. (Last updated: 2018-10-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</div>
</div>
</body>
</div>
</html>