Block.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  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>Block (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="Block (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Block.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/Arrangement.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/BlockBorder.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/Block.html" target="_top">Frames</a></li>
  57. <li><a href="Block.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>Constr&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>Constr&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="Interface Block" class="title">Interface Block</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd>org.jfree.ui.Drawable</dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Implementing Classes:</dt>
  108. <dd><a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a>, <a href="../../../../org/jfree/chart/block/ColorBlock.html" title="class in org.jfree.chart.block">ColorBlock</a>, <a href="../../../../org/jfree/chart/title/CompositeTitle.html" title="class in org.jfree.chart.title">CompositeTitle</a>, <a href="../../../../org/jfree/chart/title/DateTitle.html" title="class in org.jfree.chart.title">DateTitle</a>, <a href="../../../../org/jfree/chart/block/EmptyBlock.html" title="class in org.jfree.chart.block">EmptyBlock</a>, <a href="../../../../org/jfree/chart/title/ImageTitle.html" title="class in org.jfree.chart.title">ImageTitle</a>, <a href="../../../../org/jfree/chart/block/LabelBlock.html" title="class in org.jfree.chart.block">LabelBlock</a>, <a href="../../../../org/jfree/chart/title/LegendGraphic.html" title="class in org.jfree.chart.title">LegendGraphic</a>, <a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html" title="class in org.jfree.chart.title">LegendItemBlockContainer</a>, <a href="../../../../org/jfree/chart/title/LegendTitle.html" title="class in org.jfree.chart.title">LegendTitle</a>, <a href="../../../../org/jfree/chart/title/PaintScaleLegend.html" title="class in org.jfree.chart.title">PaintScaleLegend</a>, <a href="../../../../org/jfree/chart/title/ShortTextTitle.html" title="class in org.jfree.chart.title">ShortTextTitle</a>, <a href="../../../../org/jfree/chart/title/TextTitle.html" title="class in org.jfree.chart.title">TextTitle</a>, <a href="../../../../org/jfree/chart/title/Title.html" title="class in org.jfree.chart.title">Title</a></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public interface <a href="../../../../src-html/org/jfree/chart/block/Block.html#line.57">Block</a>
  113. extends org.jfree.ui.Drawable</pre>
  114. <div class="block">A block is an arbitrary item that can be drawn (in Java2D space) within a
  115. rectangular area, has a preferred size, and can be arranged by an
  116. <a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block"><code>Arrangement</code></a> manager.</div>
  117. </li>
  118. </ul>
  119. </div>
  120. <div class="summary">
  121. <ul class="blockList">
  122. <li class="blockList">
  123. <!-- ========== METHOD SUMMARY =========== -->
  124. <ul class="blockList">
  125. <li class="blockList"><a name="method.summary">
  126. <!-- -->
  127. </a>
  128. <h3>Method Summary</h3>
  129. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  130. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  131. <tr>
  132. <th class="colFirst" scope="col">Modifier and Type</th>
  133. <th class="colLast" scope="col">Method and Description</th>
  134. </tr>
  135. <tr id="i0" class="altColor">
  136. <td class="colFirst"><code>org.jfree.ui.Size2D</code></td>
  137. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#arrange-java.awt.Graphics2D-">arrange</a></span>(java.awt.Graphics2D&nbsp;g2)</code>
  138. <div class="block">Arranges the contents of the block, with no constraints, and returns
  139. the block size.</div>
  140. </td>
  141. </tr>
  142. <tr id="i1" class="rowColor">
  143. <td class="colFirst"><code>org.jfree.ui.Size2D</code></td>
  144. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#arrange-java.awt.Graphics2D-org.jfree.chart.block.RectangleConstraint-">arrange</a></span>(java.awt.Graphics2D&nbsp;g2,
  145. <a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block">RectangleConstraint</a>&nbsp;constraint)</code>
  146. <div class="block">Arranges the contents of the block, within the given constraints, and
  147. returns the block size.</div>
  148. </td>
  149. </tr>
  150. <tr id="i2" class="altColor">
  151. <td class="colFirst"><code>java.lang.Object</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">draw</a></span>(java.awt.Graphics2D&nbsp;g2,
  153. java.awt.geom.Rectangle2D&nbsp;area,
  154. java.lang.Object&nbsp;params)</code>
  155. <div class="block">Draws the block within the specified area.</div>
  156. </td>
  157. </tr>
  158. <tr id="i3" class="rowColor">
  159. <td class="colFirst"><code>java.awt.geom.Rectangle2D</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#getBounds--">getBounds</a></span>()</code>
  161. <div class="block">Returns the current bounds of the block.</div>
  162. </td>
  163. </tr>
  164. <tr id="i4" class="altColor">
  165. <td class="colFirst"><code>java.lang.String</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#getID--">getID</a></span>()</code>
  167. <div class="block">Returns an ID for the block.</div>
  168. </td>
  169. </tr>
  170. <tr id="i5" class="rowColor">
  171. <td class="colFirst"><code>void</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#setBounds-java.awt.geom.Rectangle2D-">setBounds</a></span>(java.awt.geom.Rectangle2D&nbsp;bounds)</code>
  173. <div class="block">Sets the bounds of the block.</div>
  174. </td>
  175. </tr>
  176. <tr id="i6" class="altColor">
  177. <td class="colFirst"><code>void</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Block.html#setID-java.lang.String-">setID</a></span>(java.lang.String&nbsp;id)</code>
  179. <div class="block">Sets the ID for the block.</div>
  180. </td>
  181. </tr>
  182. </table>
  183. <ul class="blockList">
  184. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.ui.Drawable">
  185. <!-- -->
  186. </a>
  187. <h3>Methods inherited from interface&nbsp;org.jfree.ui.Drawable</h3>
  188. <code>draw</code></li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </li>
  193. </ul>
  194. </div>
  195. <div class="details">
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <!-- ============ METHOD DETAIL ========== -->
  199. <ul class="blockList">
  200. <li class="blockList"><a name="method.detail">
  201. <!-- -->
  202. </a>
  203. <h3>Method Detail</h3>
  204. <a name="getID--">
  205. <!-- -->
  206. </a>
  207. <ul class="blockList">
  208. <li class="blockList">
  209. <h4>getID</h4>
  210. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.64">getID</a>()</pre>
  211. <div class="block">Returns an ID for the block.</div>
  212. <dl>
  213. <dt><span class="returnLabel">Returns:</span></dt>
  214. <dd>An ID.</dd>
  215. </dl>
  216. </li>
  217. </ul>
  218. <a name="setID-java.lang.String-">
  219. <!-- -->
  220. </a>
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <h4>setID</h4>
  224. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.71">setID</a>(java.lang.String&nbsp;id)</pre>
  225. <div class="block">Sets the ID for the block.</div>
  226. <dl>
  227. <dt><span class="paramLabel">Parameters:</span></dt>
  228. <dd><code>id</code> - the ID.</dd>
  229. </dl>
  230. </li>
  231. </ul>
  232. <a name="arrange-java.awt.Graphics2D-">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>arrange</h4>
  238. <pre>org.jfree.ui.Size2D&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.81">arrange</a>(java.awt.Graphics2D&nbsp;g2)</pre>
  239. <div class="block">Arranges the contents of the block, with no constraints, and returns
  240. the block size.</div>
  241. <dl>
  242. <dt><span class="paramLabel">Parameters:</span></dt>
  243. <dd><code>g2</code> - the graphics device.</dd>
  244. <dt><span class="returnLabel">Returns:</span></dt>
  245. <dd>The size of the block.</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="arrange-java.awt.Graphics2D-org.jfree.chart.block.RectangleConstraint-">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>arrange</h4>
  255. <pre>org.jfree.ui.Size2D&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.92">arrange</a>(java.awt.Graphics2D&nbsp;g2,
  256. <a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block">RectangleConstraint</a>&nbsp;constraint)</pre>
  257. <div class="block">Arranges the contents of the block, within the given constraints, and
  258. returns the block size.</div>
  259. <dl>
  260. <dt><span class="paramLabel">Parameters:</span></dt>
  261. <dd><code>g2</code> - the graphics device.</dd>
  262. <dd><code>constraint</code> - the constraint (<code>null</code> not permitted).</dd>
  263. <dt><span class="returnLabel">Returns:</span></dt>
  264. <dd>The block size (in Java2D units, never <code>null</code>).</dd>
  265. </dl>
  266. </li>
  267. </ul>
  268. <a name="getBounds--">
  269. <!-- -->
  270. </a>
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <h4>getBounds</h4>
  274. <pre>java.awt.geom.Rectangle2D&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.99">getBounds</a>()</pre>
  275. <div class="block">Returns the current bounds of the block.</div>
  276. <dl>
  277. <dt><span class="returnLabel">Returns:</span></dt>
  278. <dd>The bounds.</dd>
  279. </dl>
  280. </li>
  281. </ul>
  282. <a name="setBounds-java.awt.geom.Rectangle2D-">
  283. <!-- -->
  284. </a>
  285. <ul class="blockList">
  286. <li class="blockList">
  287. <h4>setBounds</h4>
  288. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.106">setBounds</a>(java.awt.geom.Rectangle2D&nbsp;bounds)</pre>
  289. <div class="block">Sets the bounds of the block.</div>
  290. <dl>
  291. <dt><span class="paramLabel">Parameters:</span></dt>
  292. <dd><code>bounds</code> - the bounds.</dd>
  293. </dl>
  294. </li>
  295. </ul>
  296. <a name="draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">
  297. <!-- -->
  298. </a>
  299. <ul class="blockListLast">
  300. <li class="blockList">
  301. <h4>draw</h4>
  302. <pre>java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Block.html#line.119">draw</a>(java.awt.Graphics2D&nbsp;g2,
  303. java.awt.geom.Rectangle2D&nbsp;area,
  304. java.lang.Object&nbsp;params)</pre>
  305. <div class="block">Draws the block within the specified area. Refer to the documentation
  306. for the implementing class for information about the <code>params</code>
  307. and return value supported.</div>
  308. <dl>
  309. <dt><span class="paramLabel">Parameters:</span></dt>
  310. <dd><code>g2</code> - the graphics device.</dd>
  311. <dd><code>area</code> - the area.</dd>
  312. <dd><code>params</code> - optional parameters (<code>null</code> permitted).</dd>
  313. <dt><span class="returnLabel">Returns:</span></dt>
  314. <dd>An optional return value (possibly <code>null</code>).</dd>
  315. </dl>
  316. </li>
  317. </ul>
  318. </li>
  319. </ul>
  320. </li>
  321. </ul>
  322. </div>
  323. </div>
  324. <!-- ========= END OF CLASS DATA ========= -->
  325. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  326. <div class="bottomNav"><a name="navbar.bottom">
  327. <!-- -->
  328. </a>
  329. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  330. <a name="navbar.bottom.firstrow">
  331. <!-- -->
  332. </a>
  333. <ul class="navList" title="Navigation">
  334. <li><a href="../../../../overview-summary.html">Overview</a></li>
  335. <li><a href="package-summary.html">Package</a></li>
  336. <li class="navBarCell1Rev">Class</li>
  337. <li><a href="class-use/Block.html">Use</a></li>
  338. <li><a href="package-tree.html">Tree</a></li>
  339. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  340. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  341. <li><a href="../../../../help-doc.html">Help</a></li>
  342. </ul>
  343. </div>
  344. <div class="subNav">
  345. <ul class="navList">
  346. <li><a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  347. <li><a href="../../../../org/jfree/chart/block/BlockBorder.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  348. </ul>
  349. <ul class="navList">
  350. <li><a href="../../../../index.html?org/jfree/chart/block/Block.html" target="_top">Frames</a></li>
  351. <li><a href="Block.html" target="_top">No&nbsp;Frames</a></li>
  352. </ul>
  353. <ul class="navList" id="allclasses_navbar_bottom">
  354. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  355. </ul>
  356. <div>
  357. <script type="text/javascript"><!--
  358. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  359. if(window==top) {
  360. allClassesLink.style.display = "block";
  361. }
  362. else {
  363. allClassesLink.style.display = "none";
  364. }
  365. //-->
  366. </script>
  367. </div>
  368. <div>
  369. <ul class="subNavList">
  370. <li>Summary:&nbsp;</li>
  371. <li>Nested&nbsp;|&nbsp;</li>
  372. <li>Field&nbsp;|&nbsp;</li>
  373. <li>Constr&nbsp;|&nbsp;</li>
  374. <li><a href="#method.summary">Method</a></li>
  375. </ul>
  376. <ul class="subNavList">
  377. <li>Detail:&nbsp;</li>
  378. <li>Field&nbsp;|&nbsp;</li>
  379. <li>Constr&nbsp;|&nbsp;</li>
  380. <li><a href="#method.detail">Method</a></li>
  381. </ul>
  382. </div>
  383. <a name="skip.navbar.bottom">
  384. <!-- -->
  385. </a></div>
  386. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  387. </body>
  388. </html>