ValueTick.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:28 CEST 2014 -->
  6. <title>ValueTick (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="ValueTick (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/ValueTick.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/axis/ValueAxis.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li>Next&nbsp;Class</li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/axis/ValueTick.html" target="_top">Frames</a></li>
  57. <li><a href="ValueTick.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.axis</div>
  96. <h2 title="Class ValueTick" class="title">Class ValueTick</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><a href="../../../../org/jfree/chart/axis/Tick.html" title="class in org.jfree.chart.axis">org.jfree.chart.axis.Tick</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.chart.axis.ValueTick</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, java.lang.Cloneable</dd>
  118. </dl>
  119. <dl>
  120. <dt>Direct Known Subclasses:</dt>
  121. <dd><a href="../../../../org/jfree/chart/axis/DateTick.html" title="class in org.jfree.chart.axis">DateTick</a>, <a href="../../../../org/jfree/chart/axis/LogTick.html" title="class in org.jfree.chart.axis">LogTick</a>, <a href="../../../../org/jfree/chart/axis/NumberTick.html" title="class in org.jfree.chart.axis">NumberTick</a></dd>
  122. </dl>
  123. <hr>
  124. <br>
  125. <pre>public abstract class <a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.49">ValueTick</a>
  126. extends <a href="../../../../org/jfree/chart/axis/Tick.html" title="class in org.jfree.chart.axis">Tick</a></pre>
  127. <div class="block">A value tick.</div>
  128. <dl>
  129. <dt><span class="seeLabel">See Also:</span></dt>
  130. <dd><a href="../../../../serialized-form.html#org.jfree.chart.axis.ValueTick">Serialized Form</a></dd>
  131. </dl>
  132. </li>
  133. </ul>
  134. </div>
  135. <div class="summary">
  136. <ul class="blockList">
  137. <li class="blockList">
  138. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  139. <ul class="blockList">
  140. <li class="blockList"><a name="constructor.summary">
  141. <!-- -->
  142. </a>
  143. <h3>Constructor Summary</h3>
  144. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  145. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  146. <tr>
  147. <th class="colOne" scope="col">Constructor and Description</th>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/ValueTick.html#ValueTick-double-java.lang.String-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">ValueTick</a></span>(double&nbsp;value,
  151. java.lang.String&nbsp;label,
  152. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  153. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  154. double&nbsp;angle)</code>
  155. <div class="block">Creates a new value tick.</div>
  156. </td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/ValueTick.html#ValueTick-org.jfree.chart.axis.TickType-double-java.lang.String-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">ValueTick</a></span>(<a href="../../../../org/jfree/chart/axis/TickType.html" title="class in org.jfree.chart.axis">TickType</a>&nbsp;tickType,
  160. double&nbsp;value,
  161. java.lang.String&nbsp;label,
  162. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  163. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  164. double&nbsp;angle)</code>
  165. <div class="block">Creates a new value tick.</div>
  166. </td>
  167. </tr>
  168. </table>
  169. </li>
  170. </ul>
  171. <!-- ========== METHOD SUMMARY =========== -->
  172. <ul class="blockList">
  173. <li class="blockList"><a name="method.summary">
  174. <!-- -->
  175. </a>
  176. <h3>Method Summary</h3>
  177. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  178. <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>
  179. <tr>
  180. <th class="colFirst" scope="col">Modifier and Type</th>
  181. <th class="colLast" scope="col">Method and Description</th>
  182. </tr>
  183. <tr id="i0" class="altColor">
  184. <td class="colFirst"><code>boolean</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/ValueTick.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  186. <div class="block">Tests this tick for equality with an arbitrary object.</div>
  187. </td>
  188. </tr>
  189. <tr id="i1" class="rowColor">
  190. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/TickType.html" title="class in org.jfree.chart.axis">TickType</a></code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/ValueTick.html#getTickType--">getTickType</a></span>()</code>
  192. <div class="block">Returns the tick type (major or minor).</div>
  193. </td>
  194. </tr>
  195. <tr id="i2" class="altColor">
  196. <td class="colFirst"><code>double</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/ValueTick.html#getValue--">getValue</a></span>()</code>
  198. <div class="block">Returns the value.</div>
  199. </td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.axis.Tick">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from class&nbsp;org.jfree.chart.axis.<a href="../../../../org/jfree/chart/axis/Tick.html" title="class in org.jfree.chart.axis">Tick</a></h3>
  207. <code><a href="../../../../org/jfree/chart/axis/Tick.html#clone--">clone</a>, <a href="../../../../org/jfree/chart/axis/Tick.html#getAngle--">getAngle</a>, <a href="../../../../org/jfree/chart/axis/Tick.html#getRotationAnchor--">getRotationAnchor</a>, <a href="../../../../org/jfree/chart/axis/Tick.html#getText--">getText</a>, <a href="../../../../org/jfree/chart/axis/Tick.html#getTextAnchor--">getTextAnchor</a>, <a href="../../../../org/jfree/chart/axis/Tick.html#toString--">toString</a></code></li>
  208. </ul>
  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>finalize, getClass, hashCode, notify, notifyAll, 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="ValueTick-double-java.lang.String-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>ValueTick</h4>
  236. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.71">ValueTick</a>(double&nbsp;value,
  237. java.lang.String&nbsp;label,
  238. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  239. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  240. double&nbsp;angle)</pre>
  241. <div class="block">Creates a new value tick.</div>
  242. <dl>
  243. <dt><span class="paramLabel">Parameters:</span></dt>
  244. <dd><code>value</code> - the value.</dd>
  245. <dd><code>label</code> - the label.</dd>
  246. <dd><code>textAnchor</code> - the part of the label that is aligned to the anchor
  247. point.</dd>
  248. <dd><code>rotationAnchor</code> - defines the rotation point relative to the label.</dd>
  249. <dd><code>angle</code> - the rotation angle (in radians).</dd>
  250. </dl>
  251. </li>
  252. </ul>
  253. <a name="ValueTick-org.jfree.chart.axis.TickType-double-java.lang.String-org.jfree.ui.TextAnchor-org.jfree.ui.TextAnchor-double-">
  254. <!-- -->
  255. </a>
  256. <ul class="blockListLast">
  257. <li class="blockList">
  258. <h4>ValueTick</h4>
  259. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.94">ValueTick</a>(<a href="../../../../org/jfree/chart/axis/TickType.html" title="class in org.jfree.chart.axis">TickType</a>&nbsp;tickType,
  260. double&nbsp;value,
  261. java.lang.String&nbsp;label,
  262. org.jfree.ui.TextAnchor&nbsp;textAnchor,
  263. org.jfree.ui.TextAnchor&nbsp;rotationAnchor,
  264. double&nbsp;angle)</pre>
  265. <div class="block">Creates a new value tick.</div>
  266. <dl>
  267. <dt><span class="paramLabel">Parameters:</span></dt>
  268. <dd><code>tickType</code> - the tick type (major or minor, <code>null</code> not
  269. permitted).</dd>
  270. <dd><code>value</code> - the value.</dd>
  271. <dd><code>label</code> - the label.</dd>
  272. <dd><code>textAnchor</code> - the part of the label that is aligned to the anchor
  273. point.</dd>
  274. <dd><code>rotationAnchor</code> - defines the rotation point relative to the label.</dd>
  275. <dd><code>angle</code> - the rotation angle (in radians).</dd>
  276. <dt><span class="simpleTagLabel">Since:</span></dt>
  277. <dd>1.0.7</dd>
  278. </dl>
  279. </li>
  280. </ul>
  281. </li>
  282. </ul>
  283. <!-- ============ METHOD DETAIL ========== -->
  284. <ul class="blockList">
  285. <li class="blockList"><a name="method.detail">
  286. <!-- -->
  287. </a>
  288. <h3>Method Detail</h3>
  289. <a name="getValue--">
  290. <!-- -->
  291. </a>
  292. <ul class="blockList">
  293. <li class="blockList">
  294. <h4>getValue</h4>
  295. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.108">getValue</a>()</pre>
  296. <div class="block">Returns the value.</div>
  297. <dl>
  298. <dt><span class="returnLabel">Returns:</span></dt>
  299. <dd>The value.</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. <a name="getTickType--">
  304. <!-- -->
  305. </a>
  306. <ul class="blockList">
  307. <li class="blockList">
  308. <h4>getTickType</h4>
  309. <pre>public&nbsp;<a href="../../../../org/jfree/chart/axis/TickType.html" title="class in org.jfree.chart.axis">TickType</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.119">getTickType</a>()</pre>
  310. <div class="block">Returns the tick type (major or minor).</div>
  311. <dl>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>The tick type.</dd>
  314. <dt><span class="simpleTagLabel">Since:</span></dt>
  315. <dd>1.0.7</dd>
  316. </dl>
  317. </li>
  318. </ul>
  319. <a name="equals-java.lang.Object-">
  320. <!-- -->
  321. </a>
  322. <ul class="blockListLast">
  323. <li class="blockList">
  324. <h4>equals</h4>
  325. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/ValueTick.html#line.131">equals</a>(java.lang.Object&nbsp;obj)</pre>
  326. <div class="block">Tests this tick for equality with an arbitrary object.</div>
  327. <dl>
  328. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  329. <dd><code><a href="../../../../org/jfree/chart/axis/Tick.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/axis/Tick.html" title="class in org.jfree.chart.axis">Tick</a></code></dd>
  330. <dt><span class="paramLabel">Parameters:</span></dt>
  331. <dd><code>obj</code> - the object to test (<code>null</code> permitted).</dd>
  332. <dt><span class="returnLabel">Returns:</span></dt>
  333. <dd>A boolean.</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/ValueTick.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/axis/ValueAxis.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  366. <li>Next&nbsp;Class</li>
  367. </ul>
  368. <ul class="navList">
  369. <li><a href="../../../../index.html?org/jfree/chart/axis/ValueTick.html" target="_top">Frames</a></li>
  370. <li><a href="ValueTick.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>