IntervalXYDelegate.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  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:43 CEST 2014 -->
  6. <title>IntervalXYDelegate (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="IntervalXYDelegate (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,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":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/IntervalXYDelegate.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/data/xy/IntervalXYDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/xy/IntervalXYZDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/xy/IntervalXYDelegate.html" target="_top">Frames</a></li>
  57. <li><a href="IntervalXYDelegate.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.data.xy</div>
  96. <h2 title="Class IntervalXYDelegate" class="title">Class IntervalXYDelegate</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.data.xy.IntervalXYDelegate</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, java.lang.Cloneable, java.util.EventListener, <a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data">DomainInfo</a>, <a href="../../../../org/jfree/data/general/DatasetChangeListener.html" title="interface in org.jfree.data.general">DatasetChangeListener</a>, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.85">IntervalXYDelegate</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/data/general/DatasetChangeListener.html" title="interface in org.jfree.data.general">DatasetChangeListener</a>, <a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data">DomainInfo</a>, java.io.Serializable, java.lang.Cloneable, org.jfree.util.PublicCloneable</pre>
  119. <div class="block">A delegate that handles the specification or automatic calculation of the
  120. interval surrounding the x-values in a dataset. This is used to extend
  121. a regular <a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy"><code>XYDataset</code></a> to support the <a href="../../../../org/jfree/data/xy/IntervalXYDataset.html" title="interface in org.jfree.data.xy"><code>IntervalXYDataset</code></a>
  122. interface.
  123. <p>
  124. The decorator pattern was not used because of the several possibly
  125. implemented interfaces of the decorated instance (e.g.
  126. <a href="../../../../org/jfree/data/xy/TableXYDataset.html" title="interface in org.jfree.data.xy"><code>TableXYDataset</code></a>, <a href="../../../../org/jfree/data/RangeInfo.html" title="interface in org.jfree.data"><code>RangeInfo</code></a>, <a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data"><code>DomainInfo</code></a> etc.).
  127. <p>
  128. The width can be set manually or calculated automatically. The switch
  129. autoWidth allows to determine which behavior is used. The auto width
  130. calculation tries to find the smallest gap between two x-values in the
  131. dataset. If there is only one item in the series, the auto width
  132. calculation fails and falls back on the manually set interval width (which
  133. is itself defaulted to 1.0).</div>
  134. <dl>
  135. <dt><span class="seeLabel">See Also:</span></dt>
  136. <dd><a href="../../../../serialized-form.html#org.jfree.data.xy.IntervalXYDelegate">Serialized Form</a></dd>
  137. </dl>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="summary">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  145. <ul class="blockList">
  146. <li class="blockList"><a name="constructor.summary">
  147. <!-- -->
  148. </a>
  149. <h3>Constructor Summary</h3>
  150. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  151. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  152. <tr>
  153. <th class="colOne" scope="col">Constructor and Description</th>
  154. </tr>
  155. <tr class="altColor">
  156. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#IntervalXYDelegate-org.jfree.data.xy.XYDataset-">IntervalXYDelegate</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset)</code>
  157. <div class="block">Creates a new delegate that.</div>
  158. </td>
  159. </tr>
  160. <tr class="rowColor">
  161. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#IntervalXYDelegate-org.jfree.data.xy.XYDataset-boolean-">IntervalXYDelegate</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  162. boolean&nbsp;autoWidth)</code>
  163. <div class="block">Creates a new delegate for the specified dataset.</div>
  164. </td>
  165. </tr>
  166. </table>
  167. </li>
  168. </ul>
  169. <!-- ========== METHOD SUMMARY =========== -->
  170. <ul class="blockList">
  171. <li class="blockList"><a name="method.summary">
  172. <!-- -->
  173. </a>
  174. <h3>Method Summary</h3>
  175. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  176. <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>
  177. <tr>
  178. <th class="colFirst" scope="col">Modifier and Type</th>
  179. <th class="colLast" scope="col">Method and Description</th>
  180. </tr>
  181. <tr id="i0" class="altColor">
  182. <td class="colFirst"><code>java.lang.Object</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#clone--">clone</a></span>()</code>&nbsp;</td>
  184. </tr>
  185. <tr id="i1" class="rowColor">
  186. <td class="colFirst"><code>void</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#datasetChanged-org.jfree.data.general.DatasetChangeEvent-">datasetChanged</a></span>(<a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general">DatasetChangeEvent</a>&nbsp;e)</code>
  188. <div class="block">Handles events from the dataset by recalculating the interval if
  189. necessary.</div>
  190. </td>
  191. </tr>
  192. <tr id="i2" class="altColor">
  193. <td class="colFirst"><code>boolean</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  195. <div class="block">Tests the delegate for equality with an arbitrary object.</div>
  196. </td>
  197. </tr>
  198. <tr id="i3" class="rowColor">
  199. <td class="colFirst"><code><a href="../../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getDomainBounds-boolean-">getDomainBounds</a></span>(boolean&nbsp;includeInterval)</code>
  201. <div class="block">Returns the range of the values in the dataset's domain, including
  202. or excluding the interval around each x-value as specified.</div>
  203. </td>
  204. </tr>
  205. <tr id="i4" class="altColor">
  206. <td class="colFirst"><code>double</code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getDomainLowerBound-boolean-">getDomainLowerBound</a></span>(boolean&nbsp;includeInterval)</code>
  208. <div class="block">Returns the minimum x-value in the dataset.</div>
  209. </td>
  210. </tr>
  211. <tr id="i5" class="rowColor">
  212. <td class="colFirst"><code>double</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getDomainUpperBound-boolean-">getDomainUpperBound</a></span>(boolean&nbsp;includeInterval)</code>
  214. <div class="block">Returns the maximum x-value in the dataset.</div>
  215. </td>
  216. </tr>
  217. <tr id="i6" class="altColor">
  218. <td class="colFirst"><code>java.lang.Number</code></td>
  219. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getEndX-int-int-">getEndX</a></span>(int&nbsp;series,
  220. int&nbsp;item)</code>
  221. <div class="block">Returns the end value of the x-interval for an item within a series.</div>
  222. </td>
  223. </tr>
  224. <tr id="i7" class="rowColor">
  225. <td class="colFirst"><code>double</code></td>
  226. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getEndXValue-int-int-">getEndXValue</a></span>(int&nbsp;series,
  227. int&nbsp;item)</code>
  228. <div class="block">Returns the end value of the x-interval for an item within a series.</div>
  229. </td>
  230. </tr>
  231. <tr id="i8" class="altColor">
  232. <td class="colFirst"><code>double</code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getFixedIntervalWidth--">getFixedIntervalWidth</a></span>()</code>
  234. <div class="block">Returns the fixed interval width.</div>
  235. </td>
  236. </tr>
  237. <tr id="i9" class="rowColor">
  238. <td class="colFirst"><code>double</code></td>
  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getIntervalPositionFactor--">getIntervalPositionFactor</a></span>()</code>
  240. <div class="block">Returns the interval position factor.</div>
  241. </td>
  242. </tr>
  243. <tr id="i10" class="altColor">
  244. <td class="colFirst"><code>double</code></td>
  245. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getIntervalWidth--">getIntervalWidth</a></span>()</code>
  246. <div class="block">Returns the interval width.</div>
  247. </td>
  248. </tr>
  249. <tr id="i11" class="rowColor">
  250. <td class="colFirst"><code>java.lang.Number</code></td>
  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getStartX-int-int-">getStartX</a></span>(int&nbsp;series,
  252. int&nbsp;item)</code>
  253. <div class="block">Returns the start value of the x-interval for an item within a series.</div>
  254. </td>
  255. </tr>
  256. <tr id="i12" class="altColor">
  257. <td class="colFirst"><code>double</code></td>
  258. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getStartXValue-int-int-">getStartXValue</a></span>(int&nbsp;series,
  259. int&nbsp;item)</code>
  260. <div class="block">Returns the start value of the x-interval for an item within a series.</div>
  261. </td>
  262. </tr>
  263. <tr id="i13" class="rowColor">
  264. <td class="colFirst"><code>int</code></td>
  265. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#hashCode--">hashCode</a></span>()</code>
  266. <div class="block">Returns a hash code for this instance.</div>
  267. </td>
  268. </tr>
  269. <tr id="i14" class="altColor">
  270. <td class="colFirst"><code>boolean</code></td>
  271. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#isAutoWidth--">isAutoWidth</a></span>()</code>
  272. <div class="block">Returns <code>true</code> if the interval width is automatically
  273. calculated, and <code>false</code> otherwise.</div>
  274. </td>
  275. </tr>
  276. <tr id="i15" class="rowColor">
  277. <td class="colFirst"><code>void</code></td>
  278. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#setAutoWidth-boolean-">setAutoWidth</a></span>(boolean&nbsp;b)</code>
  279. <div class="block">Sets the flag that indicates whether the interval width is automatically
  280. calculated.</div>
  281. </td>
  282. </tr>
  283. <tr id="i16" class="altColor">
  284. <td class="colFirst"><code>void</code></td>
  285. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#setFixedIntervalWidth-double-">setFixedIntervalWidth</a></span>(double&nbsp;w)</code>
  286. <div class="block">Sets the fixed interval width and, as a side effect, sets the
  287. <code>autoWidth</code> flag to <code>false</code>.</div>
  288. </td>
  289. </tr>
  290. <tr id="i17" class="rowColor">
  291. <td class="colFirst"><code>void</code></td>
  292. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#setIntervalPositionFactor-double-">setIntervalPositionFactor</a></span>(double&nbsp;d)</code>
  293. <div class="block">Sets the interval position factor.</div>
  294. </td>
  295. </tr>
  296. </table>
  297. <ul class="blockList">
  298. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  299. <!-- -->
  300. </a>
  301. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  302. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </li>
  307. </ul>
  308. </div>
  309. <div class="details">
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  313. <ul class="blockList">
  314. <li class="blockList"><a name="constructor.detail">
  315. <!-- -->
  316. </a>
  317. <h3>Constructor Detail</h3>
  318. <a name="IntervalXYDelegate-org.jfree.data.xy.XYDataset-">
  319. <!-- -->
  320. </a>
  321. <ul class="blockList">
  322. <li class="blockList">
  323. <h4>IntervalXYDelegate</h4>
  324. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.122">IntervalXYDelegate</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset)</pre>
  325. <div class="block">Creates a new delegate that.</div>
  326. <dl>
  327. <dt><span class="paramLabel">Parameters:</span></dt>
  328. <dd><code>dataset</code> - the underlying dataset (<code>null</code> not permitted).</dd>
  329. </dl>
  330. </li>
  331. </ul>
  332. <a name="IntervalXYDelegate-org.jfree.data.xy.XYDataset-boolean-">
  333. <!-- -->
  334. </a>
  335. <ul class="blockListLast">
  336. <li class="blockList">
  337. <h4>IntervalXYDelegate</h4>
  338. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.133">IntervalXYDelegate</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  339. boolean&nbsp;autoWidth)</pre>
  340. <div class="block">Creates a new delegate for the specified dataset.</div>
  341. <dl>
  342. <dt><span class="paramLabel">Parameters:</span></dt>
  343. <dd><code>dataset</code> - the underlying dataset (<code>null</code> not permitted).</dd>
  344. <dd><code>autoWidth</code> - a flag that controls whether the interval width is
  345. calculated automatically.</dd>
  346. </dl>
  347. </li>
  348. </ul>
  349. </li>
  350. </ul>
  351. <!-- ============ METHOD DETAIL ========== -->
  352. <ul class="blockList">
  353. <li class="blockList"><a name="method.detail">
  354. <!-- -->
  355. </a>
  356. <h3>Method Detail</h3>
  357. <a name="isAutoWidth--">
  358. <!-- -->
  359. </a>
  360. <ul class="blockList">
  361. <li class="blockList">
  362. <h4>isAutoWidth</h4>
  363. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.148">isAutoWidth</a>()</pre>
  364. <div class="block">Returns <code>true</code> if the interval width is automatically
  365. calculated, and <code>false</code> otherwise.</div>
  366. <dl>
  367. <dt><span class="returnLabel">Returns:</span></dt>
  368. <dd>A boolean.</dd>
  369. </dl>
  370. </li>
  371. </ul>
  372. <a name="setAutoWidth-boolean-">
  373. <!-- -->
  374. </a>
  375. <ul class="blockList">
  376. <li class="blockList">
  377. <h4>setAutoWidth</h4>
  378. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.163">setAutoWidth</a>(boolean&nbsp;b)</pre>
  379. <div class="block">Sets the flag that indicates whether the interval width is automatically
  380. calculated. If the flag is set to <code>true</code>, the interval is
  381. recalculated.
  382. <p>
  383. Note: recalculating the interval amounts to changing the data values
  384. represented by the dataset. The calling dataset must fire an
  385. appropriate <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a>.</div>
  386. <dl>
  387. <dt><span class="paramLabel">Parameters:</span></dt>
  388. <dd><code>b</code> - a boolean.</dd>
  389. </dl>
  390. </li>
  391. </ul>
  392. <a name="getIntervalPositionFactor--">
  393. <!-- -->
  394. </a>
  395. <ul class="blockList">
  396. <li class="blockList">
  397. <h4>getIntervalPositionFactor</h4>
  398. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.175">getIntervalPositionFactor</a>()</pre>
  399. <div class="block">Returns the interval position factor.</div>
  400. <dl>
  401. <dt><span class="returnLabel">Returns:</span></dt>
  402. <dd>The interval position factor.</dd>
  403. </dl>
  404. </li>
  405. </ul>
  406. <a name="setIntervalPositionFactor-double-">
  407. <!-- -->
  408. </a>
  409. <ul class="blockList">
  410. <li class="blockList">
  411. <h4>setIntervalPositionFactor</h4>
  412. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.195">setIntervalPositionFactor</a>(double&nbsp;d)</pre>
  413. <div class="block">Sets the interval position factor. This controls how the interval is
  414. aligned to the x-value. For a value of 0.5, the interval is aligned
  415. with the x-value in the center. For a value of 0.0, the interval is
  416. aligned with the x-value at the lower end of the interval, and for a
  417. value of 1.0, the interval is aligned with the x-value at the upper
  418. end of the interval.
  419. <br><br>
  420. Note that changing the interval position factor amounts to changing the
  421. data values represented by the dataset. Therefore, the dataset that is
  422. using this delegate is responsible for generating the
  423. appropriate <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a>.</div>
  424. <dl>
  425. <dt><span class="paramLabel">Parameters:</span></dt>
  426. <dd><code>d</code> - the new interval position factor (in the range
  427. <code>0.0</code> to <code>1.0</code> inclusive).</dd>
  428. </dl>
  429. </li>
  430. </ul>
  431. <a name="getFixedIntervalWidth--">
  432. <!-- -->
  433. </a>
  434. <ul class="blockList">
  435. <li class="blockList">
  436. <h4>getFixedIntervalWidth</h4>
  437. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.208">getFixedIntervalWidth</a>()</pre>
  438. <div class="block">Returns the fixed interval width.</div>
  439. <dl>
  440. <dt><span class="returnLabel">Returns:</span></dt>
  441. <dd>The fixed interval width.</dd>
  442. </dl>
  443. </li>
  444. </ul>
  445. <a name="setFixedIntervalWidth-double-">
  446. <!-- -->
  447. </a>
  448. <ul class="blockList">
  449. <li class="blockList">
  450. <h4>setFixedIntervalWidth</h4>
  451. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.223">setFixedIntervalWidth</a>(double&nbsp;w)</pre>
  452. <div class="block">Sets the fixed interval width and, as a side effect, sets the
  453. <code>autoWidth</code> flag to <code>false</code>.
  454. <br><br>
  455. Note that changing the interval width amounts to changing the data
  456. values represented by the dataset. Therefore, the dataset
  457. that is using this delegate is responsible for generating the
  458. appropriate <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a>.</div>
  459. <dl>
  460. <dt><span class="paramLabel">Parameters:</span></dt>
  461. <dd><code>w</code> - the width (negative values not permitted).</dd>
  462. </dl>
  463. </li>
  464. </ul>
  465. <a name="getIntervalWidth--">
  466. <!-- -->
  467. </a>
  468. <ul class="blockList">
  469. <li class="blockList">
  470. <h4>getIntervalWidth</h4>
  471. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.238">getIntervalWidth</a>()</pre>
  472. <div class="block">Returns the interval width. This method will return either the
  473. auto calculated interval width or the manually specified interval
  474. width, depending on the <a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#isAutoWidth--"><code>isAutoWidth()</code></a> result.</div>
  475. <dl>
  476. <dt><span class="returnLabel">Returns:</span></dt>
  477. <dd>The interval width to use.</dd>
  478. </dl>
  479. </li>
  480. </ul>
  481. <a name="getStartX-int-int-">
  482. <!-- -->
  483. </a>
  484. <ul class="blockList">
  485. <li class="blockList">
  486. <h4>getStartX</h4>
  487. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.260">getStartX</a>(int&nbsp;series,
  488. int&nbsp;item)</pre>
  489. <div class="block">Returns the start value of the x-interval for an item within a series.</div>
  490. <dl>
  491. <dt><span class="paramLabel">Parameters:</span></dt>
  492. <dd><code>series</code> - the series index.</dd>
  493. <dd><code>item</code> - the item index.</dd>
  494. <dt><span class="returnLabel">Returns:</span></dt>
  495. <dd>The start value of the x-interval (possibly <code>null</code>).</dd>
  496. <dt><span class="seeLabel">See Also:</span></dt>
  497. <dd><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getStartXValue-int-int-"><code>getStartXValue(int, int)</code></a></dd>
  498. </dl>
  499. </li>
  500. </ul>
  501. <a name="getStartXValue-int-int-">
  502. <!-- -->
  503. </a>
  504. <ul class="blockList">
  505. <li class="blockList">
  506. <h4>getStartXValue</h4>
  507. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.280">getStartXValue</a>(int&nbsp;series,
  508. int&nbsp;item)</pre>
  509. <div class="block">Returns the start value of the x-interval for an item within a series.</div>
  510. <dl>
  511. <dt><span class="paramLabel">Parameters:</span></dt>
  512. <dd><code>series</code> - the series index.</dd>
  513. <dd><code>item</code> - the item index.</dd>
  514. <dt><span class="returnLabel">Returns:</span></dt>
  515. <dd>The start value of the x-interval.</dd>
  516. <dt><span class="seeLabel">See Also:</span></dt>
  517. <dd><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getStartX-int-int-"><code>getStartX(int, int)</code></a></dd>
  518. </dl>
  519. </li>
  520. </ul>
  521. <a name="getEndX-int-int-">
  522. <!-- -->
  523. </a>
  524. <ul class="blockList">
  525. <li class="blockList">
  526. <h4>getEndX</h4>
  527. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.295">getEndX</a>(int&nbsp;series,
  528. int&nbsp;item)</pre>
  529. <div class="block">Returns the end value of the x-interval for an item within a series.</div>
  530. <dl>
  531. <dt><span class="paramLabel">Parameters:</span></dt>
  532. <dd><code>series</code> - the series index.</dd>
  533. <dd><code>item</code> - the item index.</dd>
  534. <dt><span class="returnLabel">Returns:</span></dt>
  535. <dd>The end value of the x-interval (possibly <code>null</code>).</dd>
  536. <dt><span class="seeLabel">See Also:</span></dt>
  537. <dd><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getEndXValue-int-int-"><code>getEndXValue(int, int)</code></a></dd>
  538. </dl>
  539. </li>
  540. </ul>
  541. <a name="getEndXValue-int-int-">
  542. <!-- -->
  543. </a>
  544. <ul class="blockList">
  545. <li class="blockList">
  546. <h4>getEndXValue</h4>
  547. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.315">getEndXValue</a>(int&nbsp;series,
  548. int&nbsp;item)</pre>
  549. <div class="block">Returns the end value of the x-interval for an item within a series.</div>
  550. <dl>
  551. <dt><span class="paramLabel">Parameters:</span></dt>
  552. <dd><code>series</code> - the series index.</dd>
  553. <dd><code>item</code> - the item index.</dd>
  554. <dt><span class="returnLabel">Returns:</span></dt>
  555. <dd>The end value of the x-interval.</dd>
  556. <dt><span class="seeLabel">See Also:</span></dt>
  557. <dd><a href="../../../../org/jfree/data/xy/IntervalXYDelegate.html#getEndX-int-int-"><code>getEndX(int, int)</code></a></dd>
  558. </dl>
  559. </li>
  560. </ul>
  561. <a name="getDomainLowerBound-boolean-">
  562. <!-- -->
  563. </a>
  564. <ul class="blockList">
  565. <li class="blockList">
  566. <h4>getDomainLowerBound</h4>
  567. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.329">getDomainLowerBound</a>(boolean&nbsp;includeInterval)</pre>
  568. <div class="block">Returns the minimum x-value in the dataset.</div>
  569. <dl>
  570. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  571. <dd><code><a href="../../../../org/jfree/data/DomainInfo.html#getDomainLowerBound-boolean-">getDomainLowerBound</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data">DomainInfo</a></code></dd>
  572. <dt><span class="paramLabel">Parameters:</span></dt>
  573. <dd><code>includeInterval</code> - a flag that determines whether or not the
  574. x-interval is taken into account.</dd>
  575. <dt><span class="returnLabel">Returns:</span></dt>
  576. <dd>The minimum value.</dd>
  577. </dl>
  578. </li>
  579. </ul>
  580. <a name="getDomainUpperBound-boolean-">
  581. <!-- -->
  582. </a>
  583. <ul class="blockList">
  584. <li class="blockList">
  585. <h4>getDomainUpperBound</h4>
  586. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.347">getDomainUpperBound</a>(boolean&nbsp;includeInterval)</pre>
  587. <div class="block">Returns the maximum x-value in the dataset.</div>
  588. <dl>
  589. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  590. <dd><code><a href="../../../../org/jfree/data/DomainInfo.html#getDomainUpperBound-boolean-">getDomainUpperBound</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data">DomainInfo</a></code></dd>
  591. <dt><span class="paramLabel">Parameters:</span></dt>
  592. <dd><code>includeInterval</code> - a flag that determines whether or not the
  593. x-interval is taken into account.</dd>
  594. <dt><span class="returnLabel">Returns:</span></dt>
  595. <dd>The maximum value.</dd>
  596. </dl>
  597. </li>
  598. </ul>
  599. <a name="getDomainBounds-boolean-">
  600. <!-- -->
  601. </a>
  602. <ul class="blockList">
  603. <li class="blockList">
  604. <h4>getDomainBounds</h4>
  605. <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/data/xy/IntervalXYDelegate.html#line.366">getDomainBounds</a>(boolean&nbsp;includeInterval)</pre>
  606. <div class="block">Returns the range of the values in the dataset's domain, including
  607. or excluding the interval around each x-value as specified.</div>
  608. <dl>
  609. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  610. <dd><code><a href="../../../../org/jfree/data/DomainInfo.html#getDomainBounds-boolean-">getDomainBounds</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/DomainInfo.html" title="interface in org.jfree.data">DomainInfo</a></code></dd>
  611. <dt><span class="paramLabel">Parameters:</span></dt>
  612. <dd><code>includeInterval</code> - a flag that determines whether or not the
  613. x-interval should be taken into account.</dd>
  614. <dt><span class="returnLabel">Returns:</span></dt>
  615. <dd>The range.</dd>
  616. </dl>
  617. </li>
  618. </ul>
  619. <a name="datasetChanged-org.jfree.data.general.DatasetChangeEvent-">
  620. <!-- -->
  621. </a>
  622. <ul class="blockList">
  623. <li class="blockList">
  624. <h4>datasetChanged</h4>
  625. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.386">datasetChanged</a>(<a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general">DatasetChangeEvent</a>&nbsp;e)</pre>
  626. <div class="block">Handles events from the dataset by recalculating the interval if
  627. necessary.</div>
  628. <dl>
  629. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  630. <dd><code><a href="../../../../org/jfree/data/general/DatasetChangeListener.html#datasetChanged-org.jfree.data.general.DatasetChangeEvent-">datasetChanged</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/DatasetChangeListener.html" title="interface in org.jfree.data.general">DatasetChangeListener</a></code></dd>
  631. <dt><span class="paramLabel">Parameters:</span></dt>
  632. <dd><code>e</code> - the event.</dd>
  633. </dl>
  634. </li>
  635. </ul>
  636. <a name="equals-java.lang.Object-">
  637. <!-- -->
  638. </a>
  639. <ul class="blockList">
  640. <li class="blockList">
  641. <h4>equals</h4>
  642. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.444">equals</a>(java.lang.Object&nbsp;obj)</pre>
  643. <div class="block">Tests the delegate for equality with an arbitrary object. The
  644. equality test considers two delegates to be equal if they would
  645. calculate the same intervals for any given dataset (for this reason, the
  646. dataset itself is NOT included in the equality test, because it is just
  647. a reference back to the current 'owner' of the delegate).</div>
  648. <dl>
  649. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  650. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  651. <dt><span class="paramLabel">Parameters:</span></dt>
  652. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  653. <dt><span class="returnLabel">Returns:</span></dt>
  654. <dd>A boolean.</dd>
  655. </dl>
  656. </li>
  657. </ul>
  658. <a name="clone--">
  659. <!-- -->
  660. </a>
  661. <ul class="blockList">
  662. <li class="blockList">
  663. <h4>clone</h4>
  664. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.470">clone</a>()
  665. throws java.lang.CloneNotSupportedException</pre>
  666. <dl>
  667. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  668. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  669. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  670. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  671. <dt><span class="returnLabel">Returns:</span></dt>
  672. <dd>A clone of this delegate.</dd>
  673. <dt><span class="throwsLabel">Throws:</span></dt>
  674. <dd><code>java.lang.CloneNotSupportedException</code> - if the object cannot be cloned.</dd>
  675. </dl>
  676. </li>
  677. </ul>
  678. <a name="hashCode--">
  679. <!-- -->
  680. </a>
  681. <ul class="blockListLast">
  682. <li class="blockList">
  683. <h4>hashCode</h4>
  684. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/xy/IntervalXYDelegate.html#line.480">hashCode</a>()</pre>
  685. <div class="block">Returns a hash code for this instance.</div>
  686. <dl>
  687. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  688. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  689. <dt><span class="returnLabel">Returns:</span></dt>
  690. <dd>A hash code.</dd>
  691. </dl>
  692. </li>
  693. </ul>
  694. </li>
  695. </ul>
  696. </li>
  697. </ul>
  698. </div>
  699. </div>
  700. <!-- ========= END OF CLASS DATA ========= -->
  701. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  702. <div class="bottomNav"><a name="navbar.bottom">
  703. <!-- -->
  704. </a>
  705. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  706. <a name="navbar.bottom.firstrow">
  707. <!-- -->
  708. </a>
  709. <ul class="navList" title="Navigation">
  710. <li><a href="../../../../overview-summary.html">Overview</a></li>
  711. <li><a href="package-summary.html">Package</a></li>
  712. <li class="navBarCell1Rev">Class</li>
  713. <li><a href="class-use/IntervalXYDelegate.html">Use</a></li>
  714. <li><a href="package-tree.html">Tree</a></li>
  715. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  716. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  717. <li><a href="../../../../help-doc.html">Help</a></li>
  718. </ul>
  719. </div>
  720. <div class="subNav">
  721. <ul class="navList">
  722. <li><a href="../../../../org/jfree/data/xy/IntervalXYDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  723. <li><a href="../../../../org/jfree/data/xy/IntervalXYZDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  724. </ul>
  725. <ul class="navList">
  726. <li><a href="../../../../index.html?org/jfree/data/xy/IntervalXYDelegate.html" target="_top">Frames</a></li>
  727. <li><a href="IntervalXYDelegate.html" target="_top">No&nbsp;Frames</a></li>
  728. </ul>
  729. <ul class="navList" id="allclasses_navbar_bottom">
  730. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  731. </ul>
  732. <div>
  733. <script type="text/javascript"><!--
  734. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  735. if(window==top) {
  736. allClassesLink.style.display = "block";
  737. }
  738. else {
  739. allClassesLink.style.display = "none";
  740. }
  741. //-->
  742. </script>
  743. </div>
  744. <div>
  745. <ul class="subNavList">
  746. <li>Summary:&nbsp;</li>
  747. <li>Nested&nbsp;|&nbsp;</li>
  748. <li>Field&nbsp;|&nbsp;</li>
  749. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  750. <li><a href="#method.summary">Method</a></li>
  751. </ul>
  752. <ul class="subNavList">
  753. <li>Detail:&nbsp;</li>
  754. <li>Field&nbsp;|&nbsp;</li>
  755. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  756. <li><a href="#method.detail">Method</a></li>
  757. </ul>
  758. </div>
  759. <a name="skip.navbar.bottom">
  760. <!-- -->
  761. </a></div>
  762. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  763. </body>
  764. </html>