<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>ASPagerNode Class 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 1334)"> </head> <body class="appledoc"> <header> <div class="container" class="hide-in-xcode"> <h1 id="library-title"> <a href="../index.html"> </a> </h1> <p id="developer-home"> <a href="../index.html">AsyncDisplayKit</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…</option> <option value="tasks">Tasks</option> <optgroup label="Properties"> <option value="//api/name/currentPageIndex">currentPageIndex</option> <option value="//api/name/view">view</option> </optgroup> <optgroup label="Instance Methods"> <option value="//api/name/dataSource">- dataSource</option> <option value="//api/name/delegate">- delegate</option> <option value="//api/name/init">- init</option> <option value="//api/name/initWithCollectionViewLayout:">- initWithCollectionViewLayout:</option> <option value="//api/name/nodeForPageAtIndex:">- nodeForPageAtIndex:</option> <option value="//api/name/scrollToPageAtIndex:animated:">- scrollToPageAtIndex:animated:</option> <option value="//api/name/setDataSource:">- setDataSource:</option> <option value="//api/name/setDelegate:">- setDelegate:</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">ASPagerNode Class Reference</h1> <div class="section section-specification"><table cellspacing="0"><tbody> <tr> <th>Inherits from</th> <td><a href="../Classes/ASCollectionNode.html">ASCollectionNode</a> : <a href="../Classes/ASDisplayNode.html">ASDisplayNode</a> : ASDealloc2MainObject</td> </tr><tr> <th>Declared in</th> <td>ASPagerNode.h</td> </tr> </tbody></table></div> <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> <div class="task-list"> <div class="section-method"> <a name="//api/name/init" title="init"></a> <h3 class="method-title"><code><a href="#//api/name/init">– init</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Configures a default horizontal, paging flow layout with 0 inter-item spacing.</p> </div> <div class="method-subsection method-declaration"><code>- (instancetype)init</code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/initWithCollectionViewLayout:" title="initWithCollectionViewLayout:"></a> <h3 class="method-title"><code><a href="#//api/name/initWithCollectionViewLayout:">– initWithCollectionViewLayout:</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Initializer with custom-configured flow layout properties.</p> </div> <div class="method-subsection method-declaration"><code>- (instancetype)initWithCollectionViewLayout:(ASPagerFlowLayout *)<em>flowLayout</em></code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/setDataSource:" title="setDataSource:"></a> <h3 class="method-title"><code><a href="#//api/name/setDataSource:">– setDataSource:</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Data Source is required, and uses a different protocol from ASCollectionNode.</p> </div> <div class="method-subsection method-declaration"><code>- (void)setDataSource:(nullable id<ASPagerDataSource>)<em>dataSource</em></code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/dataSource" title="dataSource"></a> <h3 class="method-title"><code><a href="#//api/name/dataSource">– dataSource</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>The object that acts as the asynchronous data source of the collection view</p> </div> <div class="method-subsection method-declaration"><code>- (nullable id<ASPagerDataSource>)dataSource</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The datasource must adopt the ASCollectionDataSource protocol. The collection view maintains a weak reference to the datasource object.</p> <p>The datasource object is responsible for providing nodes or node creation blocks to the collection view.</p><div class="note"><p><strong>Note:</strong> This is a convenience method which sets the asyncDatasource on the collection node’s collection view.</p></div> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASCollectionNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/setDelegate:" title="setDelegate:"></a> <h3 class="method-title"><code><a href="#//api/name/setDelegate:">– setDelegate:</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Delegate is optional. This includes UIScrollViewDelegate as well as most methods from UICollectionViewDelegate, like willDisplay…</p> </div> <div class="method-subsection method-declaration"><code>- (void)setDelegate:(nullable id<ASPagerDelegate>)<em>delegate</em></code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/delegate" title="delegate"></a> <h3 class="method-title"><code><a href="#//api/name/delegate">– delegate</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>The object that acts as the asynchronous delegate of the collection view</p> </div> <div class="method-subsection method-declaration"><code>- (nullable id<ASPagerDelegate>)delegate</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The delegate must adopt the ASCollectionDelegate protocol. The collection view maintains a weak reference to the delegate object.</p> <p>The delegate object is responsible for providing size constraints for nodes and indicating whether batch fetching should begin.</p><div class="note"><p><strong>Note:</strong> This is a convenience method which sets the asyncDelegate on the collection node’s collection view.</p></div> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASCollectionNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/view" title="view"></a> <h3 class="method-title"><code><a href="#//api/name/view"> view</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>The underlying ASCollectionView object.</p> </div> <div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) ASCollectionView *view</code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/currentPageIndex" title="currentPageIndex"></a> <h3 class="method-title"><code><a href="#//api/name/currentPageIndex"> currentPageIndex</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Returns the current page index</p> </div> <div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readonly) NSInteger currentPageIndex</code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/scrollToPageAtIndex:animated:" title="scrollToPageAtIndex:animated:"></a> <h3 class="method-title"><code><a href="#//api/name/scrollToPageAtIndex:animated:">– scrollToPageAtIndex:animated:</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Scroll the contents of the receiver to ensure that the page is visible</p> </div> <div class="method-subsection method-declaration"><code>- (void)scrollToPageAtIndex:(NSInteger)<em>index</em> animated:(BOOL)<em>animated</em></code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div><div class="section-method"> <a name="//api/name/nodeForPageAtIndex:" title="nodeForPageAtIndex:"></a> <h3 class="method-title"><code><a href="#//api/name/nodeForPageAtIndex:">– nodeForPageAtIndex:</a></code> </h3> <div class="method-info"> <div class="pointy-thing"></div> <div class="method-info-container"> <div class="method-subsection brief-description"> <p>Returns the node for the passed page index</p> </div> <div class="method-subsection method-declaration"><code>- (ASCellNode *)nodeForPageAtIndex:(NSInteger)<em>index</em></code></div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <p><code class="declared-in-ref">ASPagerNode.h</code></p> </div> </div> </div> </div> </div> </div> </main> <footer> <div class="footer-copyright"> <p class="copyright">Copyright © 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p> <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> </div> </div> </article> <script src="../js/script.js"></script> </body> </html>