Files
AsyncDisplayKit/appledoc/Protocols/ASMultiplexImageNodeDataSource.html
2014-12-03 18:18:07 -08:00

394 lines
11 KiB
HTML

<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>ASMultiplexImageNodeDataSource 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">ASMultiplexImageNodeDataSource 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:URLForImageIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:URLForImageIdentifier:</option>
<option value="//api/name/multiplexImageNode:imageForImageIdentifier:">&nbsp;&nbsp;&nbsp;&nbsp;- multiplexImageNode:imageForImageIdentifier:</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:URLForImageIdentifier:">multiplexImageNode:URLForImageIdentifier:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/multiplexImageNode:imageForImageIdentifier:">multiplexImageNode:imageForImageIdentifier:</a></span></li>
</ul></li>
</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="ASMultiplexImageNodeDataSource 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">ASMultiplexImageNodeDataSource 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:imageForImageIdentifier:">&ndash;&nbsp;multiplexImageNode:imageForImageIdentifier:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/multiplexImageNode:URLForImageIdentifier:">&ndash;&nbsp;multiplexImageNode:URLForImageIdentifier:</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:URLForImageIdentifier:" title="multiplexImageNode:URLForImageIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:URLForImageIdentifier:</h3>
<div class="method-subsection brief-description">
<p>An image URL for the specified identifier.</p>
</div>
<div class="method-subsection method-declaration"><code>- (NSURL *)multiplexImageNode:(id)<em>imageNode</em> URLForImageIdentifier:(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 will be downloaded.</p></dd>
</dl>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>An NSURL for the image identified by <code>imageIdentifier</code>, or nil if none is available.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Supported URLs include assets-library, Photo framework URLs (ph://), HTTP, HTTPS, and FTP URLs. If the
image is already available to the data source, it should be provided via <a href="#//api/name/multiplexImageNode:imageForImageIdentifier:">[ASMultiplexImageNodeDataSource multiplexImageNode:imageForImageIdentifier:]</a> instead.</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:imageForImageIdentifier:" title="multiplexImageNode:imageForImageIdentifier:"></a>
<h3 class="subsubtitle method-title">multiplexImageNode:imageForImageIdentifier:</h3>
<div class="method-subsection brief-description">
<p>An image for the specified identifier.</p>
</div>
<div class="method-subsection method-declaration"><code>- (UIImage *)multiplexImageNode:(id)<em>imageNode</em> imageForImageIdentifier:(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 should be returned.</p></dd>
</dl>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>A UIImage corresponding to <code>imageIdentifier</code>, or nil if none is available.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If the image is already available to the data source, this method should be used in lieu of providing the
URL to the image via -multiplexImageNode:URLForImageIdentifier:.</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; 2014 Facebook. All rights reserved. (Last updated: 2014-12-03)</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>