Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / subsampling-scale-image-view / 45ca08280baebd7342764bdbc9b520d7183d6ad7 / . / docs / javadoc / com / davemorrissey / labs / subscaleview / SubsamplingScaleImageView.OnImageEventListener.html
blob: dba187f355c963ba8473e9123dec291404221a10 [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.OnImageEventListener (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.OnImageEventListener (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":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
21var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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.OnAnimationEventListener.html" title="interface in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
51<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnStateChangedListener.html" title="interface 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.OnImageEventListener.html" target="_top">Frames</a></li>
55<li><a href="SubsamplingScaleImageView.OnImageEventListener.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="Interface SubsamplingScaleImageView.OnImageEventListener" class="title">Interface SubsamplingScaleImageView.OnImageEventListener</h2>
95</div>
96<div class="contentContainer">
97<div class="description">
98<ul class="blockList">
99<li class="blockList">
100<dl>
101<dt>All Known Implementing Classes:</dt>
102<dd><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.DefaultOnImageEventListener.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.DefaultOnImageEventListener</a></dd>
103</dl>
104<dl>
105<dt>Enclosing class:</dt>
106<dd><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView</a></dd>
107</dl>
108<hr>
109<br>
110<pre>public static interface <span class="typeNameLabel">SubsamplingScaleImageView.OnImageEventListener</span></pre>
111<div class="block">An event listener, allowing subclasses and activities to be notified of significant events.</div>
112</li>
113</ul>
114</div>
115<div class="summary">
116<ul class="blockList">
117<li class="blockList">
118<!-- ========== METHOD SUMMARY =========== -->
119<ul class="blockList">
120<li class="blockList"><a name="method.summary">
121<!-- -->
122</a>
123<h3>Method Summary</h3>
124<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
125<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
126<tr>
127<th class="colFirst" scope="col">Modifier and Type</th>
128<th class="colLast" scope="col">Method and Description</th>
129</tr>
130<tr id="i0" class="altColor">
131<td class="colFirst"><code>void</code></td>
132<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onImageLoaded--">onImageLoaded</a></span>()</code>
133<div class="block">Called when the full size image is ready.</div>
134</td>
135</tr>
136<tr id="i1" class="rowColor">
137<td class="colFirst"><code>void</code></td>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]138<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onImageLoadError-java.lang.Exception-">onImageLoadError</a></span>(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</code>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]139<div class="block">Indicates an error initiliasing the decoder when using a tiling, or when loading the full
140 size bitmap when tiling is disabled.</div>
141</td>
142</tr>
143<tr id="i2" class="altColor">
144<td class="colFirst"><code>void</code></td>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]145<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onPreviewLoadError-java.lang.Exception-">onPreviewLoadError</a></span>(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</code>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]146<div class="block">Called when a preview image could not be loaded.</div>
147</td>
148</tr>
149<tr id="i3" class="rowColor">
150<td class="colFirst"><code>void</code></td>
151<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onPreviewReleased--">onPreviewReleased</a></span>()</code>
152<div class="block">Called when a bitmap set using ImageSource.cachedBitmap is no longer being used by the View.</div>
153</td>
154</tr>
155<tr id="i4" class="altColor">
156<td class="colFirst"><code>void</code></td>
157<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onReady--">onReady</a></span>()</code>
158<div class="block">Called when the dimensions of the image and view are known, and either a preview image,
159 the full size image, or base layer tiles are loaded.</div>
160</td>
161</tr>
162<tr id="i5" class="rowColor">
163<td class="colFirst"><code>void</code></td>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]164<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onTileLoadError-java.lang.Exception-">onTileLoadError</a></span>(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</code>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]165<div class="block">Called when an image tile could not be loaded.</div>
166</td>
167</tr>
168</table>
169</li>
170</ul>
171</li>
172</ul>
173</div>
174<div class="details">
175<ul class="blockList">
176<li class="blockList">
177<!-- ============ METHOD DETAIL ========== -->
178<ul class="blockList">
179<li class="blockList"><a name="method.detail">
180<!-- -->
181</a>
182<h3>Method Detail</h3>
183<a name="onReady--">
184<!-- -->
185</a>
186<ul class="blockList">
187<li class="blockList">
188<h4>onReady</h4>
189<pre>void&nbsp;onReady()</pre>
190<div class="block">Called when the dimensions of the image and view are known, and either a preview image,
191 the full size image, or base layer tiles are loaded. This indicates the scale and translate
192 are known and the next draw will display an image. This event can be used to hide a loading
193 graphic, or inform a subclass that it is safe to draw overlays.</div>
194</li>
195</ul>
196<a name="onImageLoaded--">
197<!-- -->
198</a>
199<ul class="blockList">
200<li class="blockList">
201<h4>onImageLoaded</h4>
202<pre>void&nbsp;onImageLoaded()</pre>
203<div class="block">Called when the full size image is ready. When using tiling, this means the lowest resolution
204 base layer of tiles are loaded, and when tiling is disabled, the image bitmap is loaded.
205 This event could be used as a trigger to enable gestures if you wanted interaction disabled
206 while only a preview is displayed, otherwise for most cases <a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onReady--"><code>onReady()</code></a> is the best
207 event to listen to.</div>
208</li>
209</ul>
210<a name="onPreviewLoadError-java.lang.Exception-">
211<!-- -->
212</a>
213<ul class="blockList">
214<li class="blockList">
215<h4>onPreviewLoadError</h4>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]216<pre>void&nbsp;onPreviewLoadError(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</pre>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]217<div class="block">Called when a preview image could not be loaded. This method cannot be relied upon; certain
218 encoding types of supported image formats can result in corrupt or blank images being loaded
219 and displayed with no detectable error. The view will continue to load the full size image.</div>
220<dl>
221<dt><span class="paramLabel">Parameters:</span></dt>
222<dd><code>e</code> - The exception thrown. This error is logged by the view.</dd>
223</dl>
224</li>
225</ul>
226<a name="onImageLoadError-java.lang.Exception-">
227<!-- -->
228</a>
229<ul class="blockList">
230<li class="blockList">
231<h4>onImageLoadError</h4>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]232<pre>void&nbsp;onImageLoadError(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</pre>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]233<div class="block">Indicates an error initiliasing the decoder when using a tiling, or when loading the full
234 size bitmap when tiling is disabled. This method cannot be relied upon; certain encoding
235 types of supported image formats can result in corrupt or blank images being loaded and
236 displayed with no detectable error.</div>
237<dl>
238<dt><span class="paramLabel">Parameters:</span></dt>
239<dd><code>e</code> - The exception thrown. This error is also logged by the view.</dd>
240</dl>
241</li>
242</ul>
243<a name="onTileLoadError-java.lang.Exception-">
244<!-- -->
245</a>
246<ul class="blockList">
247<li class="blockList">
248<h4>onTileLoadError</h4>
David Morrisseyfed3d782017-12-04 08:03:42 +0000[diff] [blame]249<pre>void&nbsp;onTileLoadError(<a href="https://developer.android.com/reference/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</pre>
David Morrisseyd94cb882017-11-16 14:55:41 +0000[diff] [blame]250<div class="block">Called when an image tile could not be loaded. This method cannot be relied upon; certain
251 encoding types of supported image formats can result in corrupt or blank images being loaded
252 and displayed with no detectable error. Most cases where an unsupported file is used will
253 result in an error caught by <a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html#onImageLoadError-java.lang.Exception-"><code>onImageLoadError(Exception)</code></a>.</div>
254<dl>
255<dt><span class="paramLabel">Parameters:</span></dt>
256<dd><code>e</code> - The exception thrown. This error is logged by the view.</dd>
257</dl>
258</li>
259</ul>
260<a name="onPreviewReleased--">
261<!-- -->
262</a>
263<ul class="blockListLast">
264<li class="blockList">
265<h4>onPreviewReleased</h4>
266<pre>void&nbsp;onPreviewReleased()</pre>
267<div class="block">Called when a bitmap set using ImageSource.cachedBitmap is no longer being used by the View.
268 This is useful if you wish to manage the bitmap after the preview is shown</div>
269</li>
270</ul>
271</li>
272</ul>
273</li>
274</ul>
275</div>
276</div>
277<!-- ========= END OF CLASS DATA ========= -->
278<!-- ======= START OF BOTTOM NAVBAR ====== -->
279<div class="bottomNav"><a name="navbar.bottom">
280<!-- -->
281</a>
282<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
283<a name="navbar.bottom.firstrow">
284<!-- -->
285</a>
286<ul class="navList" title="Navigation">
287<li><a href="../../../../overview-summary.html">Overview</a></li>
288<li><a href="package-summary.html">Package</a></li>
289<li class="navBarCell1Rev">Class</li>
290<li><a href="package-tree.html">Tree</a></li>
291<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
292<li><a href="../../../../index-all.html">Index</a></li>
293<li><a href="../../../../help-doc.html">Help</a></li>
294</ul>
295</div>
296<div class="subNav">
297<ul class="navList">
298<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnAnimationEventListener.html" title="interface in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
299<li><a href="../../../../com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnStateChangedListener.html" title="interface in com.davemorrissey.labs.subscaleview"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
300</ul>
301<ul class="navList">
302<li><a href="../../../../index.html?com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.OnImageEventListener.html" target="_top">Frames</a></li>
303<li><a href="SubsamplingScaleImageView.OnImageEventListener.html" target="_top">No&nbsp;Frames</a></li>
304</ul>
305<ul class="navList" id="allclasses_navbar_bottom">
306<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
307</ul>
308<div>
309<script type="text/javascript"><!--
310 allClassesLink = document.getElementById("allclasses_navbar_bottom");
311 if(window==top) {
312 allClassesLink.style.display = "block";
313 }
314 else {
315 allClassesLink.style.display = "none";
316 }
317 //-->
318</script>
319</div>
320<div>
321<ul class="subNavList">
322<li>Summary:&nbsp;</li>
323<li>Nested&nbsp;|&nbsp;</li>
324<li>Field&nbsp;|&nbsp;</li>
325<li>Constr&nbsp;|&nbsp;</li>
326<li><a href="#method.summary">Method</a></li>
327</ul>
328<ul class="subNavList">
329<li>Detail:&nbsp;</li>
330<li>Field&nbsp;|&nbsp;</li>
331<li>Constr&nbsp;|&nbsp;</li>
332<li><a href="#method.detail">Method</a></li>
333</ul>
334</div>
335<a name="skip.navbar.bottom">
336<!-- -->
337</a></div>
338<!-- ======== END OF BOTTOM NAVBAR ======= -->
339</body>
340</html>