-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNIActions.html
158 lines (158 loc) · 13.4 KB
/
NIActions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6-nimbuskit"/>
<title>NimbusKit: NIActions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="appledocs.css" rel="stylesheet" type="text/css"/>
<link href="nimbuskit.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_setDomainName', 'nimbuskit.info']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<a href="index.html"><img style="float:left" src="nimbus128.png" width="80" height="80" /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">NimbusKit
 <span id="projectnumber">1.2.1 - <a href="http://github.com/jverkoey/nimbus">Fork Nimbus on Github</a> - <a href="http://wiki.nimbuskit.info/">Visit the Nimbus Wiki</a></span>
</div>
<div id="projectbrief">The iOS framework that grows only as fast as its documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6-nimbuskit -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('NIActions.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classNIActions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NIActions Class Reference<div class="ingroups"><a class="el" href="Actions.html">Actions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>The <a class="el" href="NIActions.html" title="The NIActions class provides a generic interface for attaching actions to objects. ">NIActions</a> class provides a generic interface for attaching actions to objects. </p>
<p><a class="el" href="NIActions.html" title="The NIActions class provides a generic interface for attaching actions to objects. ">NIActions</a> are used to implement user interaction in UITableViews and UICollectionViews via the corresponding classes (<a class="el" href="NITableViewActions.html" title="The NITableViewActions class provides an interface for attaching actions to objects in a NITableViewM...">NITableViewActions</a> and <a class="el" href="NICollectionViewActions.html" title="The NICollectionViewActions class provides an interface for attaching actions to objects in a NIColle...">NICollectionViewActions</a>) in the respective feature. <a class="el" href="NIActions.html" title="The NIActions class provides a generic interface for attaching actions to objects. ">NIActions</a> separates the necessity</p>
<h3>Types of Actions</h3>
<p>The three primary types of actions are:</p>
<ul>
<li>buttons,</li>
<li>detail views,</li>
<li>and pushing a new controller onto the navigation controller.</li>
</ul>
<h3>Attaching Actions</h3>
<p>Actions may be attached to specific instances of objects or to entire classes of objects. When an action is attached to both a class of object and an instance of that class, only the instance action should be executed.</p>
<p>All attachment methods return the object that was provided. This makes it simple to attach actions within an array creation statement.</p>
<p>Actions come in two forms: blocks and selector invocations. Both can be attached to an object for each type of action and both will be executed, with the block being executed first. Blocks should be used for simple executions while selectors should be used when the action is complex.</p>
<p>The following is an example of using <a class="el" href="NITableViewActions.html" title="The NITableViewActions class provides an interface for attaching actions to objects in a NITableViewM...">NITableViewActions</a>:</p>
<div class="fragment"><div class="line">NSArray *objects = @[</div>
<div class="line"> [<a class="code" href="NITitleCellObject.html">NITitleCellObject</a> objectWithTitle:<span class="stringliteral">@"Implicit tap handler"</span>],</div>
<div class="line"> [<span class="keyword">self</span>.actions attachToObject:[<a class="code" href="NITitleCellObject.html">NITitleCellObject</a> objectWithTitle:<span class="stringliteral">@"Explicit tap handler"</span>]</div>
<div class="line"> tapBlock:</div>
<div class="line"> ^BOOL(<span class="keywordtype">id</span> <span class="keywordtype">object</span>, <span class="keywordtype">id</span> target) {</div>
<div class="line"> NSLog(<span class="stringliteral">@"Object was tapped with an explicit action: %@"</span>, <span class="keywordtype">object</span>);</div>
<div class="line"> }]</div>
<div class="line">];</div>
<div class="line"></div>
<div class="line">[<span class="keyword">self</span>.actions attachToClass:[<a class="code" href="NITitleCellObject.html">NITitleCellObject</a> <span class="keyword">class</span>]</div>
<div class="line"> tapBlock:</div>
<div class="line"> ^BOOL(<span class="keywordtype">id</span> <span class="keywordtype">object</span>, <span class="keywordtype">id</span> target) {</div>
<div class="line"> NSLog(<span class="stringliteral">@"Object was tapped: %@"</span>, <span class="keywordtype">object</span>);</div>
<div class="line"> }];</div>
</div><!-- fragment --> </div><div class="dynheader">
Inheritance diagram for NIActions:</div>
<div class="dyncontent">
<div class="center">
<img src="NIActions.png" usemap="#NIActions_map" alt=""/>
<map id="NIActions_map" name="NIActions_map">
<area href="NICollectionViewActions.html" title="The NICollectionViewActions class provides an interface for attaching actions to objects in a NIColle..." alt="NICollectionViewActions" shape="rect" coords="0,56,150,80"/>
<area href="NITableViewActions.html" title="The NITableViewActions class provides an interface for attaching actions to objects in a NITableViewM..." alt="NITableViewActions" shape="rect" coords="160,56,310,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Tasks</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creating Table View Actions</div></td></tr>
<tr class="memitem:ginitWithTarget:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#ginitWithTarget:">initWithTarget:</a></td></tr>
<tr class="separator:ginitWithTarget:"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Mapping Objects</div></td></tr>
<tr class="memitem:gattachToObject:tapBlock:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:tapBlock:">attachToObject:tapBlock:</a></td></tr>
<tr class="separator:gattachToObject:tapBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToObject:detailBlock:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:detailBlock:">attachToObject:detailBlock:</a></td></tr>
<tr class="separator:gattachToObject:detailBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToObject:navigationBlock:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:navigationBlock:">attachToObject:navigationBlock:</a></td></tr>
<tr class="separator:gattachToObject:navigationBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToObject:tapSelector:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:tapSelector:">attachToObject:tapSelector:</a></td></tr>
<tr class="separator:gattachToObject:tapSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToObject:detailSelector:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:detailSelector:">attachToObject:detailSelector:</a></td></tr>
<tr class="separator:gattachToObject:detailSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToObject:navigationSelector:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToObject:navigationSelector:">attachToObject:navigationSelector:</a></td></tr>
<tr class="separator:gattachToObject:navigationSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Mapping Classes</div></td></tr>
<tr class="memitem:gattachToClass:tapBlock:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:tapBlock:">attachToClass:tapBlock:</a></td></tr>
<tr class="separator:gattachToClass:tapBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToClass:detailBlock:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:detailBlock:">attachToClass:detailBlock:</a></td></tr>
<tr class="separator:gattachToClass:detailBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToClass:navigationBlock:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:navigationBlock:">attachToClass:navigationBlock:</a></td></tr>
<tr class="separator:gattachToClass:navigationBlock:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToClass:tapSelector:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:tapSelector:">attachToClass:tapSelector:</a></td></tr>
<tr class="separator:gattachToClass:tapSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToClass:detailSelector:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:detailSelector:">attachToClass:detailSelector:</a></td></tr>
<tr class="separator:gattachToClass:detailSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gattachToClass:navigationSelector:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gattachToClass:navigationSelector:">attachToClass:navigationSelector:</a></td></tr>
<tr class="separator:gattachToClass:navigationSelector:"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Object State</div></td></tr>
<tr class="memitem:gisObjectActionable:"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="Actions.html#gisObjectActionable:">isObjectActionable:</a></td></tr>
<tr class="separator:gisObjectActionable:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gobjectFromKeyClass:map:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="Actions.html#gobjectFromKeyClass:map:">objectFromKeyClass:map:</a></td></tr>
<tr class="separator:gobjectFromKeyClass:map:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<script type="text/javascript" src="widget.js"></script>
</body>
</html>