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

286 lines
6.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASLayoutablePrivate 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="Properties">
<option value="//api/name/isFinalLayoutable">isFinalLayoutable</option>
<option value="//api/name/layoutOptions">layoutOptions</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/finalLayoutable">- finalLayoutable</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">ASLayoutablePrivate Protocol Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Conforms to</th>
<td>NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASLayoutablePrivate.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>The base protocol for ASLayoutable. Generally the methods/properties in this class do not need to be
called by the end user and are only called internally. However, there may be a case where the methods are useful.</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/finalLayoutable" title="finalLayoutable"></a>
<h3 class="method-title"><code><a href="#//api/name/finalLayoutable">&ndash;&nbsp;finalLayoutable</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This method can be used to give the user a chance to wrap an ASLayoutable in an ASLayoutSpec
just before it is added to a parent ASLayoutSpec. For example, if you wanted an ASTextNode that was always
inside of an ASInsetLayoutSpec, you could subclass ASTextNode and implement finalLayoutable so that it wraps
itself in an inset spec.</p>
<p>Note that any ASLayoutable other than self that is returned MUST set isFinalLayoutable to YES. Make sure
to do this BEFORE adding a child to the ASLayoutable.</p>
</div>
<div class="method-subsection method-declaration"><code>- (id&lt;ASLayoutable&gt;)finalLayoutable</code></div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>The layoutable that will be added to the parent layout spec. Defaults to self.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutablePrivate.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/isFinalLayoutable" title="isFinalLayoutable"></a>
<h3 class="method-title"><code><a href="#//api/name/isFinalLayoutable">&nbsp;&nbsp;isFinalLayoutable</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>A flag to indicate that this ASLayoutable was created in finalLayoutable. This MUST be set to YES
before adding a child to this layoutable.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL isFinalLayoutable</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutablePrivate.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/layoutOptions" title="layoutOptions"></a>
<h3 class="method-title"><code><a href="#//api/name/layoutOptions">&nbsp;&nbsp;layoutOptions</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The class that holds all of the layoutOptions set on an ASLayoutable.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, readonly) ASLayoutOptions *layoutOptions</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutablePrivate.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>