Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / subsampling-scale-image-view / 4159b9ea860ab3deec08f511deb71f4f599924aa / . / docs / javadoc / com / davemorrissey / labs / subscaleview / SubsamplingScaleImageView.AnimationBuilder.html
blob: 37c7b876b9a5cfe20acac32cd3f6d8f41a91017e [file] [log] [blame]
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
David Morrissey3b0a9d12017-12-03 09:13:27 +0000[diff] [blame]5<!-- Generated by javadoc -->
David Morrisseydea2a392017-12-02 08:46:32 +0000[diff] [blame]6<title>SubsamplingScaleImageView.AnimationBuilder (library 3.9.0 API)</title>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]7<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
8<script type="text/javascript" src="../../../../script.js"></script>
9</head>
10<body>
11<script type="text/javascript"><!--
12 try {
13 if (location.href.indexOf('is-external=true') == -1) {
David Morrisseydea2a392017-12-02 08:46:32 +0000[diff] [blame]14 parent.document.title="SubsamplingScaleImageView.AnimationBuilder (library 3.9.0 API)";
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]15 }
16 }
17 catch(err) {
18 }
19//-->
20var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
21var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
22var altColor = "altColor";
23var rowColor = "rowColor";
24var tableTab = "tableTab";
25var activeTableTab = "activeTableTab";
26</script>
27<noscript>
28<div>JavaScript is disabled on your browser.</div>
29</noscript>
30<!-- ========= START OF TOP NAVBAR ======= -->
31<div class="topNav"><a name="navbar.top">
32<!-- -->
33</a>
34<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
35<a name="navbar.top.firstrow">
36<!-- -->
37</a>
38<ul class="navList" title="Navigation">
39<li><a href="../../../../overview-summary.html">Overview</a></li>
40<li><a href="package-summary.html">Package</a></li>
41<li class="navBarCell1Rev">Class</li>
42<li><a href="package-tree.html">Tree</a></li>
43<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
44<li><a href="../../../../index-all.html">Index</a></li>
45<li><a href="../../../../help-doc.html">Help</a></li>
46</ul>
47</div>
48<div class="subNav">
49<ul class="navList">
50<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html" title="class in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
51<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.DefaultOnAnimationEventListener.html" title="class in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
52</ul>
53<ul class="navList">
54<li><a href="../../../../index.html?com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" target="_top">Frames</a></li>
55<li><a href="SubsamplingScaleImageView.AnimationBuilder.html" target="_top">No&nbsp;Frames</a></li>
56</ul>
57<ul class="navList" id="allclasses_navbar_top">
58<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
59</ul>
60<div>
61<script type="text/javascript"><!--
62 allClassesLink = document.getElementById("allclasses_navbar_top");
63 if(window==top) {
64 allClassesLink.style.display = "block";
65 }
66 else {
67 allClassesLink.style.display = "none";
68 }
69 //-->
70</script>
71</div>
72<div>
73<ul class="subNavList">
74<li>Summary:&nbsp;</li>
75<li>Nested&nbsp;|&nbsp;</li>
76<li>Field&nbsp;|&nbsp;</li>
77<li>Constr&nbsp;|&nbsp;</li>
78<li><a href="#method.summary">Method</a></li>
79</ul>
80<ul class="subNavList">
81<li>Detail:&nbsp;</li>
82<li>Field&nbsp;|&nbsp;</li>
83<li>Constr&nbsp;|&nbsp;</li>
84<li><a href="#method.detail">Method</a></li>
85</ul>
86</div>
87<a name="skip.navbar.top">
88<!-- -->
89</a></div>
90<!-- ========= END OF TOP NAVBAR ========= -->
91<!-- ======== START OF CLASS DATA ======== -->
92<div class="header">
93<div class="subTitle">com.davemorrissey.labs.subscaleview</div>
94<h2 title="Class SubsamplingScaleImageView.AnimationBuilder" class="title">Class SubsamplingScaleImageView.AnimationBuilder</h2>
95</div>
96<div class="contentContainer">
97<ul class="inheritance">
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]98<li><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]99<li>
100<ul class="inheritance">
101<li>com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView.AnimationBuilder</li>
102</ul>
103</li>
104</ul>
105<div class="description">
106<ul class="blockList">
107<li class="blockList">
108<dl>
109<dt>Enclosing class:</dt>
110<dd><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView</a></dd>
111</dl>
112<hr>
113<br>
114<pre>public final class <span class="typeNameLabel">SubsamplingScaleImageView.AnimationBuilder</span>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]115extends <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]116<div class="block">Builder class used to set additional options for a scale animation. Create an instance using <a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html#animateScale-float-"><code>SubsamplingScaleImageView.animateScale(float)</code></a>,
117 then set your options and call <a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#start--"><code>start()</code></a>.</div>
118</li>
119</ul>
120</div>
121<div class="summary">
122<ul class="blockList">
123<li class="blockList">
124<!-- ========== METHOD SUMMARY =========== -->
125<ul class="blockList">
126<li class="blockList"><a name="method.summary">
127<!-- -->
128</a>
129<h3>Method Summary</h3>
130<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
131<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
132<tr>
133<th class="colFirst" scope="col">Modifier and Type</th>
134<th class="colLast" scope="col">Method and Description</th>
135</tr>
136<tr id="i0" class="altColor">
137<td class="colFirst"><code>void</code></td>
138<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#start--">start</a></span>()</code>
139<div class="block">Starts the animation.</div>
140</td>
141</tr>
142<tr id="i1" class="rowColor">
143<td class="colFirst"><code><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a></code></td>
144<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#withDuration-long-">withDuration</a></span>(long&nbsp;duration)</code>
145<div class="block">Desired duration of the anim in milliseconds.</div>
146</td>
147</tr>
148<tr id="i2" class="altColor">
149<td class="colFirst"><code><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a></code></td>
150<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#withEasing-int-">withEasing</a></span>(int&nbsp;easing)</code>
151<div class="block">Set the easing style.</div>
152</td>
153</tr>
154<tr id="i3" class="rowColor">
155<td class="colFirst"><code><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a></code></td>
156<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#withInterruptible-boolean-">withInterruptible</a></span>(boolean&nbsp;interruptible)</code>
157<div class="block">Whether the animation can be interrupted with a touch.</div>
158</td>
159</tr>
160<tr id="i4" class="altColor">
161<td class="colFirst"><code><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a></code></td>
162<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html#withOnAnimationEventListener-com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView.OnAnimationEventListener-">withOnAnimationEventListener</a></span>(<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnAnimationEventListener.html" title="interface in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.OnAnimationEventListener</a>&nbsp;listener)</code>
163<div class="block">Add an animation event listener.</div>
164</td>
165</tr>
166</table>
167<ul class="blockList">
168<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
169<!-- -->
170</a>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]171<h3>Methods inherited from class&nbsp;java.lang.<a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
172<code><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]173</ul>
174</li>
175</ul>
176</li>
177</ul>
178</div>
179<div class="details">
180<ul class="blockList">
181<li class="blockList">
182<!-- ============ METHOD DETAIL ========== -->
183<ul class="blockList">
184<li class="blockList"><a name="method.detail">
185<!-- -->
186</a>
187<h3>Method Detail</h3>
188<a name="withDuration-long-">
189<!-- -->
190</a>
191<ul class="blockList">
192<li class="blockList">
193<h4>withDuration</h4>
194<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a>&nbsp;withDuration(long&nbsp;duration)</pre>
195<div class="block">Desired duration of the anim in milliseconds. Default is 500.</div>
196<dl>
197<dt><span class="paramLabel">Parameters:</span></dt>
198<dd><code>duration</code> - duration in milliseconds.</dd>
199<dt><span class="returnLabel">Returns:</span></dt>
200<dd>this builder for method chaining.</dd>
201</dl>
202</li>
203</ul>
204<a name="withInterruptible-boolean-">
205<!-- -->
206</a>
207<ul class="blockList">
208<li class="blockList">
209<h4>withInterruptible</h4>
210<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a>&nbsp;withInterruptible(boolean&nbsp;interruptible)</pre>
211<div class="block">Whether the animation can be interrupted with a touch. Default is true.</div>
212<dl>
213<dt><span class="paramLabel">Parameters:</span></dt>
214<dd><code>interruptible</code> - interruptible flag.</dd>
215<dt><span class="returnLabel">Returns:</span></dt>
216<dd>this builder for method chaining.</dd>
217</dl>
218</li>
219</ul>
220<a name="withEasing-int-">
221<!-- -->
222</a>
223<ul class="blockList">
224<li class="blockList">
225<h4>withEasing</h4>
226<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a>&nbsp;withEasing(int&nbsp;easing)</pre>
227<div class="block">Set the easing style. See static fields. <a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html#EASE_IN_OUT_QUAD"><code>SubsamplingScaleImageView.EASE_IN_OUT_QUAD</code></a> is recommended, and the default.</div>
228<dl>
229<dt><span class="paramLabel">Parameters:</span></dt>
230<dd><code>easing</code> - easing style.</dd>
231<dt><span class="returnLabel">Returns:</span></dt>
232<dd>this builder for method chaining.</dd>
233</dl>
234</li>
235</ul>
236<a name="withOnAnimationEventListener-com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView.OnAnimationEventListener-">
237<!-- -->
238</a>
239<ul class="blockList">
240<li class="blockList">
241<h4>withOnAnimationEventListener</h4>
242<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.AnimationBuilder</a>&nbsp;withOnAnimationEventListener(<a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnAnimationEventListener.html" title="interface in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.OnAnimationEventListener</a>&nbsp;listener)</pre>
243<div class="block">Add an animation event listener.</div>
244<dl>
245<dt><span class="paramLabel">Parameters:</span></dt>
246<dd><code>listener</code> - The listener.</dd>
247<dt><span class="returnLabel">Returns:</span></dt>
248<dd>this builder for method chaining.</dd>
249</dl>
250</li>
251</ul>
252<a name="start--">
253<!-- -->
254</a>
255<ul class="blockListLast">
256<li class="blockList">
257<h4>start</h4>
258<pre>public&nbsp;void&nbsp;start()</pre>
259<div class="block">Starts the animation.</div>
260</li>
261</ul>
262</li>
263</ul>
264</li>
265</ul>
266</div>
267</div>
268<!-- ========= END OF CLASS DATA ========= -->
269<!-- ======= START OF BOTTOM NAVBAR ====== -->
270<div class="bottomNav"><a name="navbar.bottom">
271<!-- -->
272</a>
273<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
274<a name="navbar.bottom.firstrow">
275<!-- -->
276</a>
277<ul class="navList" title="Navigation">
278<li><a href="../../../../overview-summary.html">Overview</a></li>
279<li><a href="package-summary.html">Package</a></li>
280<li class="navBarCell1Rev">Class</li>
281<li><a href="package-tree.html">Tree</a></li>
282<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
283<li><a href="../../../../index-all.html">Index</a></li>
284<li><a href="../../../../help-doc.html">Help</a></li>
285</ul>
286</div>
287<div class="subNav">
288<ul class="navList">
289<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html" title="class in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
290<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.DefaultOnAnimationEventListener.html" title="class in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
291</ul>
292<ul class="navList">
293<li><a href="../../../../index.html?com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.AnimationBuilder.html" target="_top">Frames</a></li>
294<li><a href="SubsamplingScaleImageView.AnimationBuilder.html" target="_top">No&nbsp;Frames</a></li>
295</ul>
296<ul class="navList" id="allclasses_navbar_bottom">
297<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
298</ul>
299<div>
300<script type="text/javascript"><!--
301 allClassesLink = document.getElementById("allclasses_navbar_bottom");
302 if(window==top) {
303 allClassesLink.style.display = "block";
304 }
305 else {
306 allClassesLink.style.display = "none";
307 }
308 //-->
309</script>
310</div>
311<div>
312<ul class="subNavList">
313<li>Summary:&nbsp;</li>
314<li>Nested&nbsp;|&nbsp;</li>
315<li>Field&nbsp;|&nbsp;</li>
316<li>Constr&nbsp;|&nbsp;</li>
317<li><a href="#method.summary">Method</a></li>
318</ul>
319<ul class="subNavList">
320<li>Detail:&nbsp;</li>
321<li>Field&nbsp;|&nbsp;</li>
322<li>Constr&nbsp;|&nbsp;</li>
323<li><a href="#method.detail">Method</a></li>
324</ul>
325</div>
326<a name="skip.navbar.bottom">
327<!-- -->
328</a></div>
329<!-- ======== END OF BOTTOM NAVBAR ======= -->
330</body>
331</html>