BlockParams.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  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>BlockParams (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="BlockParams (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/BlockParams.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/block/BlockFrame.html" title="interface in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/block/BlockResult.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/block/BlockParams.html" target="_top">Frames</a></li>
  57. <li><a href="BlockParams.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.block</div>
  96. <h2 title="Class BlockParams" class="title">Class BlockParams</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.block.BlockParams</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><a href="../../../../org/jfree/chart/block/EntityBlockParams.html" title="interface in org.jfree.chart.block">EntityBlockParams</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.47">BlockParams</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/block/EntityBlockParams.html" title="interface in org.jfree.chart.block">EntityBlockParams</a></pre>
  119. <div class="block">A standard parameter object that can be passed to the draw() method defined
  120. by the <a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block"><code>Block</code></a> class.</div>
  121. </li>
  122. </ul>
  123. </div>
  124. <div class="summary">
  125. <ul class="blockList">
  126. <li class="blockList">
  127. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  128. <ul class="blockList">
  129. <li class="blockList"><a name="constructor.summary">
  130. <!-- -->
  131. </a>
  132. <h3>Constructor Summary</h3>
  133. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  134. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  135. <tr>
  136. <th class="colOne" scope="col">Constructor and Description</th>
  137. </tr>
  138. <tr class="altColor">
  139. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#BlockParams--">BlockParams</a></span>()</code>
  140. <div class="block">Creates a new instance.</div>
  141. </td>
  142. </tr>
  143. </table>
  144. </li>
  145. </ul>
  146. <!-- ========== METHOD SUMMARY =========== -->
  147. <ul class="blockList">
  148. <li class="blockList"><a name="method.summary">
  149. <!-- -->
  150. </a>
  151. <h3>Method Summary</h3>
  152. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  153. <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>
  154. <tr>
  155. <th class="colFirst" scope="col">Modifier and Type</th>
  156. <th class="colLast" scope="col">Method and Description</th>
  157. </tr>
  158. <tr id="i0" class="altColor">
  159. <td class="colFirst"><code>boolean</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#getGenerateEntities--">getGenerateEntities</a></span>()</code>
  161. <div class="block">Returns the flag that controls whether or not chart entities are
  162. generated.</div>
  163. </td>
  164. </tr>
  165. <tr id="i1" class="rowColor">
  166. <td class="colFirst"><code>double</code></td>
  167. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#getTranslateX--">getTranslateX</a></span>()</code>
  168. <div class="block">Returns the translation required to convert local x-coordinates back to
  169. the coordinate space of the container.</div>
  170. </td>
  171. </tr>
  172. <tr id="i2" class="altColor">
  173. <td class="colFirst"><code>double</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#getTranslateY--">getTranslateY</a></span>()</code>
  175. <div class="block">Returns the translation required to convert local y-coordinates back to
  176. the coordinate space of the container.</div>
  177. </td>
  178. </tr>
  179. <tr id="i3" class="rowColor">
  180. <td class="colFirst"><code>void</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#setGenerateEntities-boolean-">setGenerateEntities</a></span>(boolean&nbsp;generate)</code>
  182. <div class="block">Sets the flag that controls whether or not chart entities are generated.</div>
  183. </td>
  184. </tr>
  185. <tr id="i4" class="altColor">
  186. <td class="colFirst"><code>void</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#setTranslateX-double-">setTranslateX</a></span>(double&nbsp;x)</code>
  188. <div class="block">Sets the translation required to convert local x-coordinates into the
  189. coordinate space of the container.</div>
  190. </td>
  191. </tr>
  192. <tr id="i5" class="rowColor">
  193. <td class="colFirst"><code>void</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/BlockParams.html#setTranslateY-double-">setTranslateY</a></span>(double&nbsp;y)</code>
  195. <div class="block">Sets the translation required to convert local y-coordinates into the
  196. coordinate space of the container.</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, equals, finalize, getClass, hashCode, 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="BlockParams--">
  222. <!-- -->
  223. </a>
  224. <ul class="blockListLast">
  225. <li class="blockList">
  226. <h4>BlockParams</h4>
  227. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.72">BlockParams</a>()</pre>
  228. <div class="block">Creates a new instance.</div>
  229. </li>
  230. </ul>
  231. </li>
  232. </ul>
  233. <!-- ============ METHOD DETAIL ========== -->
  234. <ul class="blockList">
  235. <li class="blockList"><a name="method.detail">
  236. <!-- -->
  237. </a>
  238. <h3>Method Detail</h3>
  239. <a name="getGenerateEntities--">
  240. <!-- -->
  241. </a>
  242. <ul class="blockList">
  243. <li class="blockList">
  244. <h4>getGenerateEntities</h4>
  245. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.85">getGenerateEntities</a>()</pre>
  246. <div class="block">Returns the flag that controls whether or not chart entities are
  247. generated.</div>
  248. <dl>
  249. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  250. <dd><code><a href="../../../../org/jfree/chart/block/EntityBlockParams.html#getGenerateEntities--">getGenerateEntities</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/block/EntityBlockParams.html" title="interface in org.jfree.chart.block">EntityBlockParams</a></code></dd>
  251. <dt><span class="returnLabel">Returns:</span></dt>
  252. <dd>A boolean.</dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. <a name="setGenerateEntities-boolean-">
  257. <!-- -->
  258. </a>
  259. <ul class="blockList">
  260. <li class="blockList">
  261. <h4>setGenerateEntities</h4>
  262. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.94">setGenerateEntities</a>(boolean&nbsp;generate)</pre>
  263. <div class="block">Sets the flag that controls whether or not chart entities are generated.</div>
  264. <dl>
  265. <dt><span class="paramLabel">Parameters:</span></dt>
  266. <dd><code>generate</code> - the flag.</dd>
  267. </dl>
  268. </li>
  269. </ul>
  270. <a name="getTranslateX--">
  271. <!-- -->
  272. </a>
  273. <ul class="blockList">
  274. <li class="blockList">
  275. <h4>getTranslateX</h4>
  276. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.104">getTranslateX</a>()</pre>
  277. <div class="block">Returns the translation required to convert local x-coordinates back to
  278. the coordinate space of the container.</div>
  279. <dl>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>The x-translation amount.</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="setTranslateX-double-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>setTranslateX</h4>
  291. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.114">setTranslateX</a>(double&nbsp;x)</pre>
  292. <div class="block">Sets the translation required to convert local x-coordinates into the
  293. coordinate space of the container.</div>
  294. <dl>
  295. <dt><span class="paramLabel">Parameters:</span></dt>
  296. <dd><code>x</code> - the x-translation amount.</dd>
  297. </dl>
  298. </li>
  299. </ul>
  300. <a name="getTranslateY--">
  301. <!-- -->
  302. </a>
  303. <ul class="blockList">
  304. <li class="blockList">
  305. <h4>getTranslateY</h4>
  306. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.124">getTranslateY</a>()</pre>
  307. <div class="block">Returns the translation required to convert local y-coordinates back to
  308. the coordinate space of the container.</div>
  309. <dl>
  310. <dt><span class="returnLabel">Returns:</span></dt>
  311. <dd>The y-translation amount.</dd>
  312. </dl>
  313. </li>
  314. </ul>
  315. <a name="setTranslateY-double-">
  316. <!-- -->
  317. </a>
  318. <ul class="blockListLast">
  319. <li class="blockList">
  320. <h4>setTranslateY</h4>
  321. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/BlockParams.html#line.134">setTranslateY</a>(double&nbsp;y)</pre>
  322. <div class="block">Sets the translation required to convert local y-coordinates into the
  323. coordinate space of the container.</div>
  324. <dl>
  325. <dt><span class="paramLabel">Parameters:</span></dt>
  326. <dd><code>y</code> - the y-translation amount.</dd>
  327. </dl>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. </li>
  333. </ul>
  334. </div>
  335. </div>
  336. <!-- ========= END OF CLASS DATA ========= -->
  337. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  338. <div class="bottomNav"><a name="navbar.bottom">
  339. <!-- -->
  340. </a>
  341. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  342. <a name="navbar.bottom.firstrow">
  343. <!-- -->
  344. </a>
  345. <ul class="navList" title="Navigation">
  346. <li><a href="../../../../overview-summary.html">Overview</a></li>
  347. <li><a href="package-summary.html">Package</a></li>
  348. <li class="navBarCell1Rev">Class</li>
  349. <li><a href="class-use/BlockParams.html">Use</a></li>
  350. <li><a href="package-tree.html">Tree</a></li>
  351. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  352. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  353. <li><a href="../../../../help-doc.html">Help</a></li>
  354. </ul>
  355. </div>
  356. <div class="subNav">
  357. <ul class="navList">
  358. <li><a href="../../../../org/jfree/chart/block/BlockFrame.html" title="interface in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  359. <li><a href="../../../../org/jfree/chart/block/BlockResult.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  360. </ul>
  361. <ul class="navList">
  362. <li><a href="../../../../index.html?org/jfree/chart/block/BlockParams.html" target="_top">Frames</a></li>
  363. <li><a href="BlockParams.html" target="_top">No&nbsp;Frames</a></li>
  364. </ul>
  365. <ul class="navList" id="allclasses_navbar_bottom">
  366. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  367. </ul>
  368. <div>
  369. <script type="text/javascript"><!--
  370. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  371. if(window==top) {
  372. allClassesLink.style.display = "block";
  373. }
  374. else {
  375. allClassesLink.style.display = "none";
  376. }
  377. //-->
  378. </script>
  379. </div>
  380. <div>
  381. <ul class="subNavList">
  382. <li>Summary:&nbsp;</li>
  383. <li>Nested&nbsp;|&nbsp;</li>
  384. <li>Field&nbsp;|&nbsp;</li>
  385. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  386. <li><a href="#method.summary">Method</a></li>
  387. </ul>
  388. <ul class="subNavList">
  389. <li>Detail:&nbsp;</li>
  390. <li>Field&nbsp;|&nbsp;</li>
  391. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  392. <li><a href="#method.detail">Method</a></li>
  393. </ul>
  394. </div>
  395. <a name="skip.navbar.bottom">
  396. <!-- -->
  397. </a></div>
  398. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  399. </body>
  400. </html>