LegendItemBlockContainer.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551
  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:41 CEST 2014 -->
  6. <title>LegendItemBlockContainer (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="LegendItemBlockContainer (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/LegendItemBlockContainer.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/title/LegendGraphic.html" title="class in org.jfree.chart.title"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/title/LegendTitle.html" title="class in org.jfree.chart.title"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/title/LegendItemBlockContainer.html" target="_top">Frames</a></li>
  57. <li><a href="LegendItemBlockContainer.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.title</div>
  96. <h2 title="Class LegendItemBlockContainer" class="title">Class LegendItemBlockContainer</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="../../../../org/jfree/chart/block/AbstractBlock.html" title="class in org.jfree.chart.block">org.jfree.chart.block.AbstractBlock</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">org.jfree.chart.block.BlockContainer</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li>org.jfree.chart.title.LegendItemBlockContainer</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <dd>java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block">Block</a>, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable</dd>
  123. </dl>
  124. <hr>
  125. <br>
  126. <pre>public class <a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.64">LegendItemBlockContainer</a>
  127. extends <a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a></pre>
  128. <div class="block">A container that holds all the pieces of a single legend item.</div>
  129. <dl>
  130. <dt><span class="simpleTagLabel">Since:</span></dt>
  131. <dd>1.0.2</dd>
  132. <dt><span class="seeLabel">See Also:</span></dt>
  133. <dd><a href="../../../../serialized-form.html#org.jfree.chart.title.LegendItemBlockContainer">Serialized Form</a></dd>
  134. </dl>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="constructor.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Constructor Summary</h3>
  147. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  148. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  149. <tr>
  150. <th class="colOne" scope="col">Constructor and Description</th>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#LegendItemBlockContainer-org.jfree.chart.block.Arrangement-org.jfree.data.general.Dataset-java.lang.Comparable-">LegendItemBlockContainer</a></span>(<a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block">Arrangement</a>&nbsp;arrangement,
  154. <a href="../../../../org/jfree/data/general/Dataset.html" title="interface in org.jfree.data.general">Dataset</a>&nbsp;dataset,
  155. java.lang.Comparable&nbsp;seriesKey)</code>
  156. <div class="block">Creates a new legend item block.</div>
  157. </td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#LegendItemBlockContainer-org.jfree.chart.block.Arrangement-int-int-">LegendItemBlockContainer</a></span>(<a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block">Arrangement</a>&nbsp;arrangement,
  161. int&nbsp;datasetIndex,
  162. int&nbsp;series)</code>
  163. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  164. <div class="block"><span class="deprecationComment">As of 1.0.6, use the other constructor.</span></div>
  165. </div>
  166. </td>
  167. </tr>
  168. </table>
  169. </li>
  170. </ul>
  171. <!-- ========== METHOD SUMMARY =========== -->
  172. <ul class="blockList">
  173. <li class="blockList"><a name="method.summary">
  174. <!-- -->
  175. </a>
  176. <h3>Method Summary</h3>
  177. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  178. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  179. <tr>
  180. <th class="colFirst" scope="col">Modifier and Type</th>
  181. <th class="colLast" scope="col">Method and Description</th>
  182. </tr>
  183. <tr id="i0" class="altColor">
  184. <td class="colFirst"><code>java.lang.Object</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">draw</a></span>(java.awt.Graphics2D&nbsp;g2,
  186. java.awt.geom.Rectangle2D&nbsp;area,
  187. java.lang.Object&nbsp;params)</code>
  188. <div class="block">Draws the block within the specified area.</div>
  189. </td>
  190. </tr>
  191. <tr id="i1" class="rowColor">
  192. <td class="colFirst"><code><a href="../../../../org/jfree/data/general/Dataset.html" title="interface in org.jfree.data.general">Dataset</a></code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getDataset--">getDataset</a></span>()</code>
  194. <div class="block">Returns a reference to the dataset for the associated legend item.</div>
  195. </td>
  196. </tr>
  197. <tr id="i2" class="altColor">
  198. <td class="colFirst"><code>int</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getDatasetIndex--">getDatasetIndex</a></span>()</code>
  200. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  201. <div class="block"><span class="deprecationComment">As of 1.0.6, use the <a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getDataset--"><code>getDataset()</code></a> method.</span></div>
  202. </div>
  203. </td>
  204. </tr>
  205. <tr id="i3" class="rowColor">
  206. <td class="colFirst"><code>int</code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getSeriesIndex--">getSeriesIndex</a></span>()</code>
  208. <div class="block">Returns the series index.</div>
  209. </td>
  210. </tr>
  211. <tr id="i4" class="altColor">
  212. <td class="colFirst"><code>java.lang.Comparable</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getSeriesKey--">getSeriesKey</a></span>()</code>
  214. <div class="block">Returns the series key.</div>
  215. </td>
  216. </tr>
  217. <tr id="i5" class="rowColor">
  218. <td class="colFirst"><code>java.lang.String</code></td>
  219. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getToolTipText--">getToolTipText</a></span>()</code>
  220. <div class="block">Returns the tool tip text.</div>
  221. </td>
  222. </tr>
  223. <tr id="i6" class="altColor">
  224. <td class="colFirst"><code>java.lang.String</code></td>
  225. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getURLText--">getURLText</a></span>()</code>
  226. <div class="block">Returns the URL text.</div>
  227. </td>
  228. </tr>
  229. <tr id="i7" class="rowColor">
  230. <td class="colFirst"><code>void</code></td>
  231. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#setToolTipText-java.lang.String-">setToolTipText</a></span>(java.lang.String&nbsp;text)</code>
  232. <div class="block">Sets the tool tip text.</div>
  233. </td>
  234. </tr>
  235. <tr id="i8" class="altColor">
  236. <td class="colFirst"><code>void</code></td>
  237. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#setURLText-java.lang.String-">setURLText</a></span>(java.lang.String&nbsp;text)</code>
  238. <div class="block">Sets the URL text.</div>
  239. </td>
  240. </tr>
  241. </table>
  242. <ul class="blockList">
  243. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.block.BlockContainer">
  244. <!-- -->
  245. </a>
  246. <h3>Methods inherited from class&nbsp;org.jfree.chart.block.<a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a></h3>
  247. <code><a href="../../../../org/jfree/chart/block/BlockContainer.html#add-org.jfree.chart.block.Block-">add</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#add-org.jfree.chart.block.Block-java.lang.Object-">add</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#arrange-java.awt.Graphics2D-org.jfree.chart.block.RectangleConstraint-">arrange</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#clear--">clear</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#clone--">clone</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-">draw</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#getArrangement--">getArrangement</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#getBlocks--">getBlocks</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#isEmpty--">isEmpty</a>, <a href="../../../../org/jfree/chart/block/BlockContainer.html#setArrangement-org.jfree.chart.block.Arrangement-">setArrangement</a></code></li>
  248. </ul>
  249. <ul class="blockList">
  250. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.block.AbstractBlock">
  251. <!-- -->
  252. </a>
  253. <h3>Methods inherited from class&nbsp;org.jfree.chart.block.<a href="../../../../org/jfree/chart/block/AbstractBlock.html" title="class in org.jfree.chart.block">AbstractBlock</a></h3>
  254. <code><a href="../../../../org/jfree/chart/block/AbstractBlock.html#arrange-java.awt.Graphics2D-">arrange</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#calculateTotalHeight-double-">calculateTotalHeight</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#calculateTotalWidth-double-">calculateTotalWidth</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#drawBorder-java.awt.Graphics2D-java.awt.geom.Rectangle2D-">drawBorder</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getBorder--">getBorder</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getBounds--">getBounds</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getContentXOffset--">getContentXOffset</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getContentYOffset--">getContentYOffset</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getFrame--">getFrame</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getHeight--">getHeight</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getID--">getID</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getMargin--">getMargin</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getPadding--">getPadding</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#getWidth--">getWidth</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setBorder-org.jfree.chart.block.BlockBorder-">setBorder</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setBorder-double-double-double-double-">setBorder</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setBounds-java.awt.geom.Rectangle2D-">setBounds</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setFrame-org.jfree.chart.block.BlockFrame-">setFrame</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setHeight-double-">setHeight</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setID-java.lang.String-">setID</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setMargin-double-double-double-double-">setMargin</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setMargin-org.jfree.ui.RectangleInsets-">setMargin</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setPadding-double-double-double-double-">setPadding</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setPadding-org.jfree.ui.RectangleInsets-">setPadding</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#setWidth-double-">setWidth</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#toContentConstraint-org.jfree.chart.block.RectangleConstraint-">toContentConstraint</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#trimBorder-java.awt.geom.Rectangle2D-">trimBorder</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#trimMargin-java.awt.geom.Rectangle2D-">trimMargin</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#trimPadding-java.awt.geom.Rectangle2D-">trimPadding</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#trimToContentHeight-double-">trimToContentHeight</a>, <a href="../../../../org/jfree/chart/block/AbstractBlock.html#trimToContentWidth-double-">trimToContentWidth</a></code></li>
  255. </ul>
  256. <ul class="blockList">
  257. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  258. <!-- -->
  259. </a>
  260. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  261. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  262. </ul>
  263. <ul class="blockList">
  264. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.chart.block.Block">
  265. <!-- -->
  266. </a>
  267. <h3>Methods inherited from interface&nbsp;org.jfree.chart.block.<a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block">Block</a></h3>
  268. <code><a href="../../../../org/jfree/chart/block/Block.html#arrange-java.awt.Graphics2D-">arrange</a>, <a href="../../../../org/jfree/chart/block/Block.html#getBounds--">getBounds</a>, <a href="../../../../org/jfree/chart/block/Block.html#getID--">getID</a>, <a href="../../../../org/jfree/chart/block/Block.html#setBounds-java.awt.geom.Rectangle2D-">setBounds</a>, <a href="../../../../org/jfree/chart/block/Block.html#setID-java.lang.String-">setID</a></code></li>
  269. </ul>
  270. </li>
  271. </ul>
  272. </li>
  273. </ul>
  274. </div>
  275. <div class="details">
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  279. <ul class="blockList">
  280. <li class="blockList"><a name="constructor.detail">
  281. <!-- -->
  282. </a>
  283. <h3>Constructor Detail</h3>
  284. <a name="LegendItemBlockContainer-org.jfree.chart.block.Arrangement-int-int-">
  285. <!-- -->
  286. </a>
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <h4>LegendItemBlockContainer</h4>
  290. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.101">LegendItemBlockContainer</a>(<a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block">Arrangement</a>&nbsp;arrangement,
  291. int&nbsp;datasetIndex,
  292. int&nbsp;series)</pre>
  293. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.6, use the other constructor.</span></div>
  294. <div class="block">Creates a new legend item block.</div>
  295. <dl>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>arrangement</code> - the arrangement.</dd>
  298. <dd><code>datasetIndex</code> - the dataset index.</dd>
  299. <dd><code>series</code> - the series index.</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. <a name="LegendItemBlockContainer-org.jfree.chart.block.Arrangement-org.jfree.data.general.Dataset-java.lang.Comparable-">
  304. <!-- -->
  305. </a>
  306. <ul class="blockListLast">
  307. <li class="blockList">
  308. <h4>LegendItemBlockContainer</h4>
  309. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.117">LegendItemBlockContainer</a>(<a href="../../../../org/jfree/chart/block/Arrangement.html" title="interface in org.jfree.chart.block">Arrangement</a>&nbsp;arrangement,
  310. <a href="../../../../org/jfree/data/general/Dataset.html" title="interface in org.jfree.data.general">Dataset</a>&nbsp;dataset,
  311. java.lang.Comparable&nbsp;seriesKey)</pre>
  312. <div class="block">Creates a new legend item block.</div>
  313. <dl>
  314. <dt><span class="paramLabel">Parameters:</span></dt>
  315. <dd><code>arrangement</code> - the arrangement.</dd>
  316. <dd><code>dataset</code> - the dataset.</dd>
  317. <dd><code>seriesKey</code> - the series key.</dd>
  318. <dt><span class="simpleTagLabel">Since:</span></dt>
  319. <dd>1.0.6</dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. </li>
  324. </ul>
  325. <!-- ============ METHOD DETAIL ========== -->
  326. <ul class="blockList">
  327. <li class="blockList"><a name="method.detail">
  328. <!-- -->
  329. </a>
  330. <h3>Method Detail</h3>
  331. <a name="getDataset--">
  332. <!-- -->
  333. </a>
  334. <ul class="blockList">
  335. <li class="blockList">
  336. <h4>getDataset</h4>
  337. <pre>public&nbsp;<a href="../../../../org/jfree/data/general/Dataset.html" title="interface in org.jfree.data.general">Dataset</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.131">getDataset</a>()</pre>
  338. <div class="block">Returns a reference to the dataset for the associated legend item.</div>
  339. <dl>
  340. <dt><span class="returnLabel">Returns:</span></dt>
  341. <dd>A dataset reference.</dd>
  342. <dt><span class="simpleTagLabel">Since:</span></dt>
  343. <dd>1.0.6</dd>
  344. </dl>
  345. </li>
  346. </ul>
  347. <a name="getSeriesKey--">
  348. <!-- -->
  349. </a>
  350. <ul class="blockList">
  351. <li class="blockList">
  352. <h4>getSeriesKey</h4>
  353. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.142">getSeriesKey</a>()</pre>
  354. <div class="block">Returns the series key.</div>
  355. <dl>
  356. <dt><span class="returnLabel">Returns:</span></dt>
  357. <dd>The series key.</dd>
  358. <dt><span class="simpleTagLabel">Since:</span></dt>
  359. <dd>1.0.6</dd>
  360. </dl>
  361. </li>
  362. </ul>
  363. <a name="getDatasetIndex--">
  364. <!-- -->
  365. </a>
  366. <ul class="blockList">
  367. <li class="blockList">
  368. <h4>getDatasetIndex</h4>
  369. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.153">getDatasetIndex</a>()</pre>
  370. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.6, use the <a href="../../../../org/jfree/chart/title/LegendItemBlockContainer.html#getDataset--"><code>getDataset()</code></a> method.</span></div>
  371. <div class="block">Returns the dataset index.</div>
  372. <dl>
  373. <dt><span class="returnLabel">Returns:</span></dt>
  374. <dd>The dataset index.</dd>
  375. </dl>
  376. </li>
  377. </ul>
  378. <a name="getSeriesIndex--">
  379. <!-- -->
  380. </a>
  381. <ul class="blockList">
  382. <li class="blockList">
  383. <h4>getSeriesIndex</h4>
  384. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.162">getSeriesIndex</a>()</pre>
  385. <div class="block">Returns the series index.</div>
  386. <dl>
  387. <dt><span class="returnLabel">Returns:</span></dt>
  388. <dd>The series index.</dd>
  389. </dl>
  390. </li>
  391. </ul>
  392. <a name="getToolTipText--">
  393. <!-- -->
  394. </a>
  395. <ul class="blockList">
  396. <li class="blockList">
  397. <h4>getToolTipText</h4>
  398. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.173">getToolTipText</a>()</pre>
  399. <div class="block">Returns the tool tip text.</div>
  400. <dl>
  401. <dt><span class="returnLabel">Returns:</span></dt>
  402. <dd>The tool tip text (possibly <code>null</code>).</dd>
  403. <dt><span class="simpleTagLabel">Since:</span></dt>
  404. <dd>1.0.3</dd>
  405. </dl>
  406. </li>
  407. </ul>
  408. <a name="setToolTipText-java.lang.String-">
  409. <!-- -->
  410. </a>
  411. <ul class="blockList">
  412. <li class="blockList">
  413. <h4>setToolTipText</h4>
  414. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.184">setToolTipText</a>(java.lang.String&nbsp;text)</pre>
  415. <div class="block">Sets the tool tip text.</div>
  416. <dl>
  417. <dt><span class="paramLabel">Parameters:</span></dt>
  418. <dd><code>text</code> - the text (<code>null</code> permitted).</dd>
  419. <dt><span class="simpleTagLabel">Since:</span></dt>
  420. <dd>1.0.3</dd>
  421. </dl>
  422. </li>
  423. </ul>
  424. <a name="getURLText--">
  425. <!-- -->
  426. </a>
  427. <ul class="blockList">
  428. <li class="blockList">
  429. <h4>getURLText</h4>
  430. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.195">getURLText</a>()</pre>
  431. <div class="block">Returns the URL text.</div>
  432. <dl>
  433. <dt><span class="returnLabel">Returns:</span></dt>
  434. <dd>The URL text (possibly <code>null</code>).</dd>
  435. <dt><span class="simpleTagLabel">Since:</span></dt>
  436. <dd>1.0.3</dd>
  437. </dl>
  438. </li>
  439. </ul>
  440. <a name="setURLText-java.lang.String-">
  441. <!-- -->
  442. </a>
  443. <ul class="blockList">
  444. <li class="blockList">
  445. <h4>setURLText</h4>
  446. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.206">setURLText</a>(java.lang.String&nbsp;text)</pre>
  447. <div class="block">Sets the URL text.</div>
  448. <dl>
  449. <dt><span class="paramLabel">Parameters:</span></dt>
  450. <dd><code>text</code> - the text (<code>null</code> permitted).</dd>
  451. <dt><span class="simpleTagLabel">Since:</span></dt>
  452. <dd>1.0.3</dd>
  453. </dl>
  454. </li>
  455. </ul>
  456. <a name="draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">
  457. <!-- -->
  458. </a>
  459. <ul class="blockListLast">
  460. <li class="blockList">
  461. <h4>draw</h4>
  462. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/title/LegendItemBlockContainer.html#line.221">draw</a>(java.awt.Graphics2D&nbsp;g2,
  463. java.awt.geom.Rectangle2D&nbsp;area,
  464. java.lang.Object&nbsp;params)</pre>
  465. <div class="block">Draws the block within the specified area.</div>
  466. <dl>
  467. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  468. <dd><code><a href="../../../../org/jfree/chart/block/Block.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">draw</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/block/Block.html" title="interface in org.jfree.chart.block">Block</a></code></dd>
  469. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  470. <dd><code><a href="../../../../org/jfree/chart/block/BlockContainer.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-java.lang.Object-">draw</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/chart/block/BlockContainer.html" title="class in org.jfree.chart.block">BlockContainer</a></code></dd>
  471. <dt><span class="paramLabel">Parameters:</span></dt>
  472. <dd><code>g2</code> - the graphics device.</dd>
  473. <dd><code>area</code> - the area.</dd>
  474. <dd><code>params</code> - passed on to blocks within the container
  475. (<code>null</code> permitted).</dd>
  476. <dt><span class="returnLabel">Returns:</span></dt>
  477. <dd>An instance of <a href="../../../../org/jfree/chart/block/EntityBlockResult.html" title="interface in org.jfree.chart.block"><code>EntityBlockResult</code></a>, or <code>null</code>.</dd>
  478. </dl>
  479. </li>
  480. </ul>
  481. </li>
  482. </ul>
  483. </li>
  484. </ul>
  485. </div>
  486. </div>
  487. <!-- ========= END OF CLASS DATA ========= -->
  488. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  489. <div class="bottomNav"><a name="navbar.bottom">
  490. <!-- -->
  491. </a>
  492. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  493. <a name="navbar.bottom.firstrow">
  494. <!-- -->
  495. </a>
  496. <ul class="navList" title="Navigation">
  497. <li><a href="../../../../overview-summary.html">Overview</a></li>
  498. <li><a href="package-summary.html">Package</a></li>
  499. <li class="navBarCell1Rev">Class</li>
  500. <li><a href="class-use/LegendItemBlockContainer.html">Use</a></li>
  501. <li><a href="package-tree.html">Tree</a></li>
  502. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  503. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  504. <li><a href="../../../../help-doc.html">Help</a></li>
  505. </ul>
  506. </div>
  507. <div class="subNav">
  508. <ul class="navList">
  509. <li><a href="../../../../org/jfree/chart/title/LegendGraphic.html" title="class in org.jfree.chart.title"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  510. <li><a href="../../../../org/jfree/chart/title/LegendTitle.html" title="class in org.jfree.chart.title"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  511. </ul>
  512. <ul class="navList">
  513. <li><a href="../../../../index.html?org/jfree/chart/title/LegendItemBlockContainer.html" target="_top">Frames</a></li>
  514. <li><a href="LegendItemBlockContainer.html" target="_top">No&nbsp;Frames</a></li>
  515. </ul>
  516. <ul class="navList" id="allclasses_navbar_bottom">
  517. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  518. </ul>
  519. <div>
  520. <script type="text/javascript"><!--
  521. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  522. if(window==top) {
  523. allClassesLink.style.display = "block";
  524. }
  525. else {
  526. allClassesLink.style.display = "none";
  527. }
  528. //-->
  529. </script>
  530. </div>
  531. <div>
  532. <ul class="subNavList">
  533. <li>Summary:&nbsp;</li>
  534. <li>Nested&nbsp;|&nbsp;</li>
  535. <li>Field&nbsp;|&nbsp;</li>
  536. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  537. <li><a href="#method.summary">Method</a></li>
  538. </ul>
  539. <ul class="subNavList">
  540. <li>Detail:&nbsp;</li>
  541. <li>Field&nbsp;|&nbsp;</li>
  542. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  543. <li><a href="#method.detail">Method</a></li>
  544. </ul>
  545. </div>
  546. <a name="skip.navbar.bottom">
  547. <!-- -->
  548. </a></div>
  549. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  550. </body>
  551. </html>