Files
AsyncDisplayKit/appledoc/Protocols/ASCollectionViewDelegate.html
2015-09-16 14:54:25 +03:00

345 lines
9.0 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASCollectionViewDelegate Protocol Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">AsyncDisplayKit </a>
</h1>
<p id="developer-home">
<a href="../index.html">Facebook</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Instance Methods">
<option value="//api/name/collectionView:layout:insetForSectionAtIndex:">- collectionView:layout:insetForSectionAtIndex:</option>
<option value="//api/name/collectionView:willBeginBatchFetchWithContext:">- collectionView:willBeginBatchFetchWithContext:</option>
<option value="//api/name/shouldBatchFetchForCollectionView:">- shouldBatchFetchForCollectionView:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASCollectionViewDelegate Protocol Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Conforms to</th>
<td><a href="../Protocols/ASCommonCollectionViewDelegate.html">ASCommonCollectionViewDelegate</a><br />NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASCollectionView.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>This is a node-based UICollectionViewDelegate.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/collectionView:willBeginBatchFetchWithContext:" title="collectionView:willBeginBatchFetchWithContext:"></a>
<h3 class="method-title"><code><a href="#//api/name/collectionView:willBeginBatchFetchWithContext:">&ndash;&nbsp;collectionView:willBeginBatchFetchWithContext:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Receive a message that the collectionView is near the end of its data set and more data should be fetched if
necessary.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)collectionView:(ASCollectionView *)<em>collectionView</em> willBeginBatchFetchWithContext:(ASBatchContext *)<em>context</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>collectionView</code></th>
<td><p>The sender.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>context</code></th>
<td><p>A context object that must be notified when the batch fetch is completed.</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>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.</p>
<p>UICollectionView currently only supports batch events for tail loads. If you require a head load, consider
implementing a UIRefreshControl.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASCollectionView.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/shouldBatchFetchForCollectionView:" title="shouldBatchFetchForCollectionView:"></a>
<h3 class="method-title"><code><a href="#//api/name/shouldBatchFetchForCollectionView:">&ndash;&nbsp;shouldBatchFetchForCollectionView:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Tell the collectionView if batch fetching should begin.</p>
</div>
<div class="method-subsection method-declaration"><code>- (BOOL)shouldBatchFetchForCollectionView:(ASCollectionView *)<em>collectionView</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>collectionView</code></th>
<td><p>The sender.</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>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.</p>
<p>If not implemented, the collectionView assumes that it should notify its asyncDelegate when batch fetching
should occur.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASCollectionView.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/collectionView:layout:insetForSectionAtIndex:" title="collectionView:layout:insetForSectionAtIndex:"></a>
<h3 class="method-title"><code><a href="#//api/name/collectionView:layout:insetForSectionAtIndex:">&ndash;&nbsp;collectionView:layout:insetForSectionAtIndex:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Passthrough support to UICollectionViewDelegateFlowLayout sectionInset behavior.</p>
</div>
<div class="method-subsection method-declaration"><code>- (UIEdgeInsets)collectionView:(UICollectionView *)<em>collectionView</em> layout:(UICollectionViewLayout *)<em>collectionViewLayout</em> insetForSectionAtIndex:(NSInteger)<em>section</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>collectionView</code></th>
<td><p>The sender.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>collectionViewLayout</code></th>
<td><p>The layout object requesting the information.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>section</code></th>
<td><p>The index number of the section whose insets are needed.</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The same rules apply as the UICollectionView implementation, but this can also be used without a UICollectionViewFlowLayout.
https://developer.apple.com/library/ios/documentation/UIKit/Reference/UICollectionViewDelegateFlowLayout_protocol/index.html#//apple_ref/occ/intfm/UICollectionViewDelegateFlowLayout/collectionView:layout:insetForSectionAtIndex:</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASCollectionView.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2015 Facebook. All rights reserved. Updated: 2015-09-16</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>