MeterInterval.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  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:33 CEST 2014 -->
  6. <title>MeterInterval (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="MeterInterval (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/MeterInterval.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/Marker.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/plot/MeterPlot.html" title="class in org.jfree.chart.plot"><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/MeterInterval.html" target="_top">Frames</a></li>
  57. <li><a href="MeterInterval.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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</div>
  96. <h2 title="Class MeterInterval" class="title">Class MeterInterval</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.plot.MeterInterval</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.64">MeterInterval</a>
  117. extends java.lang.Object
  118. implements java.io.Serializable</pre>
  119. <div class="block">An interval to be highlighted on a <a href="../../../../org/jfree/chart/plot/MeterPlot.html" title="class in org.jfree.chart.plot"><code>MeterPlot</code></a>. Instances of this
  120. class are immutable.</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../../serialized-form.html#org.jfree.chart.plot.MeterInterval">Serialized Form</a></dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#MeterInterval-java.lang.String-org.jfree.data.Range-">MeterInterval</a></span>(java.lang.String&nbsp;label,
  144. <a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range)</code>
  145. <div class="block">Creates a new interval.</div>
  146. </td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#MeterInterval-java.lang.String-org.jfree.data.Range-java.awt.Paint-java.awt.Stroke-java.awt.Paint-">MeterInterval</a></span>(java.lang.String&nbsp;label,
  150. <a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  151. java.awt.Paint&nbsp;outlinePaint,
  152. java.awt.Stroke&nbsp;outlineStroke,
  153. java.awt.Paint&nbsp;backgroundPaint)</code>
  154. <div class="block">Creates a new interval.</div>
  155. </td>
  156. </tr>
  157. </table>
  158. </li>
  159. </ul>
  160. <!-- ========== METHOD SUMMARY =========== -->
  161. <ul class="blockList">
  162. <li class="blockList"><a name="method.summary">
  163. <!-- -->
  164. </a>
  165. <h3>Method Summary</h3>
  166. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  167. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  168. <tr>
  169. <th class="colFirst" scope="col">Modifier and Type</th>
  170. <th class="colLast" scope="col">Method and Description</th>
  171. </tr>
  172. <tr id="i0" class="altColor">
  173. <td class="colFirst"><code>boolean</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  175. <div class="block">Checks this instance for equality with an arbitrary object.</div>
  176. </td>
  177. </tr>
  178. <tr id="i1" class="rowColor">
  179. <td class="colFirst"><code>java.awt.Paint</code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#getBackgroundPaint--">getBackgroundPaint</a></span>()</code>
  181. <div class="block">Returns the background paint.</div>
  182. </td>
  183. </tr>
  184. <tr id="i2" class="altColor">
  185. <td class="colFirst"><code>java.lang.String</code></td>
  186. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#getLabel--">getLabel</a></span>()</code>
  187. <div class="block">Returns the label.</div>
  188. </td>
  189. </tr>
  190. <tr id="i3" class="rowColor">
  191. <td class="colFirst"><code>java.awt.Paint</code></td>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#getOutlinePaint--">getOutlinePaint</a></span>()</code>
  193. <div class="block">Returns the outline paint.</div>
  194. </td>
  195. </tr>
  196. <tr id="i4" class="altColor">
  197. <td class="colFirst"><code>java.awt.Stroke</code></td>
  198. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#getOutlineStroke--">getOutlineStroke</a></span>()</code>
  199. <div class="block">Returns the outline stroke.</div>
  200. </td>
  201. </tr>
  202. <tr id="i5" class="rowColor">
  203. <td class="colFirst"><code><a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  204. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/MeterInterval.html#getRange--">getRange</a></span>()</code>
  205. <div class="block">Returns the range.</div>
  206. </td>
  207. </tr>
  208. </table>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  211. <!-- -->
  212. </a>
  213. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  214. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. <div class="details">
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="constructor.detail">
  227. <!-- -->
  228. </a>
  229. <h3>Constructor Detail</h3>
  230. <a name="MeterInterval-java.lang.String-org.jfree.data.Range-">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>MeterInterval</h4>
  236. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.90">MeterInterval</a>(java.lang.String&nbsp;label,
  237. <a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range)</pre>
  238. <div class="block">Creates a new interval.</div>
  239. <dl>
  240. <dt><span class="paramLabel">Parameters:</span></dt>
  241. <dd><code>label</code> - the label (<code>null</code> not permitted).</dd>
  242. <dd><code>range</code> - the range (<code>null</code> not permitted).</dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. <a name="MeterInterval-java.lang.String-org.jfree.data.Range-java.awt.Paint-java.awt.Stroke-java.awt.Paint-">
  247. <!-- -->
  248. </a>
  249. <ul class="blockListLast">
  250. <li class="blockList">
  251. <h4>MeterInterval</h4>
  252. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.104">MeterInterval</a>(java.lang.String&nbsp;label,
  253. <a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  254. java.awt.Paint&nbsp;outlinePaint,
  255. java.awt.Stroke&nbsp;outlineStroke,
  256. java.awt.Paint&nbsp;backgroundPaint)</pre>
  257. <div class="block">Creates a new interval.</div>
  258. <dl>
  259. <dt><span class="paramLabel">Parameters:</span></dt>
  260. <dd><code>label</code> - the label (<code>null</code> not permitted).</dd>
  261. <dd><code>range</code> - the range (<code>null</code> not permitted).</dd>
  262. <dd><code>outlinePaint</code> - the outline paint (<code>null</code> permitted).</dd>
  263. <dd><code>outlineStroke</code> - the outline stroke (<code>null</code> permitted).</dd>
  264. <dd><code>backgroundPaint</code> - the background paint (<code>null</code>
  265. permitted).</dd>
  266. </dl>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. <!-- ============ METHOD DETAIL ========== -->
  272. <ul class="blockList">
  273. <li class="blockList"><a name="method.detail">
  274. <!-- -->
  275. </a>
  276. <h3>Method Detail</h3>
  277. <a name="getLabel--">
  278. <!-- -->
  279. </a>
  280. <ul class="blockList">
  281. <li class="blockList">
  282. <h4>getLabel</h4>
  283. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.120">getLabel</a>()</pre>
  284. <div class="block">Returns the label.</div>
  285. <dl>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>The label (never <code>null</code>).</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. <a name="getRange--">
  292. <!-- -->
  293. </a>
  294. <ul class="blockList">
  295. <li class="blockList">
  296. <h4>getRange</h4>
  297. <pre>public&nbsp;<a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.129">getRange</a>()</pre>
  298. <div class="block">Returns the range.</div>
  299. <dl>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>The range (never <code>null</code>).</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="getBackgroundPaint--">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>getBackgroundPaint</h4>
  311. <pre>public&nbsp;java.awt.Paint&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.139">getBackgroundPaint</a>()</pre>
  312. <div class="block">Returns the background paint. If <code>null</code>, the background
  313. should remain unfilled.</div>
  314. <dl>
  315. <dt><span class="returnLabel">Returns:</span></dt>
  316. <dd>The background paint (possibly <code>null</code>).</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. <a name="getOutlinePaint--">
  321. <!-- -->
  322. </a>
  323. <ul class="blockList">
  324. <li class="blockList">
  325. <h4>getOutlinePaint</h4>
  326. <pre>public&nbsp;java.awt.Paint&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.148">getOutlinePaint</a>()</pre>
  327. <div class="block">Returns the outline paint.</div>
  328. <dl>
  329. <dt><span class="returnLabel">Returns:</span></dt>
  330. <dd>The outline paint (possibly <code>null</code>).</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. <a name="getOutlineStroke--">
  335. <!-- -->
  336. </a>
  337. <ul class="blockList">
  338. <li class="blockList">
  339. <h4>getOutlineStroke</h4>
  340. <pre>public&nbsp;java.awt.Stroke&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.157">getOutlineStroke</a>()</pre>
  341. <div class="block">Returns the outline stroke.</div>
  342. <dl>
  343. <dt><span class="returnLabel">Returns:</span></dt>
  344. <dd>The outline stroke (possibly <code>null</code>).</dd>
  345. </dl>
  346. </li>
  347. </ul>
  348. <a name="equals-java.lang.Object-">
  349. <!-- -->
  350. </a>
  351. <ul class="blockListLast">
  352. <li class="blockList">
  353. <h4>equals</h4>
  354. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/plot/MeterInterval.html#line.169">equals</a>(java.lang.Object&nbsp;obj)</pre>
  355. <div class="block">Checks this instance for equality with an arbitrary object.</div>
  356. <dl>
  357. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  358. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  359. <dt><span class="paramLabel">Parameters:</span></dt>
  360. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  361. <dt><span class="returnLabel">Returns:</span></dt>
  362. <dd>A boolean.</dd>
  363. </dl>
  364. </li>
  365. </ul>
  366. </li>
  367. </ul>
  368. </li>
  369. </ul>
  370. </div>
  371. </div>
  372. <!-- ========= END OF CLASS DATA ========= -->
  373. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  374. <div class="bottomNav"><a name="navbar.bottom">
  375. <!-- -->
  376. </a>
  377. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  378. <a name="navbar.bottom.firstrow">
  379. <!-- -->
  380. </a>
  381. <ul class="navList" title="Navigation">
  382. <li><a href="../../../../overview-summary.html">Overview</a></li>
  383. <li><a href="package-summary.html">Package</a></li>
  384. <li class="navBarCell1Rev">Class</li>
  385. <li><a href="class-use/MeterInterval.html">Use</a></li>
  386. <li><a href="package-tree.html">Tree</a></li>
  387. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  388. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  389. <li><a href="../../../../help-doc.html">Help</a></li>
  390. </ul>
  391. </div>
  392. <div class="subNav">
  393. <ul class="navList">
  394. <li><a href="../../../../org/jfree/chart/plot/Marker.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  395. <li><a href="../../../../org/jfree/chart/plot/MeterPlot.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  396. </ul>
  397. <ul class="navList">
  398. <li><a href="../../../../index.html?org/jfree/chart/plot/MeterInterval.html" target="_top">Frames</a></li>
  399. <li><a href="MeterInterval.html" target="_top">No&nbsp;Frames</a></li>
  400. </ul>
  401. <ul class="navList" id="allclasses_navbar_bottom">
  402. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  403. </ul>
  404. <div>
  405. <script type="text/javascript"><!--
  406. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  407. if(window==top) {
  408. allClassesLink.style.display = "block";
  409. }
  410. else {
  411. allClassesLink.style.display = "none";
  412. }
  413. //-->
  414. </script>
  415. </div>
  416. <div>
  417. <ul class="subNavList">
  418. <li>Summary:&nbsp;</li>
  419. <li>Nested&nbsp;|&nbsp;</li>
  420. <li>Field&nbsp;|&nbsp;</li>
  421. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  422. <li><a href="#method.summary">Method</a></li>
  423. </ul>
  424. <ul class="subNavList">
  425. <li>Detail:&nbsp;</li>
  426. <li>Field&nbsp;|&nbsp;</li>
  427. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  428. <li><a href="#method.detail">Method</a></li>
  429. </ul>
  430. </div>
  431. <a name="skip.navbar.bottom">
  432. <!-- -->
  433. </a></div>
  434. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  435. </body>
  436. </html>