DialLayer.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  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>DialLayer (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="DialLayer (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/DialLayer.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/DialFrame.html" title="interface in org.jfree.chart.plot.dial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeEvent.html" title="class 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/DialLayer.html" target="_top">Frames</a></li>
  57. <li><a href="DialLayer.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 DialLayer" class="title">Interface DialLayer</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Subinterfaces:</dt>
  104. <dd><a href="../../../../../org/jfree/chart/plot/dial/DialFrame.html" title="interface in org.jfree.chart.plot.dial">DialFrame</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialScale.html" title="interface in org.jfree.chart.plot.dial">DialScale</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Implementing Classes:</dt>
  108. <dd><a href="../../../../../org/jfree/chart/plot/dial/AbstractDialLayer.html" title="class in org.jfree.chart.plot.dial">AbstractDialLayer</a>, <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/DialBackground.html" title="class in org.jfree.chart.plot.dial">DialBackground</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialCap.html" title="class in org.jfree.chart.plot.dial">DialCap</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialPointer.html" title="class in org.jfree.chart.plot.dial">DialPointer</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialPointer.Pin.html" title="class in org.jfree.chart.plot.dial">DialPointer.Pin</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialPointer.Pointer.html" title="class in org.jfree.chart.plot.dial">DialPointer.Pointer</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialTextAnnotation.html" title="class in org.jfree.chart.plot.dial">DialTextAnnotation</a>, <a href="../../../../../org/jfree/chart/plot/dial/DialValueIndicator.html" title="class in org.jfree.chart.plot.dial">DialValueIndicator</a>, <a href="../../../../../org/jfree/chart/plot/dial/StandardDialFrame.html" title="class in org.jfree.chart.plot.dial">StandardDialFrame</a>, <a href="../../../../../org/jfree/chart/plot/dial/StandardDialRange.html" title="class in org.jfree.chart.plot.dial">StandardDialRange</a>, <a href="../../../../../org/jfree/chart/plot/dial/StandardDialScale.html" title="class in org.jfree.chart.plot.dial">StandardDialScale</a></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public interface <a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.58">DialLayer</a></pre>
  113. <div class="block">A dial layer draws itself within a reference frame. The view frame is a
  114. subset of the reference frame, and defines the area that is actually
  115. visible.
  116. <br><br>
  117. Classes that implement this interface should be <code>Serializable</code>,
  118. otherwise chart serialization may fail.</div>
  119. <dl>
  120. <dt><span class="simpleTagLabel">Since:</span></dt>
  121. <dd>1.0.7</dd>
  122. </dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- ========== METHOD SUMMARY =========== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="method.summary">
  132. <!-- -->
  133. </a>
  134. <h3>Method Summary</h3>
  135. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  136. <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>
  137. <tr>
  138. <th class="colFirst" scope="col">Modifier and Type</th>
  139. <th class="colLast" scope="col">Method and Description</th>
  140. </tr>
  141. <tr id="i0" class="altColor">
  142. <td class="colFirst"><code>void</code></td>
  143. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#addChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">addChangeListener</a></span>(<a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeListener.html" title="interface in org.jfree.chart.plot.dial">DialLayerChangeListener</a>&nbsp;listener)</code>
  144. <div class="block">Registers a listener with this layer, so that it receives notification
  145. of changes to this layer.</div>
  146. </td>
  147. </tr>
  148. <tr id="i1" class="rowColor">
  149. <td class="colFirst"><code>void</code></td>
  150. <td class="colLast"><code><span class="memberNameLink"><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></span>(java.awt.Graphics2D&nbsp;g2,
  151. <a href="../../../../../org/jfree/chart/plot/dial/DialPlot.html" title="class in org.jfree.chart.plot.dial">DialPlot</a>&nbsp;plot,
  152. java.awt.geom.Rectangle2D&nbsp;frame,
  153. java.awt.geom.Rectangle2D&nbsp;view)</code>
  154. <div class="block">Draws the content of this layer.</div>
  155. </td>
  156. </tr>
  157. <tr id="i2" class="altColor">
  158. <td class="colFirst"><code>boolean</code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#hasListener-java.util.EventListener-">hasListener</a></span>(java.util.EventListener&nbsp;listener)</code>
  160. <div class="block">Returns <code>true</code> if the specified listener is currently
  161. registered with the this layer.</div>
  162. </td>
  163. </tr>
  164. <tr id="i3" class="rowColor">
  165. <td class="colFirst"><code>boolean</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#isClippedToWindow--">isClippedToWindow</a></span>()</code>
  167. <div class="block">Returns <code>true</code> if the drawing should be clipped to the
  168. dial window (which is defined by the <a href="../../../../../org/jfree/chart/plot/dial/DialFrame.html" title="interface in org.jfree.chart.plot.dial"><code>DialFrame</code></a>), and
  169. <code>false</code> otherwise.</div>
  170. </td>
  171. </tr>
  172. <tr id="i4" class="altColor">
  173. <td class="colFirst"><code>boolean</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#isVisible--">isVisible</a></span>()</code>
  175. <div class="block">Returns a flag that indicates whether or not the layer is visible.</div>
  176. </td>
  177. </tr>
  178. <tr id="i5" class="rowColor">
  179. <td class="colFirst"><code>void</code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/chart/plot/dial/DialLayer.html#removeChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">removeChangeListener</a></span>(<a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeListener.html" title="interface in org.jfree.chart.plot.dial">DialLayerChangeListener</a>&nbsp;listener)</code>
  181. <div class="block">Deregisters a listener, so that it no longer receives notification of
  182. changes to this layer.</div>
  183. </td>
  184. </tr>
  185. </table>
  186. </li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </div>
  191. <div class="details">
  192. <ul class="blockList">
  193. <li class="blockList">
  194. <!-- ============ METHOD DETAIL ========== -->
  195. <ul class="blockList">
  196. <li class="blockList"><a name="method.detail">
  197. <!-- -->
  198. </a>
  199. <h3>Method Detail</h3>
  200. <a name="isVisible--">
  201. <!-- -->
  202. </a>
  203. <ul class="blockList">
  204. <li class="blockList">
  205. <h4>isVisible</h4>
  206. <pre>boolean&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.65">isVisible</a>()</pre>
  207. <div class="block">Returns a flag that indicates whether or not the layer is visible.</div>
  208. <dl>
  209. <dt><span class="returnLabel">Returns:</span></dt>
  210. <dd>A boolean.</dd>
  211. </dl>
  212. </li>
  213. </ul>
  214. <a name="addChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">
  215. <!-- -->
  216. </a>
  217. <ul class="blockList">
  218. <li class="blockList">
  219. <h4>addChangeListener</h4>
  220. <pre>void&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.73">addChangeListener</a>(<a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeListener.html" title="interface in org.jfree.chart.plot.dial">DialLayerChangeListener</a>&nbsp;listener)</pre>
  221. <div class="block">Registers a listener with this layer, so that it receives notification
  222. of changes to this layer.</div>
  223. <dl>
  224. <dt><span class="paramLabel">Parameters:</span></dt>
  225. <dd><code>listener</code> - the listener.</dd>
  226. </dl>
  227. </li>
  228. </ul>
  229. <a name="removeChangeListener-org.jfree.chart.plot.dial.DialLayerChangeListener-">
  230. <!-- -->
  231. </a>
  232. <ul class="blockList">
  233. <li class="blockList">
  234. <h4>removeChangeListener</h4>
  235. <pre>void&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.81">removeChangeListener</a>(<a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeListener.html" title="interface in org.jfree.chart.plot.dial">DialLayerChangeListener</a>&nbsp;listener)</pre>
  236. <div class="block">Deregisters a listener, so that it no longer receives notification of
  237. changes to this layer.</div>
  238. <dl>
  239. <dt><span class="paramLabel">Parameters:</span></dt>
  240. <dd><code>listener</code> - the listener.</dd>
  241. </dl>
  242. </li>
  243. </ul>
  244. <a name="hasListener-java.util.EventListener-">
  245. <!-- -->
  246. </a>
  247. <ul class="blockList">
  248. <li class="blockList">
  249. <h4>hasListener</h4>
  250. <pre>boolean&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.91">hasListener</a>(java.util.EventListener&nbsp;listener)</pre>
  251. <div class="block">Returns <code>true</code> if the specified listener is currently
  252. registered with the this layer.</div>
  253. <dl>
  254. <dt><span class="paramLabel">Parameters:</span></dt>
  255. <dd><code>listener</code> - the listener.</dd>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>A boolean.</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="isClippedToWindow--">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>isClippedToWindow</h4>
  267. <pre>boolean&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.100">isClippedToWindow</a>()</pre>
  268. <div class="block">Returns <code>true</code> if the drawing should be clipped to the
  269. dial window (which is defined by the <a href="../../../../../org/jfree/chart/plot/dial/DialFrame.html" title="interface in org.jfree.chart.plot.dial"><code>DialFrame</code></a>), and
  270. <code>false</code> otherwise.</div>
  271. <dl>
  272. <dt><span class="returnLabel">Returns:</span></dt>
  273. <dd>A boolean.</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="draw-java.awt.Graphics2D-org.jfree.chart.plot.dial.DialPlot-java.awt.geom.Rectangle2D-java.awt.geom.Rectangle2D-">
  278. <!-- -->
  279. </a>
  280. <ul class="blockListLast">
  281. <li class="blockList">
  282. <h4>draw</h4>
  283. <pre>void&nbsp;<a href="../../../../../src-html/org/jfree/chart/plot/dial/DialLayer.html#line.115">draw</a>(java.awt.Graphics2D&nbsp;g2,
  284. <a href="../../../../../org/jfree/chart/plot/dial/DialPlot.html" title="class in org.jfree.chart.plot.dial">DialPlot</a>&nbsp;plot,
  285. java.awt.geom.Rectangle2D&nbsp;frame,
  286. java.awt.geom.Rectangle2D&nbsp;view)</pre>
  287. <div class="block">Draws the content of this layer.</div>
  288. <dl>
  289. <dt><span class="paramLabel">Parameters:</span></dt>
  290. <dd><code>g2</code> - the graphics target (<code>null</code> not permitted).</dd>
  291. <dd><code>plot</code> - the plot (typically this should not be <code>null</code>,
  292. but for a layer that doesn't need to reference the plot, it may
  293. be permitted).</dd>
  294. <dd><code>frame</code> - the reference frame for the dial's geometry
  295. (<code>null</code> not permitted). This is typically larger than
  296. the visible area of the dial (see the next parameter).</dd>
  297. <dd><code>view</code> - the visible area for the dial (<code>null</code> not
  298. permitted).</dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. </li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </div>
  307. </div>
  308. <!-- ========= END OF CLASS DATA ========= -->
  309. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  310. <div class="bottomNav"><a name="navbar.bottom">
  311. <!-- -->
  312. </a>
  313. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  314. <a name="navbar.bottom.firstrow">
  315. <!-- -->
  316. </a>
  317. <ul class="navList" title="Navigation">
  318. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  319. <li><a href="package-summary.html">Package</a></li>
  320. <li class="navBarCell1Rev">Class</li>
  321. <li><a href="class-use/DialLayer.html">Use</a></li>
  322. <li><a href="package-tree.html">Tree</a></li>
  323. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  324. <li><a href="../../../../../index-files/index-1.html">Index</a></li>
  325. <li><a href="../../../../../help-doc.html">Help</a></li>
  326. </ul>
  327. </div>
  328. <div class="subNav">
  329. <ul class="navList">
  330. <li><a href="../../../../../org/jfree/chart/plot/dial/DialFrame.html" title="interface in org.jfree.chart.plot.dial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  331. <li><a href="../../../../../org/jfree/chart/plot/dial/DialLayerChangeEvent.html" title="class in org.jfree.chart.plot.dial"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  332. </ul>
  333. <ul class="navList">
  334. <li><a href="../../../../../index.html?org/jfree/chart/plot/dial/DialLayer.html" target="_top">Frames</a></li>
  335. <li><a href="DialLayer.html" target="_top">No&nbsp;Frames</a></li>
  336. </ul>
  337. <ul class="navList" id="allclasses_navbar_bottom">
  338. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  339. </ul>
  340. <div>
  341. <script type="text/javascript"><!--
  342. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  343. if(window==top) {
  344. allClassesLink.style.display = "block";
  345. }
  346. else {
  347. allClassesLink.style.display = "none";
  348. }
  349. //-->
  350. </script>
  351. </div>
  352. <div>
  353. <ul class="subNavList">
  354. <li>Summary:&nbsp;</li>
  355. <li>Nested&nbsp;|&nbsp;</li>
  356. <li>Field&nbsp;|&nbsp;</li>
  357. <li>Constr&nbsp;|&nbsp;</li>
  358. <li><a href="#method.summary">Method</a></li>
  359. </ul>
  360. <ul class="subNavList">
  361. <li>Detail:&nbsp;</li>
  362. <li>Field&nbsp;|&nbsp;</li>
  363. <li>Constr&nbsp;|&nbsp;</li>
  364. <li><a href="#method.detail">Method</a></li>
  365. </ul>
  366. </div>
  367. <a name="skip.navbar.bottom">
  368. <!-- -->
  369. </a></div>
  370. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  371. </body>
  372. </html>