Arrangement.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  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>Arrangement (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="Arrangement (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":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/Arrangement.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/AbstractBlock.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/block/Block.html" title="interface 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/Arrangement.html" target="_top">Frames</a></li>
  57. <li><a href="Arrangement.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 Arrangement" class="title">Interface Arrangement</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/block/BorderArrangement.html" title="class in org.jfree.chart.block">BorderArrangement</a>, <a href="../../../../org/jfree/chart/block/CenterArrangement.html" title="class in org.jfree.chart.block">CenterArrangement</a>, <a href="../../../../org/jfree/chart/block/ColumnArrangement.html" title="class in org.jfree.chart.block">ColumnArrangement</a>, <a href="../../../../org/jfree/chart/block/FlowArrangement.html" title="class in org.jfree.chart.block">FlowArrangement</a>, <a href="../../../../org/jfree/chart/block/GridArrangement.html" title="class in org.jfree.chart.block">GridArrangement</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/block/Arrangement.html#line.53">Arrangement</a></pre>
  109. <div class="block">An object that is responsible for arranging a collection of <a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block"><code>Block</code></a>s
  110. within a <a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block"><code>BlockContainer</code></a>.</div>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="summary">
  115. <ul class="blockList">
  116. <li class="blockList">
  117. <!-- ========== METHOD SUMMARY =========== -->
  118. <ul class="blockList">
  119. <li class="blockList"><a name="method.summary">
  120. <!-- -->
  121. </a>
  122. <h3>Method Summary</h3>
  123. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  124. <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>
  125. <tr>
  126. <th class="colFirst" scope="col">Modifier and Type</th>
  127. <th class="colLast" scope="col">Method and Description</th>
  128. </tr>
  129. <tr id="i0" class="altColor">
  130. <td class="colFirst"><code>void</code></td>
  131. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Arrangement.html#add-org.jfree.chart.block.Block-java.lang.Object-">add</a></span>(<a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block">Block</a>&nbsp;block,
  132. java.lang.Object&nbsp;key)</code>
  133. <div class="block">Adds a block and a key which can be used to determine the position of
  134. the block in the arrangement.</div>
  135. </td>
  136. </tr>
  137. <tr id="i1" class="rowColor">
  138. <td class="colFirst"><code>org.jfree.ui.Size2D</code></td>
  139. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Arrangement.html#arrange-org.jfree.chart.block.BlockContainer-java.awt.Graphics2D-org.jfree.chart.block.RectangleConstraint-">arrange</a></span>(<a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a>&nbsp;container,
  140. java.awt.Graphics2D&nbsp;g2,
  141. <a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block">RectangleConstraint</a>&nbsp;constraint)</code>
  142. <div class="block">Arranges the blocks within the specified container, subject to the given
  143. constraint.</div>
  144. </td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code>void</code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/Arrangement.html#clear--">clear</a></span>()</code>
  149. <div class="block">Clears any cached layout information retained by the arrangement.</div>
  150. </td>
  151. </tr>
  152. </table>
  153. </li>
  154. </ul>
  155. </li>
  156. </ul>
  157. </div>
  158. <div class="details">
  159. <ul class="blockList">
  160. <li class="blockList">
  161. <!-- ============ METHOD DETAIL ========== -->
  162. <ul class="blockList">
  163. <li class="blockList"><a name="method.detail">
  164. <!-- -->
  165. </a>
  166. <h3>Method Detail</h3>
  167. <a name="add-org.jfree.chart.block.Block-java.lang.Object-">
  168. <!-- -->
  169. </a>
  170. <ul class="blockList">
  171. <li class="blockList">
  172. <h4>add</h4>
  173. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Arrangement.html#line.64">add</a>(<a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block">Block</a>&nbsp;block,
  174. java.lang.Object&nbsp;key)</pre>
  175. <div class="block">Adds a block and a key which can be used to determine the position of
  176. the block in the arrangement. This method is called by the container
  177. (you don't need to call this method directly) and gives the arrangement
  178. an opportunity to record the details if they are required.</div>
  179. <dl>
  180. <dt><span class="paramLabel">Parameters:</span></dt>
  181. <dd><code>block</code> - the block.</dd>
  182. <dd><code>key</code> - the key (<code>null</code> permitted).</dd>
  183. </dl>
  184. </li>
  185. </ul>
  186. <a name="arrange-org.jfree.chart.block.BlockContainer-java.awt.Graphics2D-org.jfree.chart.block.RectangleConstraint-">
  187. <!-- -->
  188. </a>
  189. <ul class="blockList">
  190. <li class="blockList">
  191. <h4>arrange</h4>
  192. <pre>org.jfree.ui.Size2D&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Arrangement.html#line.76">arrange</a>(<a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a>&nbsp;container,
  193. java.awt.Graphics2D&nbsp;g2,
  194. <a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block">RectangleConstraint</a>&nbsp;constraint)</pre>
  195. <div class="block">Arranges the blocks within the specified container, subject to the given
  196. constraint.</div>
  197. <dl>
  198. <dt><span class="paramLabel">Parameters:</span></dt>
  199. <dd><code>container</code> - the container (<code>null</code> not permitted).</dd>
  200. <dd><code>g2</code> - the graphics device.</dd>
  201. <dd><code>constraint</code> - the constraint.</dd>
  202. <dt><span class="returnLabel">Returns:</span></dt>
  203. <dd>The container size after the arrangement.</dd>
  204. </dl>
  205. </li>
  206. </ul>
  207. <a name="clear--">
  208. <!-- -->
  209. </a>
  210. <ul class="blockListLast">
  211. <li class="blockList">
  212. <h4>clear</h4>
  213. <pre>void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/Arrangement.html#line.83">clear</a>()</pre>
  214. <div class="block">Clears any cached layout information retained by the arrangement.</div>
  215. </li>
  216. </ul>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. </div>
  222. </div>
  223. <!-- ========= END OF CLASS DATA ========= -->
  224. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  225. <div class="bottomNav"><a name="navbar.bottom">
  226. <!-- -->
  227. </a>
  228. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  229. <a name="navbar.bottom.firstrow">
  230. <!-- -->
  231. </a>
  232. <ul class="navList" title="Navigation">
  233. <li><a href="../../../../overview-summary.html">Overview</a></li>
  234. <li><a href="package-summary.html">Package</a></li>
  235. <li class="navBarCell1Rev">Class</li>
  236. <li><a href="class-use/Arrangement.html">Use</a></li>
  237. <li><a href="package-tree.html">Tree</a></li>
  238. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  239. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  240. <li><a href="../../../../help-doc.html">Help</a></li>
  241. </ul>
  242. </div>
  243. <div class="subNav">
  244. <ul class="navList">
  245. <li><a href="../../../../org/jfree/chart/block/AbstractBlock.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  246. <li><a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  247. </ul>
  248. <ul class="navList">
  249. <li><a href="../../../../index.html?org/jfree/chart/block/Arrangement.html" target="_top">Frames</a></li>
  250. <li><a href="Arrangement.html" target="_top">No&nbsp;Frames</a></li>
  251. </ul>
  252. <ul class="navList" id="allclasses_navbar_bottom">
  253. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  254. </ul>
  255. <div>
  256. <script type="text/javascript"><!--
  257. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  258. if(window==top) {
  259. allClassesLink.style.display = "block";
  260. }
  261. else {
  262. allClassesLink.style.display = "none";
  263. }
  264. //-->
  265. </script>
  266. </div>
  267. <div>
  268. <ul class="subNavList">
  269. <li>Summary:&nbsp;</li>
  270. <li>Nested&nbsp;|&nbsp;</li>
  271. <li>Field&nbsp;|&nbsp;</li>
  272. <li>Constr&nbsp;|&nbsp;</li>
  273. <li><a href="#method.summary">Method</a></li>
  274. </ul>
  275. <ul class="subNavList">
  276. <li>Detail:&nbsp;</li>
  277. <li>Field&nbsp;|&nbsp;</li>
  278. <li>Constr&nbsp;|&nbsp;</li>
  279. <li><a href="#method.detail">Method</a></li>
  280. </ul>
  281. </div>
  282. <a name="skip.navbar.bottom">
  283. <!-- -->
  284. </a></div>
  285. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  286. </body>
  287. </html>