/usr/share/doc/libflexdock-java-doc/api/org/flexdock/docking/floating/policy/FloatPolicy.html is in libflexdock-java-doc 1.2.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Mon Aug 05 12:48:37 UTC 2013 -->
<title>FloatPolicy</title>
<meta name="date" content="2013-08-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FloatPolicy";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/flexdock/docking/floating/policy/DefaultFloatPolicy.html" title="class in org.flexdock.docking.floating.policy"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.NullFloatPolicy.html" title="class in org.flexdock.docking.floating.policy"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/flexdock/docking/floating/policy/FloatPolicy.html" target="_top">FRAMES</a></li>
<li><a href="FloatPolicy.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li><a href="#nested_class_summary">NESTED</a> | </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.flexdock.docking.floating.policy</p>
<h2 title="Interface FloatPolicy" class="title">Interface FloatPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/flexdock/docking/floating/policy/DefaultFloatPolicy.html" title="class in org.flexdock.docking.floating.policy">DefaultFloatPolicy</a>, <a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.NullFloatPolicy.html" title="class in org.flexdock.docking.floating.policy">FloatPolicy.NullFloatPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <strong>FloatPolicy</strong></pre>
<div class="block">This interface describes a set of method used to determine how floating
events should be handled. Classes implementing this interface should be
plugged into to the <code>FloatPolicyManager</code> to affect floating behavior of
the framework at runtime.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Christopher Butler</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.NullFloatPolicy.html" title="class in org.flexdock.docking.floating.policy">FloatPolicy.NullFloatPolicy</a></strong></code>
<div class="block">Provides a default implementation of the FloatPolicy interface.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.html#isFloatDropAllowed(org.flexdock.docking.event.DockingEvent)">isFloatDropAllowed</a></strong>(<a href="../../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">Indicates whether floating should be allowed for the specified
<code>DockingEvent</code> at the end of a drag operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.html#isFloatingAllowed(org.flexdock.docking.Dockable)">isFloatingAllowed</a></strong>(<a href="../../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns <code>true</code> if floating should be allowed for the specified
<code>Dockable</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isFloatingAllowed(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFloatingAllowed</h4>
<pre>boolean isFloatingAllowed(<a href="../../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns <code>true</code> if floating should be allowed for the specified
<code>Dockable</code>. This method will be invoked by the
<code>FloatPolicyManager</code> at the beginning of a drag operation to
determine whether or not floating support will be enabled for the
<code>Dockable</code> as a result of the drag. If this method returns
<code>false</code>, floating will not be allowed for the drag operation
against the specified <code>Dockable</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to be checked for floating support</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if floating should be allowed for the specified
<code>Dockable</code>; <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="isFloatDropAllowed(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isFloatDropAllowed</h4>
<pre>boolean isFloatDropAllowed(<a href="../../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">Indicates whether floating should be allowed for the specified
<code>DockingEvent</code> at the end of a drag operation. The
<code>FloatPolicyManager</code> will catch all attempts to float a
<code>Dockable</code> at the end of a drag operation and invoke this method on
all installed <code>FloatPolicies</code>. If any of them returns
<code>false</code>, the docking operation will be canceled.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to be checked for drop-to-float
support</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if floating should be allowed for the specified
<code>DockingEvent</code>; <code>false</code> otherwise.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/flexdock/docking/floating/policy/DefaultFloatPolicy.html" title="class in org.flexdock.docking.floating.policy"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/flexdock/docking/floating/policy/FloatPolicy.NullFloatPolicy.html" title="class in org.flexdock.docking.floating.policy"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/flexdock/docking/floating/policy/FloatPolicy.html" target="_top">FRAMES</a></li>
<li><a href="FloatPolicy.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY: </li>
<li><a href="#nested_class_summary">NESTED</a> | </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li>FIELD | </li>
<li>CONSTR | </li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|