DialFrame.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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 (1.8.0_05) on Thu Jul 31 14:50:34 CEST 2014 -->
  6. <title>DialFrame (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="DialFrame (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/DialFrame.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../../org/jfree/chart/plot/dial/DialCap.html" title="class in org.jfree.chart.plot.dial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html" title="interface in org.jfree.chart.plot.dial"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/jfree/chart/plot/dial/DialFrame.html" target="_top">Frames</a></li>
  57. <li><a href="DialFrame.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li>Constr&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li>Constr&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.plot.dial</div>
  96. <h2 title="Interface DialFrame" class="title">Interface DialFrame</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html" title="interface in org.jfree.chart.plot.dial">DialLayer</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Implementing Classes:</dt>
  108. <dd><a href="../../../../../org/jfree/chart/plot/dial/ArcDialFrame.html" title="class in org.jfree.chart.plot.dial">ArcDialFrame</a>, <a href="../../../../../org/jfree/chart/plot/dial/StandardDialFrame.html" title="class in org.jfree.chart.plot.dial">StandardDialFrame</a></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public interface <a href="../../../../../src-html/org/jfree/chart/plot/dial/DialFrame.html#line.57">DialFrame</a>
  113. extends <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html" title="interface in org.jfree.chart.plot.dial">DialLayer</a></pre>
  114. <div class="block">A dial frame is the face plate for a dial plot - it is always drawn last.
  115. JFreeChart includes a couple of implementations of this interface
  116. (<a href="../../../../../org/jfree/chart/plot/dial/StandardDialFrame.html" title="class in org.jfree.chart.plot.dial"><code>StandardDialFrame</code></a> and <a href="../../../../../org/jfree/chart/plot/dial/ArcDialFrame.html" title="class in org.jfree.chart.plot.dial"><code>ArcDialFrame</code></a>).
  117. <br><br>
  118. Classes that implement this interface should be <code>Serializable</code>,
  119. otherwise chart serialization may fail.</div>
  120. <dl>
  121. <dt><span class="simpleTagLabel">Since:</span></dt>
  122. <dd>1.0.7</dd>
  123. </dl>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="summary">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <!-- ========== METHOD SUMMARY =========== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="method.summary">
  133. <!-- -->
  134. </a>
  135. <h3>Method Summary</h3>
  136. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  137. <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>
  138. <tr>
  139. <th class="colFirst" scope="col">Modifier and Type</th>
  140. <th class="colLast" scope="col">Method and Description</th>
  141. </tr>
  142. <tr id="i0" class="altColor">
  143. <td class="colFirst"><code>java.awt.Shape</code></td>
  144. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialFrame.html#getWindow-java.awt.geom.Rectangle2D-">getWindow</a></span>(java.awt.geom.Rectangle2D&nbsp;frame)</code>
  145. <div class="block">Returns the shape of the viewing window for the dial, or
  146. <code>null</code> if the dial is completely open.</div>
  147. </td>
  148. </tr>
  149. </table>
  150. <ul class="blockList">
  151. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.plot.dial.DialLayer">
  152. <!-- -->
  153. </a>
  154. <h3>Methods inherited from interface&nbsp;org.jfree.chart.plot.dial.<a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html" title="interface in org.jfree.chart.plot.dial">DialLayer</a></h3>
  155. <code><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#addChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">addChangeListener</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#draw-java.awt.Graphics2D-org.jfree.chart.plot.dial.DialPlot-java.awt.geom.Rectangle2D-java.awt.geom.Rectangle2D-">draw</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#hasListener-java.util.EventListener-">hasListener</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#isClippedToWindow--">isClippedToWindow</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#isVisible--">isVisible</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#removeChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">removeChangeListener</a></code></li>
  156. </ul>
  157. </li>
  158. </ul>
  159. </li>
  160. </ul>
  161. </div>
  162. <div class="details">
  163. <ul class="blockList">
  164. <li class="blockList">
  165. <!-- ============ METHOD DETAIL ========== -->
  166. <ul class="blockList">
  167. <li class="blockList"><a name="method.detail">
  168. <!-- -->
  169. </a>
  170. <h3>Method Detail</h3>
  171. <a name="getWindow-java.awt.geom.Rectangle2D-">
  172. <!-- -->
  173. </a>
  174. <ul class="blockListLast">
  175. <li class="blockList">
  176. <h4>getWindow</h4>
  177. <pre>java.awt.Shape&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialFrame.html#line.68">getWindow</a>(java.awt.geom.Rectangle2D&nbsp;frame)</pre>
  178. <div class="block">Returns the shape of the viewing window for the dial, or
  179. <code>null</code> if the dial is completely open. Other layers in the
  180. plot will rely on their drawing to be clipped within this window.</div>
  181. <dl>
  182. <dt><span class="paramLabel">Parameters:</span></dt>
  183. <dd><code>frame</code> - the reference frame for the dial.</dd>
  184. <dt><span class="returnLabel">Returns:</span></dt>
  185. <dd>The window.</dd>
  186. </dl>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </li>
  192. </ul>
  193. </div>
  194. </div>
  195. <!-- ========= END OF CLASS DATA ========= -->
  196. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  197. <div class="bottomNav"><a name="navbar.bottom">
  198. <!-- -->
  199. </a>
  200. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  201. <a name="navbar.bottom.firstrow">
  202. <!-- -->
  203. </a>
  204. <ul class="navList" title="Navigation">
  205. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  206. <li><a href="package-summary.html">Package</a></li>
  207. <li class="navBarCell1Rev">Class</li>
  208. <li><a href="class-use/DialFrame.html">Use</a></li>
  209. <li><a href="package-tree.html">Tree</a></li>
  210. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  211. <li><a href="../../../../../index-files/index-1.html">Index</a></li>
  212. <li><a href="../../../../../help-doc.html">Help</a></li>
  213. </ul>
  214. </div>
  215. <div class="subNav">
  216. <ul class="navList">
  217. <li><a href="../../../../../org/jfree/chart/plot/dial/DialCap.html" title="class in org.jfree.chart.plot.dial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  218. <li><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html" title="interface in org.jfree.chart.plot.dial"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  219. </ul>
  220. <ul class="navList">
  221. <li><a href="../../../../../index.html?org/jfree/chart/plot/dial/DialFrame.html" target="_top">Frames</a></li>
  222. <li><a href="DialFrame.html" target="_top">No&nbsp;Frames</a></li>
  223. </ul>
  224. <ul class="navList" id="allclasses_navbar_bottom">
  225. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  226. </ul>
  227. <div>
  228. <script type="text/javascript"><!--
  229. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  230. if(window==top) {
  231. allClassesLink.style.display = "block";
  232. }
  233. else {
  234. allClassesLink.style.display = "none";
  235. }
  236. //-->
  237. </script>
  238. </div>
  239. <div>
  240. <ul class="subNavList">
  241. <li>Summary:&nbsp;</li>
  242. <li>Nested&nbsp;|&nbsp;</li>
  243. <li>Field&nbsp;|&nbsp;</li>
  244. <li>Constr&nbsp;|&nbsp;</li>
  245. <li><a href="#method.summary">Method</a></li>
  246. </ul>
  247. <ul class="subNavList">
  248. <li>Detail:&nbsp;</li>
  249. <li>Field&nbsp;|&nbsp;</li>
  250. <li>Constr&nbsp;|&nbsp;</li>
  251. <li><a href="#method.detail">Method</a></li>
  252. </ul>
  253. </div>
  254. <a name="skip.navbar.bottom">
  255. <!-- -->
  256. </a></div>
  257. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  258. </body>
  259. </html>