Files
AsyncDisplayKit/appledoc/Protocols/ASMultiplexImageNodeDelegate.html
2015-01-21 14:34:54 -08:00

665 lines
19 KiB
HTML

<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>ASMultiplexImageNodeDelegate Protocol Reference</title>
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.2 (build 963)" />
</head>
<body>
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AsyncDisplayKit </a></h1>
<a id="developerHome" href="../index.html">Facebook</a>
</div>
<div id="title" role="banner">
<h1 class="hideInXcode">ASMultiplexImageNodeDelegate Protocol Reference</h1>
</div>
<ul id="headerButtons" role="toolbar">
<li id="toc_button">
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
</li>
<li id="jumpto_button" role="navigation">
<select id="jumpTo">
<option value="top">Jump To&#133;</option>
<option value="tasks">Tasks</option>
<option value="instance_methods">Instance Methods</option>
<option value="//api/name/multiplexImageNode:didDisplayUpdatedImage:withIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:didDisplayUpdatedImage:withIdentifier:</option>
<option value="//api/name/multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:</option>
<option value="//api/name/multiplexImageNode:didStartDownloadOfImageWithIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:didStartDownloadOfImageWithIdentifier:</option>
<option value="//api/name/multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:</option>
<option value="//api/name/multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:</option>
<option value="//api/name/multiplexImageNodeDidFinishDisplay:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNodeDidFinishDisplay:</option>
</select>
</li>
</ul>
</header>
<nav id="tocContainer" class="isShowingTOC">
<ul id="toc" role="tree">
<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
</ul></li>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:didDisplayUpdatedImage:withIdentifier:">multiplexImageNode:didDisplayUpdatedImage:withIdentifier:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:">multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:didStartDownloadOfImageWithIdentifier:">multiplexImageNode:didStartDownloadOfImageWithIdentifier:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:">multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:">multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNodeDidFinishDisplay:">multiplexImageNodeDidFinishDisplay:</a></span></li>
</ul></li>
</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="ASMultiplexImageNodeDelegate Protocol Reference" name="top"></a>
<div class="main-navigation navigation-top">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">ASMultiplexImageNodeDelegate Protocol Reference</h1>
</div>
</div>
<div id="container">
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Conforms to</td>
<td class="specification-value">NSObject</td>
</tr><tr>
<td class="specification-title">Declared in</td>
<td class="specification-value">ASMultiplexImageNode.h</td>
</tr>
</tbody></table></div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<h2 class="subtitle subtitle-tasks">Tasks</h2>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:didStartDownloadOfImageWithIdentifier:">&ndash;&nbsp;multiplexImageNode:didStartDownloadOfImageWithIdentifier:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:">&ndash;&nbsp;multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:">&ndash;&nbsp;multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:">&ndash;&nbsp;multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:didDisplayUpdatedImage:withIdentifier:">&ndash;&nbsp;multiplexImageNode:didDisplayUpdatedImage:withIdentifier:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNodeDidFinishDisplay:">&ndash;&nbsp;multiplexImageNodeDidFinishDisplay:</a></code>
</span>
</li>
</ul>
</div>
<div class="section section-methods">
<a title="Instance Methods" name="instance_methods"></a>
<h2 class="subtitle subtitle-methods">Instance Methods</h2>
<div class="section-method">
<a name="//api/name/multiplexImageNode:didDisplayUpdatedImage:withIdentifier:" title="multiplexImageNode:didDisplayUpdatedImage:withIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:didDisplayUpdatedImage:withIdentifier:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node displayed a new image.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNode:(id)<em>imageNode</em> didDisplayUpdatedImage:(id)<em>image</em> withIdentifier:(id)<em>imageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>image</em></dt>
<dd><p>The new image, now being displayed.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>imageIdentifier</em></dt>
<dd><p>The identifier for <code>image</code>.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is only called when <code>image</code> changes, and not on subsequent redisplays of the same image.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:" title="multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:didFinishDownloadingImageWithIdentifier:error:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node&rsquo;s download has finished.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNode:(id)<em>imageNode</em> didFinishDownloadingImageWithIdentifier:(id)<em>imageIdentifier</em> error:(id)<em>error</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>imageIdentifier</em></dt>
<dd><p>The identifier for the image that finished downloading.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>error</em></dt>
<dd><p>The error that occurred while downloading, if one occurred; nil otherwise.</p></dd>
</dl>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/multiplexImageNode:didStartDownloadOfImageWithIdentifier:" title="multiplexImageNode:didStartDownloadOfImageWithIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:didStartDownloadOfImageWithIdentifier:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node began downloading an image.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNode:(id)<em>imageNode</em> didStartDownloadOfImageWithIdentifier:(id)<em>imageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>imageIdentifier</em></dt>
<dd><p>The identifier for the image that is downloading.</p></dd>
</dl>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:" title="multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:didUpdateDownloadProgress:forImageWithIdentifier:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node&rsquo;s download progressed.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNode:(id)<em>imageNode</em> didUpdateDownloadProgress:(id)<em>downloadProgress</em> forImageWithIdentifier:(id)<em>imageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>downloadProgress</em></dt>
<dd><p>The progress of the download. Value is between 0.0 and 1.0.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>imageIdentifier</em></dt>
<dd><p>The identifier for the image that is downloading.</p></dd>
</dl>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:" title="multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:didUpdateImage:withIdentifier:fromImage:withIdentifier:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node&rsquo;s image was updated.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNode:(id)<em>imageNode</em> didUpdateImage:(id)<em>image</em> withIdentifier:(id)<em>imageIdentifier</em> fromImage:(id)<em>previousImage</em> withIdentifier:(id)<em>previousImageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>image</em></dt>
<dd><p>The new image, ready for display.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>imageIdentifier</em></dt>
<dd><p>The identifier for <code>image</code>.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>previousImage</em></dt>
<dd><p>The old, previously-loaded image.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>previousImageIdentifier</em></dt>
<dd><p>The identifier for <code>previousImage</code>.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<div class="note"><p><strong>Note:</strong> This method does not indicate that <code>image</code> has been displayed.</p></div>
</div>
<div class="method-subsection see-also-section">
<h4 class="method-subtitle">See Also</h4>
<ul>
<li><code><p><a href="#//api/name/multiplexImageNode:didDisplayUpdatedImage:withIdentifier:">[ASMultiplexImageNodeDelegate multiplexImageNode:didDisplayUpdatedImage:withIdentifier:]</a>.</p></code></li>
</ul>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/multiplexImageNodeDidFinishDisplay:" title="multiplexImageNodeDidFinishDisplay:"></a>
<h3 class="subsubtitle method-title">multiplexImageNodeDidFinishDisplay:</h3>
<div class="method-subsection brief-description">
<p>Notification that the image node finished displaying an image.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)multiplexImageNodeDidFinishDisplay:(id)<em>imageNode</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>imageNode</em></dt>
<dd><p>The sender.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is called every time an image is displayed, whether or not it has changed.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">ASMultiplexImageNode.h</code><br />
</div>
</div>
</div>
</div>
<div class="main-navigation navigation-bottom">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2015 Facebook. All rights reserved. (Last updated: 2015-01-21)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 963)</a>.</span></p>
</div>
</div>
</div>
</article>
<script type="text/javascript">
function jumpToChange()
{
window.location.hash = this.options[this.selectedIndex].value;
}
function toggleTOC()
{
var contents = document.getElementById('contents');
var tocContainer = document.getElementById('tocContainer');
if (this.getAttribute('class') == 'open')
{
this.setAttribute('class', '');
contents.setAttribute('class', '');
tocContainer.setAttribute('class', '');
window.name = "hideTOC";
}
else
{
this.setAttribute('class', 'open');
contents.setAttribute('class', 'isShowingTOC');
tocContainer.setAttribute('class', 'isShowingTOC');
window.name = "";
}
return false;
}
function toggleTOCEntryChildren(e)
{
e.stopPropagation();
var currentClass = this.getAttribute('class');
if (currentClass == 'children') {
this.setAttribute('class', 'children open');
}
else if (currentClass == 'children open') {
this.setAttribute('class', 'children');
}
return false;
}
function tocEntryClick(e)
{
e.stopPropagation();
return true;
}
function init()
{
var selectElement = document.getElementById('jumpTo');
selectElement.addEventListener('change', jumpToChange, false);
var tocButton = document.getElementById('table_of_contents');
tocButton.addEventListener('click', toggleTOC, false);
var taskTreeItem = document.getElementById('task_treeitem');
if (taskTreeItem.getElementsByTagName('li').length > 0)
{
taskTreeItem.setAttribute('class', 'children');
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
}
var tocList = document.getElementById('toc');
var tocEntries = tocList.getElementsByTagName('li');
for (var i = 0; i < tocEntries.length; i++) {
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
}
var tocLinks = tocList.getElementsByTagName('a');
for (var i = 0; i < tocLinks.length; i++) {
tocLinks[i].addEventListener('click', tocEntryClick, false);
}
if (window.name == "hideTOC") {
toggleTOC.call(tocButton);
}
}
window.onload = init;
// If showing in Xcode, hide the TOC and Header
if (navigator.userAgent.match(/xcode/i)) {
document.getElementById("contents").className = "hideInXcode"
document.getElementById("tocContainer").className = "hideInXcode"
document.getElementById("top_header").className = "hideInXcode"
}
</script>
</body>
</html>