StandardCrosshairLabelGenerator.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  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:31 CEST 2014 -->
  6. <title>StandardCrosshairLabelGenerator (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="StandardCrosshairLabelGenerator (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};
  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/StandardCrosshairLabelGenerator.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/labels/StandardContourToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardCrosshairLabelGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="StandardCrosshairLabelGenerator.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.labels</div>
  96. <h2 title="Class StandardCrosshairLabelGenerator" class="title">Class StandardCrosshairLabelGenerator</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.labels.StandardCrosshairLabelGenerator</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, <a href="../../../../org/jfree/chart/labels/CrosshairLabelGenerator.html" title="interface in org.jfree.chart.labels">CrosshairLabelGenerator</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.53">StandardCrosshairLabelGenerator</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/labels/CrosshairLabelGenerator.html" title="interface in org.jfree.chart.labels">CrosshairLabelGenerator</a>, java.io.Serializable</pre>
  119. <div class="block">A default label generator.</div>
  120. <dl>
  121. <dt><span class="simpleTagLabel">Since:</span></dt>
  122. <dd>1.0.13</dd>
  123. <dt><span class="seeLabel">See Also:</span></dt>
  124. <dd><a href="../../../../serialized-form.html#org.jfree.chart.labels.StandardCrosshairLabelGenerator">Serialized Form</a></dd>
  125. </dl>
  126. </li>
  127. </ul>
  128. </div>
  129. <div class="summary">
  130. <ul class="blockList">
  131. <li class="blockList">
  132. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  133. <ul class="blockList">
  134. <li class="blockList"><a name="constructor.summary">
  135. <!-- -->
  136. </a>
  137. <h3>Constructor Summary</h3>
  138. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  139. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  140. <tr>
  141. <th class="colOne" scope="col">Constructor and Description</th>
  142. </tr>
  143. <tr class="altColor">
  144. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#StandardCrosshairLabelGenerator--">StandardCrosshairLabelGenerator</a></span>()</code>
  145. <div class="block">Creates a new instance with default attributes.</div>
  146. </td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#StandardCrosshairLabelGenerator-java.lang.String-java.text.NumberFormat-">StandardCrosshairLabelGenerator</a></span>(java.lang.String&nbsp;labelTemplate,
  150. java.text.NumberFormat&nbsp;numberFormat)</code>
  151. <div class="block">Creates a new instance with the specified attributes.</div>
  152. </td>
  153. </tr>
  154. </table>
  155. </li>
  156. </ul>
  157. <!-- ========== METHOD SUMMARY =========== -->
  158. <ul class="blockList">
  159. <li class="blockList"><a name="method.summary">
  160. <!-- -->
  161. </a>
  162. <h3>Method Summary</h3>
  163. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  164. <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>
  165. <tr>
  166. <th class="colFirst" scope="col">Modifier and Type</th>
  167. <th class="colLast" scope="col">Method and Description</th>
  168. </tr>
  169. <tr id="i0" class="altColor">
  170. <td class="colFirst"><code>boolean</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  172. <div class="block">Tests this generator for equality with an arbitrary object.</div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>java.lang.String</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#generateLabel-org.jfree.chart.plot.Crosshair-">generateLabel</a></span>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</code>
  178. <div class="block">Returns a string that can be used as the label for a crosshair.</div>
  179. </td>
  180. </tr>
  181. <tr id="i2" class="altColor">
  182. <td class="colFirst"><code>java.lang.String</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#getLabelTemplate--">getLabelTemplate</a></span>()</code>
  184. <div class="block">Returns the label template string.</div>
  185. </td>
  186. </tr>
  187. <tr id="i3" class="rowColor">
  188. <td class="colFirst"><code>java.text.NumberFormat</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#getNumberFormat--">getNumberFormat</a></span>()</code>
  190. <div class="block">Returns the number formatter.</div>
  191. </td>
  192. </tr>
  193. <tr id="i4" class="altColor">
  194. <td class="colFirst"><code>int</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#hashCode--">hashCode</a></span>()</code>
  196. <div class="block">Returns a hash code for this instance.</div>
  197. </td>
  198. </tr>
  199. </table>
  200. <ul class="blockList">
  201. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  202. <!-- -->
  203. </a>
  204. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  205. <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  206. </ul>
  207. </li>
  208. </ul>
  209. </li>
  210. </ul>
  211. </div>
  212. <div class="details">
  213. <ul class="blockList">
  214. <li class="blockList">
  215. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  216. <ul class="blockList">
  217. <li class="blockList"><a name="constructor.detail">
  218. <!-- -->
  219. </a>
  220. <h3>Constructor Detail</h3>
  221. <a name="StandardCrosshairLabelGenerator--">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>StandardCrosshairLabelGenerator</h4>
  227. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.65">StandardCrosshairLabelGenerator</a>()</pre>
  228. <div class="block">Creates a new instance with default attributes.</div>
  229. </li>
  230. </ul>
  231. <a name="StandardCrosshairLabelGenerator-java.lang.String-java.text.NumberFormat-">
  232. <!-- -->
  233. </a>
  234. <ul class="blockListLast">
  235. <li class="blockList">
  236. <h4>StandardCrosshairLabelGenerator</h4>
  237. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.77">StandardCrosshairLabelGenerator</a>(java.lang.String&nbsp;labelTemplate,
  238. java.text.NumberFormat&nbsp;numberFormat)</pre>
  239. <div class="block">Creates a new instance with the specified attributes.</div>
  240. <dl>
  241. <dt><span class="paramLabel">Parameters:</span></dt>
  242. <dd><code>labelTemplate</code> - the label template (<code>null</code> not
  243. permitted).</dd>
  244. <dd><code>numberFormat</code> - the number formatter (<code>null</code> not
  245. permitted).</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. </li>
  250. </ul>
  251. <!-- ============ METHOD DETAIL ========== -->
  252. <ul class="blockList">
  253. <li class="blockList"><a name="method.detail">
  254. <!-- -->
  255. </a>
  256. <h3>Method Detail</h3>
  257. <a name="getLabelTemplate--">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>getLabelTemplate</h4>
  263. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.97">getLabelTemplate</a>()</pre>
  264. <div class="block">Returns the label template string.</div>
  265. <dl>
  266. <dt><span class="returnLabel">Returns:</span></dt>
  267. <dd>The label template string (never <code>null</code>).</dd>
  268. </dl>
  269. </li>
  270. </ul>
  271. <a name="getNumberFormat--">
  272. <!-- -->
  273. </a>
  274. <ul class="blockList">
  275. <li class="blockList">
  276. <h4>getNumberFormat</h4>
  277. <pre>public&nbsp;java.text.NumberFormat&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.106">getNumberFormat</a>()</pre>
  278. <div class="block">Returns the number formatter.</div>
  279. <dl>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>The formatter (never <code>null</code>).</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="generateLabel-org.jfree.chart.plot.Crosshair-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>generateLabel</h4>
  291. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.118">generateLabel</a>(<a href="../../../../org/jfree/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot">Crosshair</a>&nbsp;crosshair)</pre>
  292. <div class="block">Returns a string that can be used as the label for a crosshair.</div>
  293. <dl>
  294. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  295. <dd><code><a href="../../../../org/jfree/chart/labels/CrosshairLabelGenerator.html#generateLabel-org.jfree.chart.plot.Crosshair-">generateLabel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/labels/CrosshairLabelGenerator.html" title="interface in org.jfree.chart.labels">CrosshairLabelGenerator</a></code></dd>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>crosshair</code> - the crosshair (<code>null</code> not permitted).</dd>
  298. <dt><span class="returnLabel">Returns:</span></dt>
  299. <dd>The label (possibly <code>null</code>).</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. <a name="equals-java.lang.Object-">
  304. <!-- -->
  305. </a>
  306. <ul class="blockList">
  307. <li class="blockList">
  308. <h4>equals</h4>
  309. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.133">equals</a>(java.lang.Object&nbsp;obj)</pre>
  310. <div class="block">Tests this generator for equality with an arbitrary object.</div>
  311. <dl>
  312. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  313. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  314. <dt><span class="paramLabel">Parameters:</span></dt>
  315. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  316. <dt><span class="returnLabel">Returns:</span></dt>
  317. <dd>A boolean.</dd>
  318. </dl>
  319. </li>
  320. </ul>
  321. <a name="hashCode--">
  322. <!-- -->
  323. </a>
  324. <ul class="blockListLast">
  325. <li class="blockList">
  326. <h4>hashCode</h4>
  327. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/StandardCrosshairLabelGenerator.html#line.157">hashCode</a>()</pre>
  328. <div class="block">Returns a hash code for this instance.</div>
  329. <dl>
  330. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  331. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  332. <dt><span class="returnLabel">Returns:</span></dt>
  333. <dd>A hash code for this instance.</dd>
  334. </dl>
  335. </li>
  336. </ul>
  337. </li>
  338. </ul>
  339. </li>
  340. </ul>
  341. </div>
  342. </div>
  343. <!-- ========= END OF CLASS DATA ========= -->
  344. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  345. <div class="bottomNav"><a name="navbar.bottom">
  346. <!-- -->
  347. </a>
  348. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  349. <a name="navbar.bottom.firstrow">
  350. <!-- -->
  351. </a>
  352. <ul class="navList" title="Navigation">
  353. <li><a href="../../../../overview-summary.html">Overview</a></li>
  354. <li><a href="package-summary.html">Package</a></li>
  355. <li class="navBarCell1Rev">Class</li>
  356. <li><a href="class-use/StandardCrosshairLabelGenerator.html">Use</a></li>
  357. <li><a href="package-tree.html">Tree</a></li>
  358. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  359. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  360. <li><a href="../../../../help-doc.html">Help</a></li>
  361. </ul>
  362. </div>
  363. <div class="subNav">
  364. <ul class="navList">
  365. <li><a href="../../../../org/jfree/chart/labels/StandardContourToolTipGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  366. <li><a href="../../../../org/jfree/chart/labels/StandardPieSectionLabelGenerator.html" title="class in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  367. </ul>
  368. <ul class="navList">
  369. <li><a href="../../../../index.html?org/jfree/chart/labels/StandardCrosshairLabelGenerator.html" target="_top">Frames</a></li>
  370. <li><a href="StandardCrosshairLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  371. </ul>
  372. <ul class="navList" id="allclasses_navbar_bottom">
  373. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  374. </ul>
  375. <div>
  376. <script type="text/javascript"><!--
  377. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  378. if(window==top) {
  379. allClassesLink.style.display = "block";
  380. }
  381. else {
  382. allClassesLink.style.display = "none";
  383. }
  384. //-->
  385. </script>
  386. </div>
  387. <div>
  388. <ul class="subNavList">
  389. <li>Summary:&nbsp;</li>
  390. <li>Nested&nbsp;|&nbsp;</li>
  391. <li>Field&nbsp;|&nbsp;</li>
  392. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  393. <li><a href="#method.summary">Method</a></li>
  394. </ul>
  395. <ul class="subNavList">
  396. <li>Detail:&nbsp;</li>
  397. <li>Field&nbsp;|&nbsp;</li>
  398. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  399. <li><a href="#method.detail">Method</a></li>
  400. </ul>
  401. </div>
  402. <a name="skip.navbar.bottom">
  403. <!-- -->
  404. </a></div>
  405. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  406. </body>
  407. </html>