|
| 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> |
| 5 | +<!-- Generated by javadoc --> |
| 6 | +<title>OverlaySupport</title> |
| 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) { |
| 14 | + parent.document.title="OverlaySupport"; |
| 15 | + } |
| 16 | + } |
| 17 | + catch(err) { |
| 18 | + } |
| 19 | +//--> |
| 20 | +var methods = {"i0":6,"i1":6,"i2":6}; |
| 21 | +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| 22 | +var altColor = "altColor"; |
| 23 | +var rowColor = "rowColor"; |
| 24 | +var tableTab = "tableTab"; |
| 25 | +var 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="class-use/OverlaySupport.html">Use</a></li> |
| 43 | +<li><a href="package-tree.html">Tree</a></li> |
| 44 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 45 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 46 | +<li><a href="../../../../help-doc.html">Help</a></li> |
| 47 | +</ul> |
| 48 | +</div> |
| 49 | +<div class="subNav"> |
| 50 | +<ul class="navList"> |
| 51 | +<li><a href="../../../../org/micromanager/display/overlay/OverlayPlugin.html" title="interface in org.micromanager.display.overlay"><span class="typeNameLink">Prev Class</span></a></li> |
| 52 | +<li>Next Class</li> |
| 53 | +</ul> |
| 54 | +<ul class="navList"> |
| 55 | +<li><a href="../../../../index.html?org/micromanager/display/overlay/OverlaySupport.html" target="_top">Frames</a></li> |
| 56 | +<li><a href="OverlaySupport.html" target="_top">No Frames</a></li> |
| 57 | +</ul> |
| 58 | +<ul class="navList" id="allclasses_navbar_top"> |
| 59 | +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| 60 | +</ul> |
| 61 | +<div> |
| 62 | +<script type="text/javascript"><!-- |
| 63 | + allClassesLink = document.getElementById("allclasses_navbar_top"); |
| 64 | + if(window==top) { |
| 65 | + allClassesLink.style.display = "block"; |
| 66 | + } |
| 67 | + else { |
| 68 | + allClassesLink.style.display = "none"; |
| 69 | + } |
| 70 | + //--> |
| 71 | +</script> |
| 72 | +</div> |
| 73 | +<div> |
| 74 | +<ul class="subNavList"> |
| 75 | +<li>Summary: </li> |
| 76 | +<li>Nested | </li> |
| 77 | +<li>Field | </li> |
| 78 | +<li>Constr | </li> |
| 79 | +<li><a href="#method.summary">Method</a></li> |
| 80 | +</ul> |
| 81 | +<ul class="subNavList"> |
| 82 | +<li>Detail: </li> |
| 83 | +<li>Field | </li> |
| 84 | +<li>Constr | </li> |
| 85 | +<li><a href="#method.detail">Method</a></li> |
| 86 | +</ul> |
| 87 | +</div> |
| 88 | +<a name="skip.navbar.top"> |
| 89 | +<!-- --> |
| 90 | +</a></div> |
| 91 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 92 | +<!-- ======== START OF CLASS DATA ======== --> |
| 93 | +<div class="header"> |
| 94 | +<div class="subTitle">org.micromanager.display.overlay</div> |
| 95 | +<h2 title="Interface OverlaySupport" class="title">Interface OverlaySupport</h2> |
| 96 | +</div> |
| 97 | +<div class="contentContainer"> |
| 98 | +<div class="description"> |
| 99 | +<ul class="blockList"> |
| 100 | +<li class="blockList"> |
| 101 | +<hr> |
| 102 | +<br> |
| 103 | +<pre>public interface <span class="typeNameLabel">OverlaySupport</span></pre> |
| 104 | +<div class="block">Interface for data viewers that support MM Inspector overlays without |
| 105 | + implementing the full <a href="../../../../org/micromanager/display/DisplayWindow.html" title="interface in org.micromanager.display"><code>DisplayWindow</code></a>. |
| 106 | + |
| 107 | + <p>Implement this interface to allow the Overlays Inspector panel to attach |
| 108 | + to a custom viewer (e.g. NDViewer2DataViewer).</div> |
| 109 | +</li> |
| 110 | +</ul> |
| 111 | +</div> |
| 112 | +<div class="summary"> |
| 113 | +<ul class="blockList"> |
| 114 | +<li class="blockList"> |
| 115 | +<!-- ========== METHOD SUMMARY =========== --> |
| 116 | +<ul class="blockList"> |
| 117 | +<li class="blockList"><a name="method.summary"> |
| 118 | +<!-- --> |
| 119 | +</a> |
| 120 | +<h3>Method Summary</h3> |
| 121 | +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| 122 | +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| 123 | +<tr> |
| 124 | +<th class="colFirst" scope="col">Modifier and Type</th> |
| 125 | +<th class="colLast" scope="col">Method and Description</th> |
| 126 | +</tr> |
| 127 | +<tr id="i0" class="altColor"> |
| 128 | +<td class="colFirst"><code>void</code></td> |
| 129 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/micromanager/display/overlay/OverlaySupport.html#addOverlay-org.micromanager.display.overlay.Overlay-">addOverlay</a></span>(<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a> overlay)</code> |
| 130 | +<div class="block">Add an overlay to this viewer.</div> |
| 131 | +</td> |
| 132 | +</tr> |
| 133 | +<tr id="i1" class="rowColor"> |
| 134 | +<td class="colFirst"><code>java.util.List<<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a>></code></td> |
| 135 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/micromanager/display/overlay/OverlaySupport.html#getOverlays--">getOverlays</a></span>()</code> |
| 136 | +<div class="block">Return the list of overlays currently attached to this viewer.</div> |
| 137 | +</td> |
| 138 | +</tr> |
| 139 | +<tr id="i2" class="altColor"> |
| 140 | +<td class="colFirst"><code>void</code></td> |
| 141 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/micromanager/display/overlay/OverlaySupport.html#removeOverlay-org.micromanager.display.overlay.Overlay-">removeOverlay</a></span>(<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a> overlay)</code> |
| 142 | +<div class="block">Remove an overlay from this viewer.</div> |
| 143 | +</td> |
| 144 | +</tr> |
| 145 | +</table> |
| 146 | +</li> |
| 147 | +</ul> |
| 148 | +</li> |
| 149 | +</ul> |
| 150 | +</div> |
| 151 | +<div class="details"> |
| 152 | +<ul class="blockList"> |
| 153 | +<li class="blockList"> |
| 154 | +<!-- ============ METHOD DETAIL ========== --> |
| 155 | +<ul class="blockList"> |
| 156 | +<li class="blockList"><a name="method.detail"> |
| 157 | +<!-- --> |
| 158 | +</a> |
| 159 | +<h3>Method Detail</h3> |
| 160 | +<a name="addOverlay-org.micromanager.display.overlay.Overlay-"> |
| 161 | +<!-- --> |
| 162 | +</a> |
| 163 | +<ul class="blockList"> |
| 164 | +<li class="blockList"> |
| 165 | +<h4>addOverlay</h4> |
| 166 | +<pre>void addOverlay(<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a> overlay)</pre> |
| 167 | +<div class="block">Add an overlay to this viewer.</div> |
| 168 | +<dl> |
| 169 | +<dt><span class="paramLabel">Parameters:</span></dt> |
| 170 | +<dd><code>overlay</code> - the overlay to add</dd> |
| 171 | +</dl> |
| 172 | +</li> |
| 173 | +</ul> |
| 174 | +<a name="removeOverlay-org.micromanager.display.overlay.Overlay-"> |
| 175 | +<!-- --> |
| 176 | +</a> |
| 177 | +<ul class="blockList"> |
| 178 | +<li class="blockList"> |
| 179 | +<h4>removeOverlay</h4> |
| 180 | +<pre>void removeOverlay(<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a> overlay)</pre> |
| 181 | +<div class="block">Remove an overlay from this viewer.</div> |
| 182 | +<dl> |
| 183 | +<dt><span class="paramLabel">Parameters:</span></dt> |
| 184 | +<dd><code>overlay</code> - the overlay to remove</dd> |
| 185 | +</dl> |
| 186 | +</li> |
| 187 | +</ul> |
| 188 | +<a name="getOverlays--"> |
| 189 | +<!-- --> |
| 190 | +</a> |
| 191 | +<ul class="blockListLast"> |
| 192 | +<li class="blockList"> |
| 193 | +<h4>getOverlays</h4> |
| 194 | +<pre>java.util.List<<a href="../../../../org/micromanager/display/overlay/Overlay.html" title="interface in org.micromanager.display.overlay">Overlay</a>> getOverlays()</pre> |
| 195 | +<div class="block">Return the list of overlays currently attached to this viewer.</div> |
| 196 | +<dl> |
| 197 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 198 | +<dd>unmodifiable list of overlays</dd> |
| 199 | +</dl> |
| 200 | +</li> |
| 201 | +</ul> |
| 202 | +</li> |
| 203 | +</ul> |
| 204 | +</li> |
| 205 | +</ul> |
| 206 | +</div> |
| 207 | +</div> |
| 208 | +<!-- ========= END OF CLASS DATA ========= --> |
| 209 | +<!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 210 | +<div class="bottomNav"><a name="navbar.bottom"> |
| 211 | +<!-- --> |
| 212 | +</a> |
| 213 | +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| 214 | +<a name="navbar.bottom.firstrow"> |
| 215 | +<!-- --> |
| 216 | +</a> |
| 217 | +<ul class="navList" title="Navigation"> |
| 218 | +<li><a href="../../../../overview-summary.html">Overview</a></li> |
| 219 | +<li><a href="package-summary.html">Package</a></li> |
| 220 | +<li class="navBarCell1Rev">Class</li> |
| 221 | +<li><a href="class-use/OverlaySupport.html">Use</a></li> |
| 222 | +<li><a href="package-tree.html">Tree</a></li> |
| 223 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 224 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 225 | +<li><a href="../../../../help-doc.html">Help</a></li> |
| 226 | +</ul> |
| 227 | +</div> |
| 228 | +<div class="subNav"> |
| 229 | +<ul class="navList"> |
| 230 | +<li><a href="../../../../org/micromanager/display/overlay/OverlayPlugin.html" title="interface in org.micromanager.display.overlay"><span class="typeNameLink">Prev Class</span></a></li> |
| 231 | +<li>Next Class</li> |
| 232 | +</ul> |
| 233 | +<ul class="navList"> |
| 234 | +<li><a href="../../../../index.html?org/micromanager/display/overlay/OverlaySupport.html" target="_top">Frames</a></li> |
| 235 | +<li><a href="OverlaySupport.html" target="_top">No Frames</a></li> |
| 236 | +</ul> |
| 237 | +<ul class="navList" id="allclasses_navbar_bottom"> |
| 238 | +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| 239 | +</ul> |
| 240 | +<div> |
| 241 | +<script type="text/javascript"><!-- |
| 242 | + allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 243 | + if(window==top) { |
| 244 | + allClassesLink.style.display = "block"; |
| 245 | + } |
| 246 | + else { |
| 247 | + allClassesLink.style.display = "none"; |
| 248 | + } |
| 249 | + //--> |
| 250 | +</script> |
| 251 | +</div> |
| 252 | +<div> |
| 253 | +<ul class="subNavList"> |
| 254 | +<li>Summary: </li> |
| 255 | +<li>Nested | </li> |
| 256 | +<li>Field | </li> |
| 257 | +<li>Constr | </li> |
| 258 | +<li><a href="#method.summary">Method</a></li> |
| 259 | +</ul> |
| 260 | +<ul class="subNavList"> |
| 261 | +<li>Detail: </li> |
| 262 | +<li>Field | </li> |
| 263 | +<li>Constr | </li> |
| 264 | +<li><a href="#method.detail">Method</a></li> |
| 265 | +</ul> |
| 266 | +</div> |
| 267 | +<a name="skip.navbar.bottom"> |
| 268 | +<!-- --> |
| 269 | +</a></div> |
| 270 | +<!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 271 | +</body> |
| 272 | +</html> |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments