Files
AsyncDisplayKit/appledoc/Protocols/ASLayoutable.html
2015-07-13 07:44:15 +07:00

471 lines
10 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASLayoutable 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/alignSelf">alignSelf</option>
<option value="//api/name/flexBasis">flexBasis</option>
<option value="//api/name/flexGrow">flexGrow</option>
<option value="//api/name/flexShrink">flexShrink</option>
<option value="//api/name/spacingAfter">spacingAfter</option>
<option value="//api/name/spacingBefore">spacingBefore</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/measureWithSizeRange:">- measureWithSizeRange:</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">ASLayoutable 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>ASLayoutable.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 ASLayoutable protocol declares a method for measuring the layout of an object. A class must implement the method
so that instances of that class can be used to build layout trees. The protocol also provides information
about how an object should be laid out within an ASStackLayoutSpec.</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/spacingBefore" title="spacingBefore"></a>
<h3 class="method-title"><code><a href="#//api/name/spacingBefore">&nbsp;&nbsp;spacingBefore</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>Additional space to place before this object in the stacking direction.
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) CGFloat spacingBefore</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/spacingAfter" title="spacingAfter"></a>
<h3 class="method-title"><code><a href="#//api/name/spacingAfter">&nbsp;&nbsp;spacingAfter</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>Additional space to place after this object in the stacking direction.
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) CGFloat spacingAfter</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/flexGrow" title="flexGrow"></a>
<h3 class="method-title"><code><a href="#//api/name/flexGrow">&nbsp;&nbsp;flexGrow</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>If the sum of childrens' stack dimensions is less than the minimum size, should this object grow?
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) BOOL flexGrow</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/flexShrink" title="flexShrink"></a>
<h3 class="method-title"><code><a href="#//api/name/flexShrink">&nbsp;&nbsp;flexShrink</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>If the sum of childrens' stack dimensions is greater than the maximum size, should this object shrink?
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) BOOL flexShrink</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/flexBasis" title="flexBasis"></a>
<h3 class="method-title"><code><a href="#//api/name/flexBasis">&nbsp;&nbsp;flexBasis</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>Specifies the initial size in the stack dimension for this object.
Default to ASRelativeDimensionUnconstrained.
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) ASRelativeDimension flexBasis</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/alignSelf" title="alignSelf"></a>
<h3 class="method-title"><code><a href="#//api/name/alignSelf">&nbsp;&nbsp;alignSelf</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>Orientation of the object along cross axis, overriding alignItems
Used when attached to a stack layout.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite) ASStackLayoutAlignSelf alignSelf</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/measureWithSizeRange:" title="measureWithSizeRange:"></a>
<h3 class="method-title"><code><a href="#//api/name/measureWithSizeRange:">&ndash;&nbsp;measureWithSizeRange:</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>Calculate a layout based on given size range.</p>
</div>
<div class="method-subsection method-declaration"><code>- (ASLayout *)measureWithSizeRange:(ASSizeRange)<em>constrainedSize</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>constrainedSize</code></th>
<td><p>The minimum and maximum sizes the receiver should fit in.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>An ASLayout instance defining the layout of the receiver and its children.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutable.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-07-13</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>