LegendItem.html 105 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2014, by Object Refinery Limited and Contributors.<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span> * ---------------<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span> * LegendItem.java<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span> * ---------------<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span> * (C) Copyright 2000-2014, by Object Refinery Limited and Contributors.<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
  41. <span class="sourceLineNo">033</span> * Contributor(s): Andrzej Porebski;<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> * David Li;<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * Wolfgang Irler;<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> * Luke Quinane;<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span> *<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * Changes (from 2-Oct-2002)<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * -------------------------<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> * 02-Oct-2002 : Fixed errors reported by Checkstyle (DG);<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> * 17-Jan-2003 : Dropped outlineStroke attribute (DG);<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> * 08-Oct-2003 : Applied patch for displaying series line style, contributed by<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span> * Luke Quinane (DG);<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span> * 21-Jan-2004 : Added the shapeFilled flag (DG);<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span> * 04-Jun-2004 : Added equals() method, implemented Serializable (DG);<a name="line.45"></a>
  54. <span class="sourceLineNo">046</span> * 25-Nov-2004 : Changes required by new LegendTitle implementation (DG);<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span> * 11-Jan-2005 : Removed deprecated code in preparation for the 1.0.0<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span> * release (DG);<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span> * 20-Apr-2005 : Added tooltip and URL text (DG);<a name="line.49"></a>
  58. <span class="sourceLineNo">050</span> * 28-Nov-2005 : Separated constructors for AttributedString labels (DG);<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span> * 10-Dec-2005 : Fixed serialization bug (1377239) (DG);<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span> * 20-Jul-2006 : Added dataset and series index fields (DG);<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span> * 13-Dec-2006 : Added fillPaintTransformer attribute (DG);<a name="line.54"></a>
  63. <span class="sourceLineNo">055</span> * 18-May-2007 : Added dataset and seriesKey fields (DG);<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span> * 03-Aug-2007 : Fixed null pointer exception (DG);<a name="line.56"></a>
  65. <span class="sourceLineNo">057</span> * 23-Apr-2008 : Added new constructor and implemented Cloneable (DG);<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span> * 17-Jun-2008 : Added optional labelFont and labelPaint attributes (DG);<a name="line.58"></a>
  67. <span class="sourceLineNo">059</span> * 15-Oct-2008 : Added new constructor (DG);<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span> * 28-Apr-2009 : Added various setter methods (DG);<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span> * 01-Jul-2013 : Use ParamChecks class (DG);<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span> *<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span> */<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span><a name="line.64"></a>
  73. <span class="sourceLineNo">065</span>package org.jfree.chart;<a name="line.65"></a>
  74. <span class="sourceLineNo">066</span><a name="line.66"></a>
  75. <span class="sourceLineNo">067</span>import java.awt.BasicStroke;<a name="line.67"></a>
  76. <span class="sourceLineNo">068</span>import java.awt.Color;<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span>import java.awt.Font;<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span>import java.awt.Paint;<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span>import java.awt.Shape;<a name="line.71"></a>
  80. <span class="sourceLineNo">072</span>import java.awt.Stroke;<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span>import java.awt.geom.Line2D;<a name="line.73"></a>
  82. <span class="sourceLineNo">074</span>import java.awt.geom.Rectangle2D;<a name="line.74"></a>
  83. <span class="sourceLineNo">075</span>import java.io.IOException;<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span>import java.io.ObjectInputStream;<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span>import java.io.ObjectOutputStream;<a name="line.77"></a>
  86. <span class="sourceLineNo">078</span>import java.io.Serializable;<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span>import java.text.AttributedString;<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span>import java.text.CharacterIterator;<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span>import org.jfree.chart.util.ParamChecks;<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span><a name="line.82"></a>
  91. <span class="sourceLineNo">083</span>import org.jfree.data.general.Dataset;<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span>import org.jfree.io.SerialUtilities;<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span>import org.jfree.ui.GradientPaintTransformer;<a name="line.85"></a>
  94. <span class="sourceLineNo">086</span>import org.jfree.ui.StandardGradientPaintTransformer;<a name="line.86"></a>
  95. <span class="sourceLineNo">087</span>import org.jfree.util.AttributedStringUtilities;<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span>import org.jfree.util.ObjectUtilities;<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span>import org.jfree.util.PaintUtilities;<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span>import org.jfree.util.PublicCloneable;<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span>import org.jfree.util.ShapeUtilities;<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span><a name="line.92"></a>
  101. <span class="sourceLineNo">093</span>/**<a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> * A temporary storage object for recording the properties of a legend item,<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> * without any consideration for layout issues.<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span> */<a name="line.96"></a>
  105. <span class="sourceLineNo">097</span>public class LegendItem implements Cloneable, Serializable {<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span><a name="line.98"></a>
  107. <span class="sourceLineNo">099</span> /** For serialization. */<a name="line.99"></a>
  108. <span class="sourceLineNo">100</span> private static final long serialVersionUID = -797214582948827144L;<a name="line.100"></a>
  109. <span class="sourceLineNo">101</span><a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> /**<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span> * The dataset.<a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> *<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> * @since 1.0.6<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> */<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> private Dataset dataset;<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span><a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> /**<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> * The series key.<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span> *<a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> * @since 1.0.6<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span> */<a name="line.113"></a>
  122. <span class="sourceLineNo">114</span> private Comparable seriesKey;<a name="line.114"></a>
  123. <span class="sourceLineNo">115</span><a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> /** The dataset index. */<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span> private int datasetIndex;<a name="line.117"></a>
  126. <span class="sourceLineNo">118</span><a name="line.118"></a>
  127. <span class="sourceLineNo">119</span> /** The series index. */<a name="line.119"></a>
  128. <span class="sourceLineNo">120</span> private int series;<a name="line.120"></a>
  129. <span class="sourceLineNo">121</span><a name="line.121"></a>
  130. <span class="sourceLineNo">122</span> /** The label. */<a name="line.122"></a>
  131. <span class="sourceLineNo">123</span> private String label;<a name="line.123"></a>
  132. <span class="sourceLineNo">124</span><a name="line.124"></a>
  133. <span class="sourceLineNo">125</span> /**<a name="line.125"></a>
  134. <span class="sourceLineNo">126</span> * The label font ({@code null} is permitted).<a name="line.126"></a>
  135. <span class="sourceLineNo">127</span> *<a name="line.127"></a>
  136. <span class="sourceLineNo">128</span> * @since 1.0.11<a name="line.128"></a>
  137. <span class="sourceLineNo">129</span> */<a name="line.129"></a>
  138. <span class="sourceLineNo">130</span> private Font labelFont;<a name="line.130"></a>
  139. <span class="sourceLineNo">131</span><a name="line.131"></a>
  140. <span class="sourceLineNo">132</span> /**<a name="line.132"></a>
  141. <span class="sourceLineNo">133</span> * The label paint ({@code null} is permitted).<a name="line.133"></a>
  142. <span class="sourceLineNo">134</span> *<a name="line.134"></a>
  143. <span class="sourceLineNo">135</span> * @since 1.0.11<a name="line.135"></a>
  144. <span class="sourceLineNo">136</span> */<a name="line.136"></a>
  145. <span class="sourceLineNo">137</span> private transient Paint labelPaint;<a name="line.137"></a>
  146. <span class="sourceLineNo">138</span><a name="line.138"></a>
  147. <span class="sourceLineNo">139</span> /** The attributed label (if null, fall back to the regular label). */<a name="line.139"></a>
  148. <span class="sourceLineNo">140</span> private transient AttributedString attributedLabel;<a name="line.140"></a>
  149. <span class="sourceLineNo">141</span><a name="line.141"></a>
  150. <span class="sourceLineNo">142</span> /**<a name="line.142"></a>
  151. <span class="sourceLineNo">143</span> * The description (not currently used - could be displayed as a tool tip).<a name="line.143"></a>
  152. <span class="sourceLineNo">144</span> */<a name="line.144"></a>
  153. <span class="sourceLineNo">145</span> private String description;<a name="line.145"></a>
  154. <span class="sourceLineNo">146</span><a name="line.146"></a>
  155. <span class="sourceLineNo">147</span> /** The tool tip text. */<a name="line.147"></a>
  156. <span class="sourceLineNo">148</span> private String toolTipText;<a name="line.148"></a>
  157. <span class="sourceLineNo">149</span><a name="line.149"></a>
  158. <span class="sourceLineNo">150</span> /** The url text. */<a name="line.150"></a>
  159. <span class="sourceLineNo">151</span> private String urlText;<a name="line.151"></a>
  160. <span class="sourceLineNo">152</span><a name="line.152"></a>
  161. <span class="sourceLineNo">153</span> /** A flag that controls whether or not the shape is visible. */<a name="line.153"></a>
  162. <span class="sourceLineNo">154</span> private boolean shapeVisible;<a name="line.154"></a>
  163. <span class="sourceLineNo">155</span><a name="line.155"></a>
  164. <span class="sourceLineNo">156</span> /** The shape. */<a name="line.156"></a>
  165. <span class="sourceLineNo">157</span> private transient Shape shape;<a name="line.157"></a>
  166. <span class="sourceLineNo">158</span><a name="line.158"></a>
  167. <span class="sourceLineNo">159</span> /** A flag that controls whether or not the shape is filled. */<a name="line.159"></a>
  168. <span class="sourceLineNo">160</span> private boolean shapeFilled;<a name="line.160"></a>
  169. <span class="sourceLineNo">161</span><a name="line.161"></a>
  170. <span class="sourceLineNo">162</span> /** The paint. */<a name="line.162"></a>
  171. <span class="sourceLineNo">163</span> private transient Paint fillPaint;<a name="line.163"></a>
  172. <span class="sourceLineNo">164</span><a name="line.164"></a>
  173. <span class="sourceLineNo">165</span> /**<a name="line.165"></a>
  174. <span class="sourceLineNo">166</span> * A gradient paint transformer.<a name="line.166"></a>
  175. <span class="sourceLineNo">167</span> *<a name="line.167"></a>
  176. <span class="sourceLineNo">168</span> * @since 1.0.4<a name="line.168"></a>
  177. <span class="sourceLineNo">169</span> */<a name="line.169"></a>
  178. <span class="sourceLineNo">170</span> private GradientPaintTransformer fillPaintTransformer;<a name="line.170"></a>
  179. <span class="sourceLineNo">171</span><a name="line.171"></a>
  180. <span class="sourceLineNo">172</span> /** A flag that controls whether or not the shape outline is visible. */<a name="line.172"></a>
  181. <span class="sourceLineNo">173</span> private boolean shapeOutlineVisible;<a name="line.173"></a>
  182. <span class="sourceLineNo">174</span><a name="line.174"></a>
  183. <span class="sourceLineNo">175</span> /** The outline paint. */<a name="line.175"></a>
  184. <span class="sourceLineNo">176</span> private transient Paint outlinePaint;<a name="line.176"></a>
  185. <span class="sourceLineNo">177</span><a name="line.177"></a>
  186. <span class="sourceLineNo">178</span> /** The outline stroke. */<a name="line.178"></a>
  187. <span class="sourceLineNo">179</span> private transient Stroke outlineStroke;<a name="line.179"></a>
  188. <span class="sourceLineNo">180</span><a name="line.180"></a>
  189. <span class="sourceLineNo">181</span> /** A flag that controls whether or not the line is visible. */<a name="line.181"></a>
  190. <span class="sourceLineNo">182</span> private boolean lineVisible;<a name="line.182"></a>
  191. <span class="sourceLineNo">183</span><a name="line.183"></a>
  192. <span class="sourceLineNo">184</span> /** The line. */<a name="line.184"></a>
  193. <span class="sourceLineNo">185</span> private transient Shape line;<a name="line.185"></a>
  194. <span class="sourceLineNo">186</span><a name="line.186"></a>
  195. <span class="sourceLineNo">187</span> /** The stroke. */<a name="line.187"></a>
  196. <span class="sourceLineNo">188</span> private transient Stroke lineStroke;<a name="line.188"></a>
  197. <span class="sourceLineNo">189</span><a name="line.189"></a>
  198. <span class="sourceLineNo">190</span> /** The line paint. */<a name="line.190"></a>
  199. <span class="sourceLineNo">191</span> private transient Paint linePaint;<a name="line.191"></a>
  200. <span class="sourceLineNo">192</span><a name="line.192"></a>
  201. <span class="sourceLineNo">193</span> /**<a name="line.193"></a>
  202. <span class="sourceLineNo">194</span> * The shape must be non-null for a LegendItem - if no shape is required,<a name="line.194"></a>
  203. <span class="sourceLineNo">195</span> * use this.<a name="line.195"></a>
  204. <span class="sourceLineNo">196</span> */<a name="line.196"></a>
  205. <span class="sourceLineNo">197</span> private static final Shape UNUSED_SHAPE = new Line2D.Float();<a name="line.197"></a>
  206. <span class="sourceLineNo">198</span><a name="line.198"></a>
  207. <span class="sourceLineNo">199</span> /**<a name="line.199"></a>
  208. <span class="sourceLineNo">200</span> * The stroke must be non-null for a LegendItem - if no stroke is required,<a name="line.200"></a>
  209. <span class="sourceLineNo">201</span> * use this.<a name="line.201"></a>
  210. <span class="sourceLineNo">202</span> */<a name="line.202"></a>
  211. <span class="sourceLineNo">203</span> private static final Stroke UNUSED_STROKE = new BasicStroke(0.0f);<a name="line.203"></a>
  212. <span class="sourceLineNo">204</span><a name="line.204"></a>
  213. <span class="sourceLineNo">205</span> /**<a name="line.205"></a>
  214. <span class="sourceLineNo">206</span> * Creates a legend item with the specified label. The remaining<a name="line.206"></a>
  215. <span class="sourceLineNo">207</span> * attributes take default values.<a name="line.207"></a>
  216. <span class="sourceLineNo">208</span> *<a name="line.208"></a>
  217. <span class="sourceLineNo">209</span> * @param label the label ({@code null} not permitted).<a name="line.209"></a>
  218. <span class="sourceLineNo">210</span> *<a name="line.210"></a>
  219. <span class="sourceLineNo">211</span> * @since 1.0.10<a name="line.211"></a>
  220. <span class="sourceLineNo">212</span> */<a name="line.212"></a>
  221. <span class="sourceLineNo">213</span> public LegendItem(String label) {<a name="line.213"></a>
  222. <span class="sourceLineNo">214</span> this(label, Color.black);<a name="line.214"></a>
  223. <span class="sourceLineNo">215</span> }<a name="line.215"></a>
  224. <span class="sourceLineNo">216</span><a name="line.216"></a>
  225. <span class="sourceLineNo">217</span> /**<a name="line.217"></a>
  226. <span class="sourceLineNo">218</span> * Creates a legend item with the specified label and fill paint. The<a name="line.218"></a>
  227. <span class="sourceLineNo">219</span> * remaining attributes take default values.<a name="line.219"></a>
  228. <span class="sourceLineNo">220</span> *<a name="line.220"></a>
  229. <span class="sourceLineNo">221</span> * @param label the label ({@code null} not permitted).<a name="line.221"></a>
  230. <span class="sourceLineNo">222</span> * @param paint the paint ({@code null} not permitted).<a name="line.222"></a>
  231. <span class="sourceLineNo">223</span> *<a name="line.223"></a>
  232. <span class="sourceLineNo">224</span> * @since 1.0.12<a name="line.224"></a>
  233. <span class="sourceLineNo">225</span> */<a name="line.225"></a>
  234. <span class="sourceLineNo">226</span> public LegendItem(String label, Paint paint) {<a name="line.226"></a>
  235. <span class="sourceLineNo">227</span> this(label, null, null, null, new Rectangle2D.Double(-4.0, -4.0, 8.0,<a name="line.227"></a>
  236. <span class="sourceLineNo">228</span> 8.0), paint);<a name="line.228"></a>
  237. <span class="sourceLineNo">229</span> }<a name="line.229"></a>
  238. <span class="sourceLineNo">230</span><a name="line.230"></a>
  239. <span class="sourceLineNo">231</span> /**<a name="line.231"></a>
  240. <span class="sourceLineNo">232</span> * Creates a legend item with a filled shape. The shape is not outlined,<a name="line.232"></a>
  241. <span class="sourceLineNo">233</span> * and no line is visible.<a name="line.233"></a>
  242. <span class="sourceLineNo">234</span> *<a name="line.234"></a>
  243. <span class="sourceLineNo">235</span> * @param label the label ({@code null} not permitted).<a name="line.235"></a>
  244. <span class="sourceLineNo">236</span> * @param description the description ({@code null} permitted).<a name="line.236"></a>
  245. <span class="sourceLineNo">237</span> * @param toolTipText the tool tip text ({@code null} permitted).<a name="line.237"></a>
  246. <span class="sourceLineNo">238</span> * @param urlText the URL text ({@code null} permitted).<a name="line.238"></a>
  247. <span class="sourceLineNo">239</span> * @param shape the shape ({@code null} not permitted).<a name="line.239"></a>
  248. <span class="sourceLineNo">240</span> * @param fillPaint the paint used to fill the shape ({@code null}<a name="line.240"></a>
  249. <span class="sourceLineNo">241</span> * not permitted).<a name="line.241"></a>
  250. <span class="sourceLineNo">242</span> */<a name="line.242"></a>
  251. <span class="sourceLineNo">243</span> public LegendItem(String label, String description,<a name="line.243"></a>
  252. <span class="sourceLineNo">244</span> String toolTipText, String urlText,<a name="line.244"></a>
  253. <span class="sourceLineNo">245</span> Shape shape, Paint fillPaint) {<a name="line.245"></a>
  254. <span class="sourceLineNo">246</span><a name="line.246"></a>
  255. <span class="sourceLineNo">247</span> this(label, description, toolTipText, urlText,<a name="line.247"></a>
  256. <span class="sourceLineNo">248</span> /* shape visible = */ true, shape,<a name="line.248"></a>
  257. <span class="sourceLineNo">249</span> /* shape filled = */ true, fillPaint,<a name="line.249"></a>
  258. <span class="sourceLineNo">250</span> /* shape outlined */ false, Color.black, UNUSED_STROKE,<a name="line.250"></a>
  259. <span class="sourceLineNo">251</span> /* line visible */ false, UNUSED_SHAPE, UNUSED_STROKE,<a name="line.251"></a>
  260. <span class="sourceLineNo">252</span> Color.black);<a name="line.252"></a>
  261. <span class="sourceLineNo">253</span><a name="line.253"></a>
  262. <span class="sourceLineNo">254</span> }<a name="line.254"></a>
  263. <span class="sourceLineNo">255</span><a name="line.255"></a>
  264. <span class="sourceLineNo">256</span> /**<a name="line.256"></a>
  265. <span class="sourceLineNo">257</span> * Creates a legend item with a filled and outlined shape.<a name="line.257"></a>
  266. <span class="sourceLineNo">258</span> *<a name="line.258"></a>
  267. <span class="sourceLineNo">259</span> * @param label the label ({@code null} not permitted).<a name="line.259"></a>
  268. <span class="sourceLineNo">260</span> * @param description the description ({@code null} permitted).<a name="line.260"></a>
  269. <span class="sourceLineNo">261</span> * @param toolTipText the tool tip text ({@code null} permitted).<a name="line.261"></a>
  270. <span class="sourceLineNo">262</span> * @param urlText the URL text ({@code null} permitted).<a name="line.262"></a>
  271. <span class="sourceLineNo">263</span> * @param shape the shape ({@code null} not permitted).<a name="line.263"></a>
  272. <span class="sourceLineNo">264</span> * @param fillPaint the paint used to fill the shape ({@code null}<a name="line.264"></a>
  273. <span class="sourceLineNo">265</span> * not permitted).<a name="line.265"></a>
  274. <span class="sourceLineNo">266</span> * @param outlineStroke the outline stroke ({@code null} not<a name="line.266"></a>
  275. <span class="sourceLineNo">267</span> * permitted).<a name="line.267"></a>
  276. <span class="sourceLineNo">268</span> * @param outlinePaint the outline paint ({@code null} not<a name="line.268"></a>
  277. <span class="sourceLineNo">269</span> * permitted).<a name="line.269"></a>
  278. <span class="sourceLineNo">270</span> */<a name="line.270"></a>
  279. <span class="sourceLineNo">271</span> public LegendItem(String label, String description, String toolTipText, <a name="line.271"></a>
  280. <span class="sourceLineNo">272</span> String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, <a name="line.272"></a>
  281. <span class="sourceLineNo">273</span> Paint outlinePaint) {<a name="line.273"></a>
  282. <span class="sourceLineNo">274</span><a name="line.274"></a>
  283. <span class="sourceLineNo">275</span> this(label, description, toolTipText, urlText,<a name="line.275"></a>
  284. <span class="sourceLineNo">276</span> /* shape visible = */ true, shape,<a name="line.276"></a>
  285. <span class="sourceLineNo">277</span> /* shape filled = */ true, fillPaint,<a name="line.277"></a>
  286. <span class="sourceLineNo">278</span> /* shape outlined = */ true, outlinePaint, outlineStroke,<a name="line.278"></a>
  287. <span class="sourceLineNo">279</span> /* line visible */ false, UNUSED_SHAPE, UNUSED_STROKE,<a name="line.279"></a>
  288. <span class="sourceLineNo">280</span> Color.black);<a name="line.280"></a>
  289. <span class="sourceLineNo">281</span><a name="line.281"></a>
  290. <span class="sourceLineNo">282</span> }<a name="line.282"></a>
  291. <span class="sourceLineNo">283</span><a name="line.283"></a>
  292. <span class="sourceLineNo">284</span> /**<a name="line.284"></a>
  293. <span class="sourceLineNo">285</span> * Creates a legend item using a line.<a name="line.285"></a>
  294. <span class="sourceLineNo">286</span> *<a name="line.286"></a>
  295. <span class="sourceLineNo">287</span> * @param label the label ({@code null} not permitted).<a name="line.287"></a>
  296. <span class="sourceLineNo">288</span> * @param description the description ({@code null} permitted).<a name="line.288"></a>
  297. <span class="sourceLineNo">289</span> * @param toolTipText the tool tip text ({@code null} permitted).<a name="line.289"></a>
  298. <span class="sourceLineNo">290</span> * @param urlText the URL text ({@code null} permitted).<a name="line.290"></a>
  299. <span class="sourceLineNo">291</span> * @param line the line ({@code null} not permitted).<a name="line.291"></a>
  300. <span class="sourceLineNo">292</span> * @param lineStroke the line stroke ({@code null} not permitted).<a name="line.292"></a>
  301. <span class="sourceLineNo">293</span> * @param linePaint the line paint ({@code null} not permitted).<a name="line.293"></a>
  302. <span class="sourceLineNo">294</span> */<a name="line.294"></a>
  303. <span class="sourceLineNo">295</span> public LegendItem(String label, String description, String toolTipText, <a name="line.295"></a>
  304. <span class="sourceLineNo">296</span> String urlText, Shape line, Stroke lineStroke, Paint linePaint) {<a name="line.296"></a>
  305. <span class="sourceLineNo">297</span><a name="line.297"></a>
  306. <span class="sourceLineNo">298</span> this(label, description, toolTipText, urlText,<a name="line.298"></a>
  307. <span class="sourceLineNo">299</span> /* shape visible = */ false, UNUSED_SHAPE,<a name="line.299"></a>
  308. <span class="sourceLineNo">300</span> /* shape filled = */ false, Color.black,<a name="line.300"></a>
  309. <span class="sourceLineNo">301</span> /* shape outlined = */ false, Color.black, UNUSED_STROKE,<a name="line.301"></a>
  310. <span class="sourceLineNo">302</span> /* line visible = */ true, line, lineStroke, linePaint);<a name="line.302"></a>
  311. <span class="sourceLineNo">303</span> }<a name="line.303"></a>
  312. <span class="sourceLineNo">304</span><a name="line.304"></a>
  313. <span class="sourceLineNo">305</span> /**<a name="line.305"></a>
  314. <span class="sourceLineNo">306</span> * Creates a new legend item.<a name="line.306"></a>
  315. <span class="sourceLineNo">307</span> *<a name="line.307"></a>
  316. <span class="sourceLineNo">308</span> * @param label the label ({@code null} not permitted).<a name="line.308"></a>
  317. <span class="sourceLineNo">309</span> * @param description the description (not currently used,<a name="line.309"></a>
  318. <span class="sourceLineNo">310</span> * &lt;code&gt;null&lt;/code&gt; permitted).<a name="line.310"></a>
  319. <span class="sourceLineNo">311</span> * @param toolTipText the tool tip text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.311"></a>
  320. <span class="sourceLineNo">312</span> * @param urlText the URL text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.312"></a>
  321. <span class="sourceLineNo">313</span> * @param shapeVisible a flag that controls whether or not the shape is<a name="line.313"></a>
  322. <span class="sourceLineNo">314</span> * displayed.<a name="line.314"></a>
  323. <span class="sourceLineNo">315</span> * @param shape the shape (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.315"></a>
  324. <span class="sourceLineNo">316</span> * @param shapeFilled a flag that controls whether or not the shape is<a name="line.316"></a>
  325. <span class="sourceLineNo">317</span> * filled.<a name="line.317"></a>
  326. <span class="sourceLineNo">318</span> * @param fillPaint the fill paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.318"></a>
  327. <span class="sourceLineNo">319</span> * @param shapeOutlineVisible a flag that controls whether or not the<a name="line.319"></a>
  328. <span class="sourceLineNo">320</span> * shape is outlined.<a name="line.320"></a>
  329. <span class="sourceLineNo">321</span> * @param outlinePaint the outline paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.321"></a>
  330. <span class="sourceLineNo">322</span> * @param outlineStroke the outline stroke (&lt;code&gt;null&lt;/code&gt; not<a name="line.322"></a>
  331. <span class="sourceLineNo">323</span> * permitted).<a name="line.323"></a>
  332. <span class="sourceLineNo">324</span> * @param lineVisible a flag that controls whether or not the line is<a name="line.324"></a>
  333. <span class="sourceLineNo">325</span> * visible.<a name="line.325"></a>
  334. <span class="sourceLineNo">326</span> * @param line the line.<a name="line.326"></a>
  335. <span class="sourceLineNo">327</span> * @param lineStroke the stroke (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.327"></a>
  336. <span class="sourceLineNo">328</span> * @param linePaint the line paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.328"></a>
  337. <span class="sourceLineNo">329</span> */<a name="line.329"></a>
  338. <span class="sourceLineNo">330</span> public LegendItem(String label, String description,<a name="line.330"></a>
  339. <span class="sourceLineNo">331</span> String toolTipText, String urlText,<a name="line.331"></a>
  340. <span class="sourceLineNo">332</span> boolean shapeVisible, Shape shape,<a name="line.332"></a>
  341. <span class="sourceLineNo">333</span> boolean shapeFilled, Paint fillPaint,<a name="line.333"></a>
  342. <span class="sourceLineNo">334</span> boolean shapeOutlineVisible, Paint outlinePaint,<a name="line.334"></a>
  343. <span class="sourceLineNo">335</span> Stroke outlineStroke,<a name="line.335"></a>
  344. <span class="sourceLineNo">336</span> boolean lineVisible, Shape line,<a name="line.336"></a>
  345. <span class="sourceLineNo">337</span> Stroke lineStroke, Paint linePaint) {<a name="line.337"></a>
  346. <span class="sourceLineNo">338</span><a name="line.338"></a>
  347. <span class="sourceLineNo">339</span> ParamChecks.nullNotPermitted(label, "label");<a name="line.339"></a>
  348. <span class="sourceLineNo">340</span> ParamChecks.nullNotPermitted(fillPaint, "fillPaint");<a name="line.340"></a>
  349. <span class="sourceLineNo">341</span> ParamChecks.nullNotPermitted(lineStroke, "lineStroke");<a name="line.341"></a>
  350. <span class="sourceLineNo">342</span> ParamChecks.nullNotPermitted(outlinePaint, "outlinePaint");<a name="line.342"></a>
  351. <span class="sourceLineNo">343</span> ParamChecks.nullNotPermitted(outlineStroke, "outlineStroke");<a name="line.343"></a>
  352. <span class="sourceLineNo">344</span> this.label = label;<a name="line.344"></a>
  353. <span class="sourceLineNo">345</span> this.labelPaint = null;<a name="line.345"></a>
  354. <span class="sourceLineNo">346</span> this.attributedLabel = null;<a name="line.346"></a>
  355. <span class="sourceLineNo">347</span> this.description = description;<a name="line.347"></a>
  356. <span class="sourceLineNo">348</span> this.shapeVisible = shapeVisible;<a name="line.348"></a>
  357. <span class="sourceLineNo">349</span> this.shape = shape;<a name="line.349"></a>
  358. <span class="sourceLineNo">350</span> this.shapeFilled = shapeFilled;<a name="line.350"></a>
  359. <span class="sourceLineNo">351</span> this.fillPaint = fillPaint;<a name="line.351"></a>
  360. <span class="sourceLineNo">352</span> this.fillPaintTransformer = new StandardGradientPaintTransformer();<a name="line.352"></a>
  361. <span class="sourceLineNo">353</span> this.shapeOutlineVisible = shapeOutlineVisible;<a name="line.353"></a>
  362. <span class="sourceLineNo">354</span> this.outlinePaint = outlinePaint;<a name="line.354"></a>
  363. <span class="sourceLineNo">355</span> this.outlineStroke = outlineStroke;<a name="line.355"></a>
  364. <span class="sourceLineNo">356</span> this.lineVisible = lineVisible;<a name="line.356"></a>
  365. <span class="sourceLineNo">357</span> this.line = line;<a name="line.357"></a>
  366. <span class="sourceLineNo">358</span> this.lineStroke = lineStroke;<a name="line.358"></a>
  367. <span class="sourceLineNo">359</span> this.linePaint = linePaint;<a name="line.359"></a>
  368. <span class="sourceLineNo">360</span> this.toolTipText = toolTipText;<a name="line.360"></a>
  369. <span class="sourceLineNo">361</span> this.urlText = urlText;<a name="line.361"></a>
  370. <span class="sourceLineNo">362</span> }<a name="line.362"></a>
  371. <span class="sourceLineNo">363</span><a name="line.363"></a>
  372. <span class="sourceLineNo">364</span> /**<a name="line.364"></a>
  373. <span class="sourceLineNo">365</span> * Creates a legend item with a filled shape. The shape is not outlined,<a name="line.365"></a>
  374. <span class="sourceLineNo">366</span> * and no line is visible.<a name="line.366"></a>
  375. <span class="sourceLineNo">367</span> *<a name="line.367"></a>
  376. <span class="sourceLineNo">368</span> * @param label the label (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.368"></a>
  377. <span class="sourceLineNo">369</span> * @param description the description (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.369"></a>
  378. <span class="sourceLineNo">370</span> * @param toolTipText the tool tip text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.370"></a>
  379. <span class="sourceLineNo">371</span> * @param urlText the URL text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.371"></a>
  380. <span class="sourceLineNo">372</span> * @param shape the shape (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.372"></a>
  381. <span class="sourceLineNo">373</span> * @param fillPaint the paint used to fill the shape (&lt;code&gt;null&lt;/code&gt;<a name="line.373"></a>
  382. <span class="sourceLineNo">374</span> * not permitted).<a name="line.374"></a>
  383. <span class="sourceLineNo">375</span> */<a name="line.375"></a>
  384. <span class="sourceLineNo">376</span> public LegendItem(AttributedString label, String description,<a name="line.376"></a>
  385. <span class="sourceLineNo">377</span> String toolTipText, String urlText,<a name="line.377"></a>
  386. <span class="sourceLineNo">378</span> Shape shape, Paint fillPaint) {<a name="line.378"></a>
  387. <span class="sourceLineNo">379</span><a name="line.379"></a>
  388. <span class="sourceLineNo">380</span> this(label, description, toolTipText, urlText,<a name="line.380"></a>
  389. <span class="sourceLineNo">381</span> /* shape visible = */ true, shape,<a name="line.381"></a>
  390. <span class="sourceLineNo">382</span> /* shape filled = */ true, fillPaint,<a name="line.382"></a>
  391. <span class="sourceLineNo">383</span> /* shape outlined = */ false, Color.black, UNUSED_STROKE,<a name="line.383"></a>
  392. <span class="sourceLineNo">384</span> /* line visible = */ false, UNUSED_SHAPE, UNUSED_STROKE,<a name="line.384"></a>
  393. <span class="sourceLineNo">385</span> Color.black);<a name="line.385"></a>
  394. <span class="sourceLineNo">386</span><a name="line.386"></a>
  395. <span class="sourceLineNo">387</span> }<a name="line.387"></a>
  396. <span class="sourceLineNo">388</span><a name="line.388"></a>
  397. <span class="sourceLineNo">389</span> /**<a name="line.389"></a>
  398. <span class="sourceLineNo">390</span> * Creates a legend item with a filled and outlined shape.<a name="line.390"></a>
  399. <span class="sourceLineNo">391</span> *<a name="line.391"></a>
  400. <span class="sourceLineNo">392</span> * @param label the label (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.392"></a>
  401. <span class="sourceLineNo">393</span> * @param description the description (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.393"></a>
  402. <span class="sourceLineNo">394</span> * @param toolTipText the tool tip text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.394"></a>
  403. <span class="sourceLineNo">395</span> * @param urlText the URL text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.395"></a>
  404. <span class="sourceLineNo">396</span> * @param shape the shape (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.396"></a>
  405. <span class="sourceLineNo">397</span> * @param fillPaint the paint used to fill the shape (&lt;code&gt;null&lt;/code&gt;<a name="line.397"></a>
  406. <span class="sourceLineNo">398</span> * not permitted).<a name="line.398"></a>
  407. <span class="sourceLineNo">399</span> * @param outlineStroke the outline stroke (&lt;code&gt;null&lt;/code&gt; not<a name="line.399"></a>
  408. <span class="sourceLineNo">400</span> * permitted).<a name="line.400"></a>
  409. <span class="sourceLineNo">401</span> * @param outlinePaint the outline paint (&lt;code&gt;null&lt;/code&gt; not<a name="line.401"></a>
  410. <span class="sourceLineNo">402</span> * permitted).<a name="line.402"></a>
  411. <span class="sourceLineNo">403</span> */<a name="line.403"></a>
  412. <span class="sourceLineNo">404</span> public LegendItem(AttributedString label, String description,<a name="line.404"></a>
  413. <span class="sourceLineNo">405</span> String toolTipText, String urlText,<a name="line.405"></a>
  414. <span class="sourceLineNo">406</span> Shape shape, Paint fillPaint,<a name="line.406"></a>
  415. <span class="sourceLineNo">407</span> Stroke outlineStroke, Paint outlinePaint) {<a name="line.407"></a>
  416. <span class="sourceLineNo">408</span><a name="line.408"></a>
  417. <span class="sourceLineNo">409</span> this(label, description, toolTipText, urlText,<a name="line.409"></a>
  418. <span class="sourceLineNo">410</span> /* shape visible = */ true, shape,<a name="line.410"></a>
  419. <span class="sourceLineNo">411</span> /* shape filled = */ true, fillPaint,<a name="line.411"></a>
  420. <span class="sourceLineNo">412</span> /* shape outlined = */ true, outlinePaint, outlineStroke,<a name="line.412"></a>
  421. <span class="sourceLineNo">413</span> /* line visible = */ false, UNUSED_SHAPE, UNUSED_STROKE,<a name="line.413"></a>
  422. <span class="sourceLineNo">414</span> Color.black);<a name="line.414"></a>
  423. <span class="sourceLineNo">415</span> }<a name="line.415"></a>
  424. <span class="sourceLineNo">416</span><a name="line.416"></a>
  425. <span class="sourceLineNo">417</span> /**<a name="line.417"></a>
  426. <span class="sourceLineNo">418</span> * Creates a legend item using a line.<a name="line.418"></a>
  427. <span class="sourceLineNo">419</span> *<a name="line.419"></a>
  428. <span class="sourceLineNo">420</span> * @param label the label (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.420"></a>
  429. <span class="sourceLineNo">421</span> * @param description the description (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.421"></a>
  430. <span class="sourceLineNo">422</span> * @param toolTipText the tool tip text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.422"></a>
  431. <span class="sourceLineNo">423</span> * @param urlText the URL text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.423"></a>
  432. <span class="sourceLineNo">424</span> * @param line the line (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.424"></a>
  433. <span class="sourceLineNo">425</span> * @param lineStroke the line stroke (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.425"></a>
  434. <span class="sourceLineNo">426</span> * @param linePaint the line paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.426"></a>
  435. <span class="sourceLineNo">427</span> */<a name="line.427"></a>
  436. <span class="sourceLineNo">428</span> public LegendItem(AttributedString label, String description,<a name="line.428"></a>
  437. <span class="sourceLineNo">429</span> String toolTipText, String urlText,<a name="line.429"></a>
  438. <span class="sourceLineNo">430</span> Shape line, Stroke lineStroke, Paint linePaint) {<a name="line.430"></a>
  439. <span class="sourceLineNo">431</span><a name="line.431"></a>
  440. <span class="sourceLineNo">432</span> this(label, description, toolTipText, urlText,<a name="line.432"></a>
  441. <span class="sourceLineNo">433</span> /* shape visible = */ false, UNUSED_SHAPE,<a name="line.433"></a>
  442. <span class="sourceLineNo">434</span> /* shape filled = */ false, Color.black,<a name="line.434"></a>
  443. <span class="sourceLineNo">435</span> /* shape outlined = */ false, Color.black, UNUSED_STROKE,<a name="line.435"></a>
  444. <span class="sourceLineNo">436</span> /* line visible = */ true, line, lineStroke, linePaint);<a name="line.436"></a>
  445. <span class="sourceLineNo">437</span> }<a name="line.437"></a>
  446. <span class="sourceLineNo">438</span><a name="line.438"></a>
  447. <span class="sourceLineNo">439</span> /**<a name="line.439"></a>
  448. <span class="sourceLineNo">440</span> * Creates a new legend item.<a name="line.440"></a>
  449. <span class="sourceLineNo">441</span> *<a name="line.441"></a>
  450. <span class="sourceLineNo">442</span> * @param label the label (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.442"></a>
  451. <span class="sourceLineNo">443</span> * @param description the description (not currently used,<a name="line.443"></a>
  452. <span class="sourceLineNo">444</span> * &lt;code&gt;null&lt;/code&gt; permitted).<a name="line.444"></a>
  453. <span class="sourceLineNo">445</span> * @param toolTipText the tool tip text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.445"></a>
  454. <span class="sourceLineNo">446</span> * @param urlText the URL text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.446"></a>
  455. <span class="sourceLineNo">447</span> * @param shapeVisible a flag that controls whether or not the shape is<a name="line.447"></a>
  456. <span class="sourceLineNo">448</span> * displayed.<a name="line.448"></a>
  457. <span class="sourceLineNo">449</span> * @param shape the shape (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.449"></a>
  458. <span class="sourceLineNo">450</span> * @param shapeFilled a flag that controls whether or not the shape is<a name="line.450"></a>
  459. <span class="sourceLineNo">451</span> * filled.<a name="line.451"></a>
  460. <span class="sourceLineNo">452</span> * @param fillPaint the fill paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.452"></a>
  461. <span class="sourceLineNo">453</span> * @param shapeOutlineVisible a flag that controls whether or not the<a name="line.453"></a>
  462. <span class="sourceLineNo">454</span> * shape is outlined.<a name="line.454"></a>
  463. <span class="sourceLineNo">455</span> * @param outlinePaint the outline paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.455"></a>
  464. <span class="sourceLineNo">456</span> * @param outlineStroke the outline stroke (&lt;code&gt;null&lt;/code&gt; not<a name="line.456"></a>
  465. <span class="sourceLineNo">457</span> * permitted).<a name="line.457"></a>
  466. <span class="sourceLineNo">458</span> * @param lineVisible a flag that controls whether or not the line is<a name="line.458"></a>
  467. <span class="sourceLineNo">459</span> * visible.<a name="line.459"></a>
  468. <span class="sourceLineNo">460</span> * @param line the line (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.460"></a>
  469. <span class="sourceLineNo">461</span> * @param lineStroke the stroke (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.461"></a>
  470. <span class="sourceLineNo">462</span> * @param linePaint the line paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.462"></a>
  471. <span class="sourceLineNo">463</span> */<a name="line.463"></a>
  472. <span class="sourceLineNo">464</span> public LegendItem(AttributedString label, String description,<a name="line.464"></a>
  473. <span class="sourceLineNo">465</span> String toolTipText, String urlText,<a name="line.465"></a>
  474. <span class="sourceLineNo">466</span> boolean shapeVisible, Shape shape,<a name="line.466"></a>
  475. <span class="sourceLineNo">467</span> boolean shapeFilled, Paint fillPaint,<a name="line.467"></a>
  476. <span class="sourceLineNo">468</span> boolean shapeOutlineVisible, Paint outlinePaint,<a name="line.468"></a>
  477. <span class="sourceLineNo">469</span> Stroke outlineStroke,<a name="line.469"></a>
  478. <span class="sourceLineNo">470</span> boolean lineVisible, Shape line, Stroke lineStroke,<a name="line.470"></a>
  479. <span class="sourceLineNo">471</span> Paint linePaint) {<a name="line.471"></a>
  480. <span class="sourceLineNo">472</span><a name="line.472"></a>
  481. <span class="sourceLineNo">473</span> ParamChecks.nullNotPermitted(label, "label");<a name="line.473"></a>
  482. <span class="sourceLineNo">474</span> ParamChecks.nullNotPermitted(fillPaint, "fillPaint");<a name="line.474"></a>
  483. <span class="sourceLineNo">475</span> ParamChecks.nullNotPermitted(lineStroke, "lineStroke");<a name="line.475"></a>
  484. <span class="sourceLineNo">476</span> ParamChecks.nullNotPermitted(line, "line");<a name="line.476"></a>
  485. <span class="sourceLineNo">477</span> ParamChecks.nullNotPermitted(linePaint, "linePaint");<a name="line.477"></a>
  486. <span class="sourceLineNo">478</span> ParamChecks.nullNotPermitted(outlinePaint, "outlinePaint");<a name="line.478"></a>
  487. <span class="sourceLineNo">479</span> ParamChecks.nullNotPermitted(outlineStroke, "outlineStroke");<a name="line.479"></a>
  488. <span class="sourceLineNo">480</span> this.label = characterIteratorToString(label.getIterator());<a name="line.480"></a>
  489. <span class="sourceLineNo">481</span> this.attributedLabel = label;<a name="line.481"></a>
  490. <span class="sourceLineNo">482</span> this.description = description;<a name="line.482"></a>
  491. <span class="sourceLineNo">483</span> this.shapeVisible = shapeVisible;<a name="line.483"></a>
  492. <span class="sourceLineNo">484</span> this.shape = shape;<a name="line.484"></a>
  493. <span class="sourceLineNo">485</span> this.shapeFilled = shapeFilled;<a name="line.485"></a>
  494. <span class="sourceLineNo">486</span> this.fillPaint = fillPaint;<a name="line.486"></a>
  495. <span class="sourceLineNo">487</span> this.fillPaintTransformer = new StandardGradientPaintTransformer();<a name="line.487"></a>
  496. <span class="sourceLineNo">488</span> this.shapeOutlineVisible = shapeOutlineVisible;<a name="line.488"></a>
  497. <span class="sourceLineNo">489</span> this.outlinePaint = outlinePaint;<a name="line.489"></a>
  498. <span class="sourceLineNo">490</span> this.outlineStroke = outlineStroke;<a name="line.490"></a>
  499. <span class="sourceLineNo">491</span> this.lineVisible = lineVisible;<a name="line.491"></a>
  500. <span class="sourceLineNo">492</span> this.line = line;<a name="line.492"></a>
  501. <span class="sourceLineNo">493</span> this.lineStroke = lineStroke;<a name="line.493"></a>
  502. <span class="sourceLineNo">494</span> this.linePaint = linePaint;<a name="line.494"></a>
  503. <span class="sourceLineNo">495</span> this.toolTipText = toolTipText;<a name="line.495"></a>
  504. <span class="sourceLineNo">496</span> this.urlText = urlText;<a name="line.496"></a>
  505. <span class="sourceLineNo">497</span> }<a name="line.497"></a>
  506. <span class="sourceLineNo">498</span><a name="line.498"></a>
  507. <span class="sourceLineNo">499</span> /**<a name="line.499"></a>
  508. <span class="sourceLineNo">500</span> * Returns a string containing the characters from the given iterator.<a name="line.500"></a>
  509. <span class="sourceLineNo">501</span> *<a name="line.501"></a>
  510. <span class="sourceLineNo">502</span> * @param iterator the iterator (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.502"></a>
  511. <span class="sourceLineNo">503</span> *<a name="line.503"></a>
  512. <span class="sourceLineNo">504</span> * @return A string.<a name="line.504"></a>
  513. <span class="sourceLineNo">505</span> */<a name="line.505"></a>
  514. <span class="sourceLineNo">506</span> private String characterIteratorToString(CharacterIterator iterator) {<a name="line.506"></a>
  515. <span class="sourceLineNo">507</span> int endIndex = iterator.getEndIndex();<a name="line.507"></a>
  516. <span class="sourceLineNo">508</span> int beginIndex = iterator.getBeginIndex();<a name="line.508"></a>
  517. <span class="sourceLineNo">509</span> int count = endIndex - beginIndex;<a name="line.509"></a>
  518. <span class="sourceLineNo">510</span> if (count &lt;= 0) {<a name="line.510"></a>
  519. <span class="sourceLineNo">511</span> return "";<a name="line.511"></a>
  520. <span class="sourceLineNo">512</span> }<a name="line.512"></a>
  521. <span class="sourceLineNo">513</span> char[] chars = new char[count];<a name="line.513"></a>
  522. <span class="sourceLineNo">514</span> int i = 0;<a name="line.514"></a>
  523. <span class="sourceLineNo">515</span> char c = iterator.first();<a name="line.515"></a>
  524. <span class="sourceLineNo">516</span> while (c != CharacterIterator.DONE) {<a name="line.516"></a>
  525. <span class="sourceLineNo">517</span> chars[i] = c;<a name="line.517"></a>
  526. <span class="sourceLineNo">518</span> i++;<a name="line.518"></a>
  527. <span class="sourceLineNo">519</span> c = iterator.next();<a name="line.519"></a>
  528. <span class="sourceLineNo">520</span> }<a name="line.520"></a>
  529. <span class="sourceLineNo">521</span> return new String(chars);<a name="line.521"></a>
  530. <span class="sourceLineNo">522</span> }<a name="line.522"></a>
  531. <span class="sourceLineNo">523</span><a name="line.523"></a>
  532. <span class="sourceLineNo">524</span> /**<a name="line.524"></a>
  533. <span class="sourceLineNo">525</span> * Returns the dataset.<a name="line.525"></a>
  534. <span class="sourceLineNo">526</span> *<a name="line.526"></a>
  535. <span class="sourceLineNo">527</span> * @return The dataset.<a name="line.527"></a>
  536. <span class="sourceLineNo">528</span> *<a name="line.528"></a>
  537. <span class="sourceLineNo">529</span> * @since 1.0.6<a name="line.529"></a>
  538. <span class="sourceLineNo">530</span> *<a name="line.530"></a>
  539. <span class="sourceLineNo">531</span> * @see #setDatasetIndex(int)<a name="line.531"></a>
  540. <span class="sourceLineNo">532</span> */<a name="line.532"></a>
  541. <span class="sourceLineNo">533</span> public Dataset getDataset() {<a name="line.533"></a>
  542. <span class="sourceLineNo">534</span> return this.dataset;<a name="line.534"></a>
  543. <span class="sourceLineNo">535</span> }<a name="line.535"></a>
  544. <span class="sourceLineNo">536</span><a name="line.536"></a>
  545. <span class="sourceLineNo">537</span> /**<a name="line.537"></a>
  546. <span class="sourceLineNo">538</span> * Sets the dataset.<a name="line.538"></a>
  547. <span class="sourceLineNo">539</span> *<a name="line.539"></a>
  548. <span class="sourceLineNo">540</span> * @param dataset the dataset.<a name="line.540"></a>
  549. <span class="sourceLineNo">541</span> *<a name="line.541"></a>
  550. <span class="sourceLineNo">542</span> * @since 1.0.6<a name="line.542"></a>
  551. <span class="sourceLineNo">543</span> */<a name="line.543"></a>
  552. <span class="sourceLineNo">544</span> public void setDataset(Dataset dataset) {<a name="line.544"></a>
  553. <span class="sourceLineNo">545</span> this.dataset = dataset;<a name="line.545"></a>
  554. <span class="sourceLineNo">546</span> }<a name="line.546"></a>
  555. <span class="sourceLineNo">547</span><a name="line.547"></a>
  556. <span class="sourceLineNo">548</span> /**<a name="line.548"></a>
  557. <span class="sourceLineNo">549</span> * Returns the dataset index for this legend item.<a name="line.549"></a>
  558. <span class="sourceLineNo">550</span> *<a name="line.550"></a>
  559. <span class="sourceLineNo">551</span> * @return The dataset index.<a name="line.551"></a>
  560. <span class="sourceLineNo">552</span> *<a name="line.552"></a>
  561. <span class="sourceLineNo">553</span> * @since 1.0.2<a name="line.553"></a>
  562. <span class="sourceLineNo">554</span> *<a name="line.554"></a>
  563. <span class="sourceLineNo">555</span> * @see #setDatasetIndex(int)<a name="line.555"></a>
  564. <span class="sourceLineNo">556</span> * @see #getDataset()<a name="line.556"></a>
  565. <span class="sourceLineNo">557</span> */<a name="line.557"></a>
  566. <span class="sourceLineNo">558</span> public int getDatasetIndex() {<a name="line.558"></a>
  567. <span class="sourceLineNo">559</span> return this.datasetIndex;<a name="line.559"></a>
  568. <span class="sourceLineNo">560</span> }<a name="line.560"></a>
  569. <span class="sourceLineNo">561</span><a name="line.561"></a>
  570. <span class="sourceLineNo">562</span> /**<a name="line.562"></a>
  571. <span class="sourceLineNo">563</span> * Sets the dataset index for this legend item.<a name="line.563"></a>
  572. <span class="sourceLineNo">564</span> *<a name="line.564"></a>
  573. <span class="sourceLineNo">565</span> * @param index the index.<a name="line.565"></a>
  574. <span class="sourceLineNo">566</span> *<a name="line.566"></a>
  575. <span class="sourceLineNo">567</span> * @since 1.0.2<a name="line.567"></a>
  576. <span class="sourceLineNo">568</span> *<a name="line.568"></a>
  577. <span class="sourceLineNo">569</span> * @see #getDatasetIndex()<a name="line.569"></a>
  578. <span class="sourceLineNo">570</span> */<a name="line.570"></a>
  579. <span class="sourceLineNo">571</span> public void setDatasetIndex(int index) {<a name="line.571"></a>
  580. <span class="sourceLineNo">572</span> this.datasetIndex = index;<a name="line.572"></a>
  581. <span class="sourceLineNo">573</span> }<a name="line.573"></a>
  582. <span class="sourceLineNo">574</span><a name="line.574"></a>
  583. <span class="sourceLineNo">575</span> /**<a name="line.575"></a>
  584. <span class="sourceLineNo">576</span> * Returns the series key.<a name="line.576"></a>
  585. <span class="sourceLineNo">577</span> *<a name="line.577"></a>
  586. <span class="sourceLineNo">578</span> * @return The series key.<a name="line.578"></a>
  587. <span class="sourceLineNo">579</span> *<a name="line.579"></a>
  588. <span class="sourceLineNo">580</span> * @since 1.0.6<a name="line.580"></a>
  589. <span class="sourceLineNo">581</span> *<a name="line.581"></a>
  590. <span class="sourceLineNo">582</span> * @see #setSeriesKey(Comparable)<a name="line.582"></a>
  591. <span class="sourceLineNo">583</span> */<a name="line.583"></a>
  592. <span class="sourceLineNo">584</span> public Comparable getSeriesKey() {<a name="line.584"></a>
  593. <span class="sourceLineNo">585</span> return this.seriesKey;<a name="line.585"></a>
  594. <span class="sourceLineNo">586</span> }<a name="line.586"></a>
  595. <span class="sourceLineNo">587</span><a name="line.587"></a>
  596. <span class="sourceLineNo">588</span> /**<a name="line.588"></a>
  597. <span class="sourceLineNo">589</span> * Sets the series key.<a name="line.589"></a>
  598. <span class="sourceLineNo">590</span> *<a name="line.590"></a>
  599. <span class="sourceLineNo">591</span> * @param key the series key.<a name="line.591"></a>
  600. <span class="sourceLineNo">592</span> *<a name="line.592"></a>
  601. <span class="sourceLineNo">593</span> * @since 1.0.6<a name="line.593"></a>
  602. <span class="sourceLineNo">594</span> */<a name="line.594"></a>
  603. <span class="sourceLineNo">595</span> public void setSeriesKey(Comparable key) {<a name="line.595"></a>
  604. <span class="sourceLineNo">596</span> this.seriesKey = key;<a name="line.596"></a>
  605. <span class="sourceLineNo">597</span> }<a name="line.597"></a>
  606. <span class="sourceLineNo">598</span><a name="line.598"></a>
  607. <span class="sourceLineNo">599</span> /**<a name="line.599"></a>
  608. <span class="sourceLineNo">600</span> * Returns the series index for this legend item.<a name="line.600"></a>
  609. <span class="sourceLineNo">601</span> *<a name="line.601"></a>
  610. <span class="sourceLineNo">602</span> * @return The series index.<a name="line.602"></a>
  611. <span class="sourceLineNo">603</span> *<a name="line.603"></a>
  612. <span class="sourceLineNo">604</span> * @since 1.0.2<a name="line.604"></a>
  613. <span class="sourceLineNo">605</span> */<a name="line.605"></a>
  614. <span class="sourceLineNo">606</span> public int getSeriesIndex() {<a name="line.606"></a>
  615. <span class="sourceLineNo">607</span> return this.series;<a name="line.607"></a>
  616. <span class="sourceLineNo">608</span> }<a name="line.608"></a>
  617. <span class="sourceLineNo">609</span><a name="line.609"></a>
  618. <span class="sourceLineNo">610</span> /**<a name="line.610"></a>
  619. <span class="sourceLineNo">611</span> * Sets the series index for this legend item.<a name="line.611"></a>
  620. <span class="sourceLineNo">612</span> *<a name="line.612"></a>
  621. <span class="sourceLineNo">613</span> * @param index the index.<a name="line.613"></a>
  622. <span class="sourceLineNo">614</span> *<a name="line.614"></a>
  623. <span class="sourceLineNo">615</span> * @since 1.0.2<a name="line.615"></a>
  624. <span class="sourceLineNo">616</span> */<a name="line.616"></a>
  625. <span class="sourceLineNo">617</span> public void setSeriesIndex(int index) {<a name="line.617"></a>
  626. <span class="sourceLineNo">618</span> this.series = index;<a name="line.618"></a>
  627. <span class="sourceLineNo">619</span> }<a name="line.619"></a>
  628. <span class="sourceLineNo">620</span><a name="line.620"></a>
  629. <span class="sourceLineNo">621</span> /**<a name="line.621"></a>
  630. <span class="sourceLineNo">622</span> * Returns the label.<a name="line.622"></a>
  631. <span class="sourceLineNo">623</span> *<a name="line.623"></a>
  632. <span class="sourceLineNo">624</span> * @return The label (never &lt;code&gt;null&lt;/code&gt;).<a name="line.624"></a>
  633. <span class="sourceLineNo">625</span> */<a name="line.625"></a>
  634. <span class="sourceLineNo">626</span> public String getLabel() {<a name="line.626"></a>
  635. <span class="sourceLineNo">627</span> return this.label;<a name="line.627"></a>
  636. <span class="sourceLineNo">628</span> }<a name="line.628"></a>
  637. <span class="sourceLineNo">629</span><a name="line.629"></a>
  638. <span class="sourceLineNo">630</span> /**<a name="line.630"></a>
  639. <span class="sourceLineNo">631</span> * Returns the label font.<a name="line.631"></a>
  640. <span class="sourceLineNo">632</span> *<a name="line.632"></a>
  641. <span class="sourceLineNo">633</span> * @return The label font (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.633"></a>
  642. <span class="sourceLineNo">634</span> *<a name="line.634"></a>
  643. <span class="sourceLineNo">635</span> * @since 1.0.11<a name="line.635"></a>
  644. <span class="sourceLineNo">636</span> */<a name="line.636"></a>
  645. <span class="sourceLineNo">637</span> public Font getLabelFont() {<a name="line.637"></a>
  646. <span class="sourceLineNo">638</span> return this.labelFont;<a name="line.638"></a>
  647. <span class="sourceLineNo">639</span> }<a name="line.639"></a>
  648. <span class="sourceLineNo">640</span><a name="line.640"></a>
  649. <span class="sourceLineNo">641</span> /**<a name="line.641"></a>
  650. <span class="sourceLineNo">642</span> * Sets the label font.<a name="line.642"></a>
  651. <span class="sourceLineNo">643</span> *<a name="line.643"></a>
  652. <span class="sourceLineNo">644</span> * @param font the font (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.644"></a>
  653. <span class="sourceLineNo">645</span> *<a name="line.645"></a>
  654. <span class="sourceLineNo">646</span> * @since 1.0.11<a name="line.646"></a>
  655. <span class="sourceLineNo">647</span> */<a name="line.647"></a>
  656. <span class="sourceLineNo">648</span> public void setLabelFont(Font font) {<a name="line.648"></a>
  657. <span class="sourceLineNo">649</span> this.labelFont = font;<a name="line.649"></a>
  658. <span class="sourceLineNo">650</span> }<a name="line.650"></a>
  659. <span class="sourceLineNo">651</span><a name="line.651"></a>
  660. <span class="sourceLineNo">652</span> /**<a name="line.652"></a>
  661. <span class="sourceLineNo">653</span> * Returns the paint used to draw the label.<a name="line.653"></a>
  662. <span class="sourceLineNo">654</span> *<a name="line.654"></a>
  663. <span class="sourceLineNo">655</span> * @return The paint (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.655"></a>
  664. <span class="sourceLineNo">656</span> *<a name="line.656"></a>
  665. <span class="sourceLineNo">657</span> * @since 1.0.11<a name="line.657"></a>
  666. <span class="sourceLineNo">658</span> */<a name="line.658"></a>
  667. <span class="sourceLineNo">659</span> public Paint getLabelPaint() {<a name="line.659"></a>
  668. <span class="sourceLineNo">660</span> return this.labelPaint;<a name="line.660"></a>
  669. <span class="sourceLineNo">661</span> }<a name="line.661"></a>
  670. <span class="sourceLineNo">662</span><a name="line.662"></a>
  671. <span class="sourceLineNo">663</span> /**<a name="line.663"></a>
  672. <span class="sourceLineNo">664</span> * Sets the paint used to draw the label.<a name="line.664"></a>
  673. <span class="sourceLineNo">665</span> *<a name="line.665"></a>
  674. <span class="sourceLineNo">666</span> * @param paint the paint (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.666"></a>
  675. <span class="sourceLineNo">667</span> *<a name="line.667"></a>
  676. <span class="sourceLineNo">668</span> * @since 1.0.11<a name="line.668"></a>
  677. <span class="sourceLineNo">669</span> */<a name="line.669"></a>
  678. <span class="sourceLineNo">670</span> public void setLabelPaint(Paint paint) {<a name="line.670"></a>
  679. <span class="sourceLineNo">671</span> this.labelPaint = paint;<a name="line.671"></a>
  680. <span class="sourceLineNo">672</span> }<a name="line.672"></a>
  681. <span class="sourceLineNo">673</span><a name="line.673"></a>
  682. <span class="sourceLineNo">674</span> /**<a name="line.674"></a>
  683. <span class="sourceLineNo">675</span> * Returns the attributed label.<a name="line.675"></a>
  684. <span class="sourceLineNo">676</span> *<a name="line.676"></a>
  685. <span class="sourceLineNo">677</span> * @return The attributed label (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.677"></a>
  686. <span class="sourceLineNo">678</span> */<a name="line.678"></a>
  687. <span class="sourceLineNo">679</span> public AttributedString getAttributedLabel() {<a name="line.679"></a>
  688. <span class="sourceLineNo">680</span> return this.attributedLabel;<a name="line.680"></a>
  689. <span class="sourceLineNo">681</span> }<a name="line.681"></a>
  690. <span class="sourceLineNo">682</span><a name="line.682"></a>
  691. <span class="sourceLineNo">683</span> /**<a name="line.683"></a>
  692. <span class="sourceLineNo">684</span> * Returns the description for the legend item.<a name="line.684"></a>
  693. <span class="sourceLineNo">685</span> *<a name="line.685"></a>
  694. <span class="sourceLineNo">686</span> * @return The description (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.686"></a>
  695. <span class="sourceLineNo">687</span> *<a name="line.687"></a>
  696. <span class="sourceLineNo">688</span> * @see #setDescription(java.lang.String) <a name="line.688"></a>
  697. <span class="sourceLineNo">689</span> */<a name="line.689"></a>
  698. <span class="sourceLineNo">690</span> public String getDescription() {<a name="line.690"></a>
  699. <span class="sourceLineNo">691</span> return this.description;<a name="line.691"></a>
  700. <span class="sourceLineNo">692</span> }<a name="line.692"></a>
  701. <span class="sourceLineNo">693</span><a name="line.693"></a>
  702. <span class="sourceLineNo">694</span> /**<a name="line.694"></a>
  703. <span class="sourceLineNo">695</span> * Sets the description for this legend item.<a name="line.695"></a>
  704. <span class="sourceLineNo">696</span> *<a name="line.696"></a>
  705. <span class="sourceLineNo">697</span> * @param text the description (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.697"></a>
  706. <span class="sourceLineNo">698</span> *<a name="line.698"></a>
  707. <span class="sourceLineNo">699</span> * @see #getDescription()<a name="line.699"></a>
  708. <span class="sourceLineNo">700</span> * @since 1.0.14<a name="line.700"></a>
  709. <span class="sourceLineNo">701</span> */<a name="line.701"></a>
  710. <span class="sourceLineNo">702</span> public void setDescription(String text) {<a name="line.702"></a>
  711. <span class="sourceLineNo">703</span> this.description = text;<a name="line.703"></a>
  712. <span class="sourceLineNo">704</span> }<a name="line.704"></a>
  713. <span class="sourceLineNo">705</span><a name="line.705"></a>
  714. <span class="sourceLineNo">706</span> /**<a name="line.706"></a>
  715. <span class="sourceLineNo">707</span> * Returns the tool tip text.<a name="line.707"></a>
  716. <span class="sourceLineNo">708</span> *<a name="line.708"></a>
  717. <span class="sourceLineNo">709</span> * @return The tool tip text (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.709"></a>
  718. <span class="sourceLineNo">710</span> *<a name="line.710"></a>
  719. <span class="sourceLineNo">711</span> * @see #setToolTipText(java.lang.String) <a name="line.711"></a>
  720. <span class="sourceLineNo">712</span> */<a name="line.712"></a>
  721. <span class="sourceLineNo">713</span> public String getToolTipText() {<a name="line.713"></a>
  722. <span class="sourceLineNo">714</span> return this.toolTipText;<a name="line.714"></a>
  723. <span class="sourceLineNo">715</span> }<a name="line.715"></a>
  724. <span class="sourceLineNo">716</span><a name="line.716"></a>
  725. <span class="sourceLineNo">717</span> /**<a name="line.717"></a>
  726. <span class="sourceLineNo">718</span> * Sets the tool tip text for this legend item.<a name="line.718"></a>
  727. <span class="sourceLineNo">719</span> *<a name="line.719"></a>
  728. <span class="sourceLineNo">720</span> * @param text the text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.720"></a>
  729. <span class="sourceLineNo">721</span> *<a name="line.721"></a>
  730. <span class="sourceLineNo">722</span> * @see #getToolTipText()<a name="line.722"></a>
  731. <span class="sourceLineNo">723</span> * @since 1.0.14<a name="line.723"></a>
  732. <span class="sourceLineNo">724</span> */<a name="line.724"></a>
  733. <span class="sourceLineNo">725</span> public void setToolTipText(String text) {<a name="line.725"></a>
  734. <span class="sourceLineNo">726</span> this.toolTipText = text;<a name="line.726"></a>
  735. <span class="sourceLineNo">727</span> }<a name="line.727"></a>
  736. <span class="sourceLineNo">728</span><a name="line.728"></a>
  737. <span class="sourceLineNo">729</span> /**<a name="line.729"></a>
  738. <span class="sourceLineNo">730</span> * Returns the URL text.<a name="line.730"></a>
  739. <span class="sourceLineNo">731</span> *<a name="line.731"></a>
  740. <span class="sourceLineNo">732</span> * @return The URL text (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.732"></a>
  741. <span class="sourceLineNo">733</span> *<a name="line.733"></a>
  742. <span class="sourceLineNo">734</span> * @see #setURLText(java.lang.String) <a name="line.734"></a>
  743. <span class="sourceLineNo">735</span> */<a name="line.735"></a>
  744. <span class="sourceLineNo">736</span> public String getURLText() {<a name="line.736"></a>
  745. <span class="sourceLineNo">737</span> return this.urlText;<a name="line.737"></a>
  746. <span class="sourceLineNo">738</span> }<a name="line.738"></a>
  747. <span class="sourceLineNo">739</span><a name="line.739"></a>
  748. <span class="sourceLineNo">740</span> /**<a name="line.740"></a>
  749. <span class="sourceLineNo">741</span> * Sets the URL text.<a name="line.741"></a>
  750. <span class="sourceLineNo">742</span> *<a name="line.742"></a>
  751. <span class="sourceLineNo">743</span> * @param text the text (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.743"></a>
  752. <span class="sourceLineNo">744</span> *<a name="line.744"></a>
  753. <span class="sourceLineNo">745</span> * @see #getURLText()<a name="line.745"></a>
  754. <span class="sourceLineNo">746</span> *<a name="line.746"></a>
  755. <span class="sourceLineNo">747</span> * @since 1.0.14<a name="line.747"></a>
  756. <span class="sourceLineNo">748</span> */<a name="line.748"></a>
  757. <span class="sourceLineNo">749</span> public void setURLText(String text) {<a name="line.749"></a>
  758. <span class="sourceLineNo">750</span> this.urlText = text;<a name="line.750"></a>
  759. <span class="sourceLineNo">751</span> }<a name="line.751"></a>
  760. <span class="sourceLineNo">752</span><a name="line.752"></a>
  761. <span class="sourceLineNo">753</span> /**<a name="line.753"></a>
  762. <span class="sourceLineNo">754</span> * Returns a flag that indicates whether or not the shape is visible.<a name="line.754"></a>
  763. <span class="sourceLineNo">755</span> *<a name="line.755"></a>
  764. <span class="sourceLineNo">756</span> * @return A boolean.<a name="line.756"></a>
  765. <span class="sourceLineNo">757</span> *<a name="line.757"></a>
  766. <span class="sourceLineNo">758</span> * @see #setShapeVisible(boolean)<a name="line.758"></a>
  767. <span class="sourceLineNo">759</span> */<a name="line.759"></a>
  768. <span class="sourceLineNo">760</span> public boolean isShapeVisible() {<a name="line.760"></a>
  769. <span class="sourceLineNo">761</span> return this.shapeVisible;<a name="line.761"></a>
  770. <span class="sourceLineNo">762</span> }<a name="line.762"></a>
  771. <span class="sourceLineNo">763</span><a name="line.763"></a>
  772. <span class="sourceLineNo">764</span> /**<a name="line.764"></a>
  773. <span class="sourceLineNo">765</span> * Sets the flag that controls whether or not the shape is visible.<a name="line.765"></a>
  774. <span class="sourceLineNo">766</span> *<a name="line.766"></a>
  775. <span class="sourceLineNo">767</span> * @param visible the new flag value.<a name="line.767"></a>
  776. <span class="sourceLineNo">768</span> *<a name="line.768"></a>
  777. <span class="sourceLineNo">769</span> * @see #isShapeVisible()<a name="line.769"></a>
  778. <span class="sourceLineNo">770</span> * @see #isLineVisible()<a name="line.770"></a>
  779. <span class="sourceLineNo">771</span> *<a name="line.771"></a>
  780. <span class="sourceLineNo">772</span> * @since 1.0.14<a name="line.772"></a>
  781. <span class="sourceLineNo">773</span> */<a name="line.773"></a>
  782. <span class="sourceLineNo">774</span> public void setShapeVisible(boolean visible) {<a name="line.774"></a>
  783. <span class="sourceLineNo">775</span> this.shapeVisible = visible;<a name="line.775"></a>
  784. <span class="sourceLineNo">776</span> }<a name="line.776"></a>
  785. <span class="sourceLineNo">777</span><a name="line.777"></a>
  786. <span class="sourceLineNo">778</span> /**<a name="line.778"></a>
  787. <span class="sourceLineNo">779</span> * Returns the shape used to label the series represented by this legend<a name="line.779"></a>
  788. <span class="sourceLineNo">780</span> * item.<a name="line.780"></a>
  789. <span class="sourceLineNo">781</span> *<a name="line.781"></a>
  790. <span class="sourceLineNo">782</span> * @return The shape (never &lt;code&gt;null&lt;/code&gt;).<a name="line.782"></a>
  791. <span class="sourceLineNo">783</span> *<a name="line.783"></a>
  792. <span class="sourceLineNo">784</span> * @see #setShape(java.awt.Shape) <a name="line.784"></a>
  793. <span class="sourceLineNo">785</span> */<a name="line.785"></a>
  794. <span class="sourceLineNo">786</span> public Shape getShape() {<a name="line.786"></a>
  795. <span class="sourceLineNo">787</span> return this.shape;<a name="line.787"></a>
  796. <span class="sourceLineNo">788</span> }<a name="line.788"></a>
  797. <span class="sourceLineNo">789</span><a name="line.789"></a>
  798. <span class="sourceLineNo">790</span> /**<a name="line.790"></a>
  799. <span class="sourceLineNo">791</span> * Sets the shape for the legend item.<a name="line.791"></a>
  800. <span class="sourceLineNo">792</span> *<a name="line.792"></a>
  801. <span class="sourceLineNo">793</span> * @param shape the shape (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.793"></a>
  802. <span class="sourceLineNo">794</span> *<a name="line.794"></a>
  803. <span class="sourceLineNo">795</span> * @see #getShape()<a name="line.795"></a>
  804. <span class="sourceLineNo">796</span> * @since 1.0.14<a name="line.796"></a>
  805. <span class="sourceLineNo">797</span> */<a name="line.797"></a>
  806. <span class="sourceLineNo">798</span> public void setShape(Shape shape) {<a name="line.798"></a>
  807. <span class="sourceLineNo">799</span> ParamChecks.nullNotPermitted(shape, "shape");<a name="line.799"></a>
  808. <span class="sourceLineNo">800</span> this.shape = shape;<a name="line.800"></a>
  809. <span class="sourceLineNo">801</span> }<a name="line.801"></a>
  810. <span class="sourceLineNo">802</span><a name="line.802"></a>
  811. <span class="sourceLineNo">803</span> /**<a name="line.803"></a>
  812. <span class="sourceLineNo">804</span> * Returns a flag that controls whether or not the shape is filled.<a name="line.804"></a>
  813. <span class="sourceLineNo">805</span> *<a name="line.805"></a>
  814. <span class="sourceLineNo">806</span> * @return A boolean.<a name="line.806"></a>
  815. <span class="sourceLineNo">807</span> */<a name="line.807"></a>
  816. <span class="sourceLineNo">808</span> public boolean isShapeFilled() {<a name="line.808"></a>
  817. <span class="sourceLineNo">809</span> return this.shapeFilled;<a name="line.809"></a>
  818. <span class="sourceLineNo">810</span> }<a name="line.810"></a>
  819. <span class="sourceLineNo">811</span><a name="line.811"></a>
  820. <span class="sourceLineNo">812</span> /**<a name="line.812"></a>
  821. <span class="sourceLineNo">813</span> * Returns the fill paint.<a name="line.813"></a>
  822. <span class="sourceLineNo">814</span> *<a name="line.814"></a>
  823. <span class="sourceLineNo">815</span> * @return The fill paint (never &lt;code&gt;null&lt;/code&gt;).<a name="line.815"></a>
  824. <span class="sourceLineNo">816</span> */<a name="line.816"></a>
  825. <span class="sourceLineNo">817</span> public Paint getFillPaint() {<a name="line.817"></a>
  826. <span class="sourceLineNo">818</span> return this.fillPaint;<a name="line.818"></a>
  827. <span class="sourceLineNo">819</span> }<a name="line.819"></a>
  828. <span class="sourceLineNo">820</span><a name="line.820"></a>
  829. <span class="sourceLineNo">821</span> /**<a name="line.821"></a>
  830. <span class="sourceLineNo">822</span> * Sets the fill paint.<a name="line.822"></a>
  831. <span class="sourceLineNo">823</span> *<a name="line.823"></a>
  832. <span class="sourceLineNo">824</span> * @param paint the paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.824"></a>
  833. <span class="sourceLineNo">825</span> *<a name="line.825"></a>
  834. <span class="sourceLineNo">826</span> * @since 1.0.11<a name="line.826"></a>
  835. <span class="sourceLineNo">827</span> */<a name="line.827"></a>
  836. <span class="sourceLineNo">828</span> public void setFillPaint(Paint paint) {<a name="line.828"></a>
  837. <span class="sourceLineNo">829</span> ParamChecks.nullNotPermitted(paint, "paint");<a name="line.829"></a>
  838. <span class="sourceLineNo">830</span> this.fillPaint = paint;<a name="line.830"></a>
  839. <span class="sourceLineNo">831</span> }<a name="line.831"></a>
  840. <span class="sourceLineNo">832</span><a name="line.832"></a>
  841. <span class="sourceLineNo">833</span> /**<a name="line.833"></a>
  842. <span class="sourceLineNo">834</span> * Returns the flag that controls whether or not the shape outline<a name="line.834"></a>
  843. <span class="sourceLineNo">835</span> * is visible.<a name="line.835"></a>
  844. <span class="sourceLineNo">836</span> *<a name="line.836"></a>
  845. <span class="sourceLineNo">837</span> * @return A boolean.<a name="line.837"></a>
  846. <span class="sourceLineNo">838</span> */<a name="line.838"></a>
  847. <span class="sourceLineNo">839</span> public boolean isShapeOutlineVisible() {<a name="line.839"></a>
  848. <span class="sourceLineNo">840</span> return this.shapeOutlineVisible;<a name="line.840"></a>
  849. <span class="sourceLineNo">841</span> }<a name="line.841"></a>
  850. <span class="sourceLineNo">842</span><a name="line.842"></a>
  851. <span class="sourceLineNo">843</span> /**<a name="line.843"></a>
  852. <span class="sourceLineNo">844</span> * Returns the line stroke for the series.<a name="line.844"></a>
  853. <span class="sourceLineNo">845</span> *<a name="line.845"></a>
  854. <span class="sourceLineNo">846</span> * @return The stroke (never &lt;code&gt;null&lt;/code&gt;).<a name="line.846"></a>
  855. <span class="sourceLineNo">847</span> */<a name="line.847"></a>
  856. <span class="sourceLineNo">848</span> public Stroke getLineStroke() {<a name="line.848"></a>
  857. <span class="sourceLineNo">849</span> return this.lineStroke;<a name="line.849"></a>
  858. <span class="sourceLineNo">850</span> }<a name="line.850"></a>
  859. <span class="sourceLineNo">851</span> <a name="line.851"></a>
  860. <span class="sourceLineNo">852</span> /**<a name="line.852"></a>
  861. <span class="sourceLineNo">853</span> * Sets the line stroke.<a name="line.853"></a>
  862. <span class="sourceLineNo">854</span> * <a name="line.854"></a>
  863. <span class="sourceLineNo">855</span> * @param stroke the stroke (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.855"></a>
  864. <span class="sourceLineNo">856</span> * <a name="line.856"></a>
  865. <span class="sourceLineNo">857</span> * @since 1.0.18<a name="line.857"></a>
  866. <span class="sourceLineNo">858</span> */<a name="line.858"></a>
  867. <span class="sourceLineNo">859</span> public void setLineStroke(Stroke stroke) {<a name="line.859"></a>
  868. <span class="sourceLineNo">860</span> ParamChecks.nullNotPermitted(stroke, "stroke");<a name="line.860"></a>
  869. <span class="sourceLineNo">861</span> this.lineStroke = stroke;<a name="line.861"></a>
  870. <span class="sourceLineNo">862</span> }<a name="line.862"></a>
  871. <span class="sourceLineNo">863</span><a name="line.863"></a>
  872. <span class="sourceLineNo">864</span> /**<a name="line.864"></a>
  873. <span class="sourceLineNo">865</span> * Returns the paint used for lines.<a name="line.865"></a>
  874. <span class="sourceLineNo">866</span> *<a name="line.866"></a>
  875. <span class="sourceLineNo">867</span> * @return The paint (never &lt;code&gt;null&lt;/code&gt;).<a name="line.867"></a>
  876. <span class="sourceLineNo">868</span> */<a name="line.868"></a>
  877. <span class="sourceLineNo">869</span> public Paint getLinePaint() {<a name="line.869"></a>
  878. <span class="sourceLineNo">870</span> return this.linePaint;<a name="line.870"></a>
  879. <span class="sourceLineNo">871</span> }<a name="line.871"></a>
  880. <span class="sourceLineNo">872</span><a name="line.872"></a>
  881. <span class="sourceLineNo">873</span> /**<a name="line.873"></a>
  882. <span class="sourceLineNo">874</span> * Sets the line paint.<a name="line.874"></a>
  883. <span class="sourceLineNo">875</span> *<a name="line.875"></a>
  884. <span class="sourceLineNo">876</span> * @param paint the paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.876"></a>
  885. <span class="sourceLineNo">877</span> *<a name="line.877"></a>
  886. <span class="sourceLineNo">878</span> * @since 1.0.11<a name="line.878"></a>
  887. <span class="sourceLineNo">879</span> */<a name="line.879"></a>
  888. <span class="sourceLineNo">880</span> public void setLinePaint(Paint paint) {<a name="line.880"></a>
  889. <span class="sourceLineNo">881</span> ParamChecks.nullNotPermitted(paint, "paint");<a name="line.881"></a>
  890. <span class="sourceLineNo">882</span> this.linePaint = paint;<a name="line.882"></a>
  891. <span class="sourceLineNo">883</span> }<a name="line.883"></a>
  892. <span class="sourceLineNo">884</span><a name="line.884"></a>
  893. <span class="sourceLineNo">885</span> /**<a name="line.885"></a>
  894. <span class="sourceLineNo">886</span> * Returns the outline paint.<a name="line.886"></a>
  895. <span class="sourceLineNo">887</span> *<a name="line.887"></a>
  896. <span class="sourceLineNo">888</span> * @return The outline paint (never &lt;code&gt;null&lt;/code&gt;).<a name="line.888"></a>
  897. <span class="sourceLineNo">889</span> */<a name="line.889"></a>
  898. <span class="sourceLineNo">890</span> public Paint getOutlinePaint() {<a name="line.890"></a>
  899. <span class="sourceLineNo">891</span> return this.outlinePaint;<a name="line.891"></a>
  900. <span class="sourceLineNo">892</span> }<a name="line.892"></a>
  901. <span class="sourceLineNo">893</span><a name="line.893"></a>
  902. <span class="sourceLineNo">894</span> /**<a name="line.894"></a>
  903. <span class="sourceLineNo">895</span> * Sets the outline paint.<a name="line.895"></a>
  904. <span class="sourceLineNo">896</span> *<a name="line.896"></a>
  905. <span class="sourceLineNo">897</span> * @param paint the paint (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.897"></a>
  906. <span class="sourceLineNo">898</span> *<a name="line.898"></a>
  907. <span class="sourceLineNo">899</span> * @since 1.0.11<a name="line.899"></a>
  908. <span class="sourceLineNo">900</span> */<a name="line.900"></a>
  909. <span class="sourceLineNo">901</span> public void setOutlinePaint(Paint paint) {<a name="line.901"></a>
  910. <span class="sourceLineNo">902</span> ParamChecks.nullNotPermitted(paint, "paint");<a name="line.902"></a>
  911. <span class="sourceLineNo">903</span> this.outlinePaint = paint;<a name="line.903"></a>
  912. <span class="sourceLineNo">904</span> }<a name="line.904"></a>
  913. <span class="sourceLineNo">905</span><a name="line.905"></a>
  914. <span class="sourceLineNo">906</span> /**<a name="line.906"></a>
  915. <span class="sourceLineNo">907</span> * Returns the outline stroke.<a name="line.907"></a>
  916. <span class="sourceLineNo">908</span> *<a name="line.908"></a>
  917. <span class="sourceLineNo">909</span> * @return The outline stroke (never &lt;code&gt;null&lt;/code&gt;).<a name="line.909"></a>
  918. <span class="sourceLineNo">910</span> *<a name="line.910"></a>
  919. <span class="sourceLineNo">911</span> * @see #setOutlineStroke(java.awt.Stroke) <a name="line.911"></a>
  920. <span class="sourceLineNo">912</span> */<a name="line.912"></a>
  921. <span class="sourceLineNo">913</span> public Stroke getOutlineStroke() {<a name="line.913"></a>
  922. <span class="sourceLineNo">914</span> return this.outlineStroke;<a name="line.914"></a>
  923. <span class="sourceLineNo">915</span> }<a name="line.915"></a>
  924. <span class="sourceLineNo">916</span><a name="line.916"></a>
  925. <span class="sourceLineNo">917</span> /**<a name="line.917"></a>
  926. <span class="sourceLineNo">918</span> * Sets the outline stroke.<a name="line.918"></a>
  927. <span class="sourceLineNo">919</span> *<a name="line.919"></a>
  928. <span class="sourceLineNo">920</span> * @param stroke the stroke (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.920"></a>
  929. <span class="sourceLineNo">921</span> *<a name="line.921"></a>
  930. <span class="sourceLineNo">922</span> * @see #getOutlineStroke()<a name="line.922"></a>
  931. <span class="sourceLineNo">923</span> *<a name="line.923"></a>
  932. <span class="sourceLineNo">924</span> * @since 1.0.14<a name="line.924"></a>
  933. <span class="sourceLineNo">925</span> */<a name="line.925"></a>
  934. <span class="sourceLineNo">926</span> public void setOutlineStroke(Stroke stroke) {<a name="line.926"></a>
  935. <span class="sourceLineNo">927</span> ParamChecks.nullNotPermitted(stroke, "stroke");<a name="line.927"></a>
  936. <span class="sourceLineNo">928</span> this.outlineStroke = stroke;<a name="line.928"></a>
  937. <span class="sourceLineNo">929</span> }<a name="line.929"></a>
  938. <span class="sourceLineNo">930</span><a name="line.930"></a>
  939. <span class="sourceLineNo">931</span> /**<a name="line.931"></a>
  940. <span class="sourceLineNo">932</span> * Returns a flag that indicates whether or not the line is visible.<a name="line.932"></a>
  941. <span class="sourceLineNo">933</span> *<a name="line.933"></a>
  942. <span class="sourceLineNo">934</span> * @return A boolean.<a name="line.934"></a>
  943. <span class="sourceLineNo">935</span> *<a name="line.935"></a>
  944. <span class="sourceLineNo">936</span> * @see #setLineVisible(boolean) <a name="line.936"></a>
  945. <span class="sourceLineNo">937</span> */<a name="line.937"></a>
  946. <span class="sourceLineNo">938</span> public boolean isLineVisible() {<a name="line.938"></a>
  947. <span class="sourceLineNo">939</span> return this.lineVisible;<a name="line.939"></a>
  948. <span class="sourceLineNo">940</span> }<a name="line.940"></a>
  949. <span class="sourceLineNo">941</span><a name="line.941"></a>
  950. <span class="sourceLineNo">942</span> /**<a name="line.942"></a>
  951. <span class="sourceLineNo">943</span> * Sets the flag that controls whether or not the line shape is visible for<a name="line.943"></a>
  952. <span class="sourceLineNo">944</span> * this legend item.<a name="line.944"></a>
  953. <span class="sourceLineNo">945</span> *<a name="line.945"></a>
  954. <span class="sourceLineNo">946</span> * @param visible the new flag value.<a name="line.946"></a>
  955. <span class="sourceLineNo">947</span> *<a name="line.947"></a>
  956. <span class="sourceLineNo">948</span> * @see #isLineVisible()<a name="line.948"></a>
  957. <span class="sourceLineNo">949</span> * @since 1.0.14<a name="line.949"></a>
  958. <span class="sourceLineNo">950</span> */<a name="line.950"></a>
  959. <span class="sourceLineNo">951</span> public void setLineVisible(boolean visible) {<a name="line.951"></a>
  960. <span class="sourceLineNo">952</span> this.lineVisible = visible;<a name="line.952"></a>
  961. <span class="sourceLineNo">953</span> }<a name="line.953"></a>
  962. <span class="sourceLineNo">954</span><a name="line.954"></a>
  963. <span class="sourceLineNo">955</span> /**<a name="line.955"></a>
  964. <span class="sourceLineNo">956</span> * Returns the line.<a name="line.956"></a>
  965. <span class="sourceLineNo">957</span> *<a name="line.957"></a>
  966. <span class="sourceLineNo">958</span> * @return The line (never &lt;code&gt;null&lt;/code&gt;).<a name="line.958"></a>
  967. <span class="sourceLineNo">959</span> *<a name="line.959"></a>
  968. <span class="sourceLineNo">960</span> * @see #setLine(java.awt.Shape)<a name="line.960"></a>
  969. <span class="sourceLineNo">961</span> * @see #isLineVisible() <a name="line.961"></a>
  970. <span class="sourceLineNo">962</span> */<a name="line.962"></a>
  971. <span class="sourceLineNo">963</span> public Shape getLine() {<a name="line.963"></a>
  972. <span class="sourceLineNo">964</span> return this.line;<a name="line.964"></a>
  973. <span class="sourceLineNo">965</span> }<a name="line.965"></a>
  974. <span class="sourceLineNo">966</span><a name="line.966"></a>
  975. <span class="sourceLineNo">967</span> /**<a name="line.967"></a>
  976. <span class="sourceLineNo">968</span> * Sets the line.<a name="line.968"></a>
  977. <span class="sourceLineNo">969</span> *<a name="line.969"></a>
  978. <span class="sourceLineNo">970</span> * @param line the line (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.970"></a>
  979. <span class="sourceLineNo">971</span> *<a name="line.971"></a>
  980. <span class="sourceLineNo">972</span> * @see #getLine()<a name="line.972"></a>
  981. <span class="sourceLineNo">973</span> * @since 1.0.14<a name="line.973"></a>
  982. <span class="sourceLineNo">974</span> */<a name="line.974"></a>
  983. <span class="sourceLineNo">975</span> public void setLine(Shape line) {<a name="line.975"></a>
  984. <span class="sourceLineNo">976</span> ParamChecks.nullNotPermitted(line, "line");<a name="line.976"></a>
  985. <span class="sourceLineNo">977</span> this.line = line;<a name="line.977"></a>
  986. <span class="sourceLineNo">978</span> }<a name="line.978"></a>
  987. <span class="sourceLineNo">979</span><a name="line.979"></a>
  988. <span class="sourceLineNo">980</span> /**<a name="line.980"></a>
  989. <span class="sourceLineNo">981</span> * Returns the transformer used when the fill paint is an instance of<a name="line.981"></a>
  990. <span class="sourceLineNo">982</span> * &lt;code&gt;GradientPaint&lt;/code&gt;.<a name="line.982"></a>
  991. <span class="sourceLineNo">983</span> *<a name="line.983"></a>
  992. <span class="sourceLineNo">984</span> * @return The transformer (never &lt;code&gt;null&lt;/code&gt;).<a name="line.984"></a>
  993. <span class="sourceLineNo">985</span> *<a name="line.985"></a>
  994. <span class="sourceLineNo">986</span> * @since 1.0.4<a name="line.986"></a>
  995. <span class="sourceLineNo">987</span> *<a name="line.987"></a>
  996. <span class="sourceLineNo">988</span> * @see #setFillPaintTransformer(GradientPaintTransformer)<a name="line.988"></a>
  997. <span class="sourceLineNo">989</span> */<a name="line.989"></a>
  998. <span class="sourceLineNo">990</span> public GradientPaintTransformer getFillPaintTransformer() {<a name="line.990"></a>
  999. <span class="sourceLineNo">991</span> return this.fillPaintTransformer;<a name="line.991"></a>
  1000. <span class="sourceLineNo">992</span> }<a name="line.992"></a>
  1001. <span class="sourceLineNo">993</span><a name="line.993"></a>
  1002. <span class="sourceLineNo">994</span> /**<a name="line.994"></a>
  1003. <span class="sourceLineNo">995</span> * Sets the transformer used when the fill paint is an instance of<a name="line.995"></a>
  1004. <span class="sourceLineNo">996</span> * &lt;code&gt;GradientPaint&lt;/code&gt;.<a name="line.996"></a>
  1005. <span class="sourceLineNo">997</span> *<a name="line.997"></a>
  1006. <span class="sourceLineNo">998</span> * @param transformer the transformer (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.998"></a>
  1007. <span class="sourceLineNo">999</span> *<a name="line.999"></a>
  1008. <span class="sourceLineNo">1000</span> * @since 1.0.4<a name="line.1000"></a>
  1009. <span class="sourceLineNo">1001</span> *<a name="line.1001"></a>
  1010. <span class="sourceLineNo">1002</span> * @see #getFillPaintTransformer()<a name="line.1002"></a>
  1011. <span class="sourceLineNo">1003</span> */<a name="line.1003"></a>
  1012. <span class="sourceLineNo">1004</span> public void setFillPaintTransformer(GradientPaintTransformer transformer) {<a name="line.1004"></a>
  1013. <span class="sourceLineNo">1005</span> ParamChecks.nullNotPermitted(transformer, "transformer");<a name="line.1005"></a>
  1014. <span class="sourceLineNo">1006</span> this.fillPaintTransformer = transformer;<a name="line.1006"></a>
  1015. <span class="sourceLineNo">1007</span> }<a name="line.1007"></a>
  1016. <span class="sourceLineNo">1008</span><a name="line.1008"></a>
  1017. <span class="sourceLineNo">1009</span> /**<a name="line.1009"></a>
  1018. <span class="sourceLineNo">1010</span> * Tests this item for equality with an arbitrary object.<a name="line.1010"></a>
  1019. <span class="sourceLineNo">1011</span> *<a name="line.1011"></a>
  1020. <span class="sourceLineNo">1012</span> * @param obj the object (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.1012"></a>
  1021. <span class="sourceLineNo">1013</span> *<a name="line.1013"></a>
  1022. <span class="sourceLineNo">1014</span> * @return A boolean.<a name="line.1014"></a>
  1023. <span class="sourceLineNo">1015</span> */<a name="line.1015"></a>
  1024. <span class="sourceLineNo">1016</span> @Override<a name="line.1016"></a>
  1025. <span class="sourceLineNo">1017</span> public boolean equals(Object obj) {<a name="line.1017"></a>
  1026. <span class="sourceLineNo">1018</span> if (obj == this) {<a name="line.1018"></a>
  1027. <span class="sourceLineNo">1019</span> return true;<a name="line.1019"></a>
  1028. <span class="sourceLineNo">1020</span> }<a name="line.1020"></a>
  1029. <span class="sourceLineNo">1021</span> if (!(obj instanceof LegendItem)) {<a name="line.1021"></a>
  1030. <span class="sourceLineNo">1022</span> return false;<a name="line.1022"></a>
  1031. <span class="sourceLineNo">1023</span> }<a name="line.1023"></a>
  1032. <span class="sourceLineNo">1024</span> LegendItem that = (LegendItem) obj;<a name="line.1024"></a>
  1033. <span class="sourceLineNo">1025</span> if (this.datasetIndex != that.datasetIndex) {<a name="line.1025"></a>
  1034. <span class="sourceLineNo">1026</span> return false;<a name="line.1026"></a>
  1035. <span class="sourceLineNo">1027</span> }<a name="line.1027"></a>
  1036. <span class="sourceLineNo">1028</span> if (this.series != that.series) {<a name="line.1028"></a>
  1037. <span class="sourceLineNo">1029</span> return false;<a name="line.1029"></a>
  1038. <span class="sourceLineNo">1030</span> }<a name="line.1030"></a>
  1039. <span class="sourceLineNo">1031</span> if (!this.label.equals(that.label)) {<a name="line.1031"></a>
  1040. <span class="sourceLineNo">1032</span> return false;<a name="line.1032"></a>
  1041. <span class="sourceLineNo">1033</span> }<a name="line.1033"></a>
  1042. <span class="sourceLineNo">1034</span> if (!AttributedStringUtilities.equal(this.attributedLabel,<a name="line.1034"></a>
  1043. <span class="sourceLineNo">1035</span> that.attributedLabel)) {<a name="line.1035"></a>
  1044. <span class="sourceLineNo">1036</span> return false;<a name="line.1036"></a>
  1045. <span class="sourceLineNo">1037</span> }<a name="line.1037"></a>
  1046. <span class="sourceLineNo">1038</span> if (!ObjectUtilities.equal(this.description, that.description)) {<a name="line.1038"></a>
  1047. <span class="sourceLineNo">1039</span> return false;<a name="line.1039"></a>
  1048. <span class="sourceLineNo">1040</span> }<a name="line.1040"></a>
  1049. <span class="sourceLineNo">1041</span> if (this.shapeVisible != that.shapeVisible) {<a name="line.1041"></a>
  1050. <span class="sourceLineNo">1042</span> return false;<a name="line.1042"></a>
  1051. <span class="sourceLineNo">1043</span> }<a name="line.1043"></a>
  1052. <span class="sourceLineNo">1044</span> if (!ShapeUtilities.equal(this.shape, that.shape)) {<a name="line.1044"></a>
  1053. <span class="sourceLineNo">1045</span> return false;<a name="line.1045"></a>
  1054. <span class="sourceLineNo">1046</span> }<a name="line.1046"></a>
  1055. <span class="sourceLineNo">1047</span> if (this.shapeFilled != that.shapeFilled) {<a name="line.1047"></a>
  1056. <span class="sourceLineNo">1048</span> return false;<a name="line.1048"></a>
  1057. <span class="sourceLineNo">1049</span> }<a name="line.1049"></a>
  1058. <span class="sourceLineNo">1050</span> if (!PaintUtilities.equal(this.fillPaint, that.fillPaint)) {<a name="line.1050"></a>
  1059. <span class="sourceLineNo">1051</span> return false;<a name="line.1051"></a>
  1060. <span class="sourceLineNo">1052</span> }<a name="line.1052"></a>
  1061. <span class="sourceLineNo">1053</span> if (!ObjectUtilities.equal(this.fillPaintTransformer,<a name="line.1053"></a>
  1062. <span class="sourceLineNo">1054</span> that.fillPaintTransformer)) {<a name="line.1054"></a>
  1063. <span class="sourceLineNo">1055</span> return false;<a name="line.1055"></a>
  1064. <span class="sourceLineNo">1056</span> }<a name="line.1056"></a>
  1065. <span class="sourceLineNo">1057</span> if (this.shapeOutlineVisible != that.shapeOutlineVisible) {<a name="line.1057"></a>
  1066. <span class="sourceLineNo">1058</span> return false;<a name="line.1058"></a>
  1067. <span class="sourceLineNo">1059</span> }<a name="line.1059"></a>
  1068. <span class="sourceLineNo">1060</span> if (!this.outlineStroke.equals(that.outlineStroke)) {<a name="line.1060"></a>
  1069. <span class="sourceLineNo">1061</span> return false;<a name="line.1061"></a>
  1070. <span class="sourceLineNo">1062</span> }<a name="line.1062"></a>
  1071. <span class="sourceLineNo">1063</span> if (!PaintUtilities.equal(this.outlinePaint, that.outlinePaint)) {<a name="line.1063"></a>
  1072. <span class="sourceLineNo">1064</span> return false;<a name="line.1064"></a>
  1073. <span class="sourceLineNo">1065</span> }<a name="line.1065"></a>
  1074. <span class="sourceLineNo">1066</span> if (!this.lineVisible == that.lineVisible) {<a name="line.1066"></a>
  1075. <span class="sourceLineNo">1067</span> return false;<a name="line.1067"></a>
  1076. <span class="sourceLineNo">1068</span> }<a name="line.1068"></a>
  1077. <span class="sourceLineNo">1069</span> if (!ShapeUtilities.equal(this.line, that.line)) {<a name="line.1069"></a>
  1078. <span class="sourceLineNo">1070</span> return false;<a name="line.1070"></a>
  1079. <span class="sourceLineNo">1071</span> }<a name="line.1071"></a>
  1080. <span class="sourceLineNo">1072</span> if (!this.lineStroke.equals(that.lineStroke)) {<a name="line.1072"></a>
  1081. <span class="sourceLineNo">1073</span> return false;<a name="line.1073"></a>
  1082. <span class="sourceLineNo">1074</span> }<a name="line.1074"></a>
  1083. <span class="sourceLineNo">1075</span> if (!PaintUtilities.equal(this.linePaint, that.linePaint)) {<a name="line.1075"></a>
  1084. <span class="sourceLineNo">1076</span> return false;<a name="line.1076"></a>
  1085. <span class="sourceLineNo">1077</span> }<a name="line.1077"></a>
  1086. <span class="sourceLineNo">1078</span> if (!ObjectUtilities.equal(this.labelFont, that.labelFont)) {<a name="line.1078"></a>
  1087. <span class="sourceLineNo">1079</span> return false;<a name="line.1079"></a>
  1088. <span class="sourceLineNo">1080</span> }<a name="line.1080"></a>
  1089. <span class="sourceLineNo">1081</span> if (!PaintUtilities.equal(this.labelPaint, that.labelPaint)) {<a name="line.1081"></a>
  1090. <span class="sourceLineNo">1082</span> return false;<a name="line.1082"></a>
  1091. <span class="sourceLineNo">1083</span> }<a name="line.1083"></a>
  1092. <span class="sourceLineNo">1084</span> return true;<a name="line.1084"></a>
  1093. <span class="sourceLineNo">1085</span> }<a name="line.1085"></a>
  1094. <span class="sourceLineNo">1086</span><a name="line.1086"></a>
  1095. <span class="sourceLineNo">1087</span> /**<a name="line.1087"></a>
  1096. <span class="sourceLineNo">1088</span> * Returns an independent copy of this object (except that the clone will<a name="line.1088"></a>
  1097. <span class="sourceLineNo">1089</span> * still reference the same dataset as the original<a name="line.1089"></a>
  1098. <span class="sourceLineNo">1090</span> * &lt;code&gt;LegendItem&lt;/code&gt;).<a name="line.1090"></a>
  1099. <span class="sourceLineNo">1091</span> *<a name="line.1091"></a>
  1100. <span class="sourceLineNo">1092</span> * @return A clone.<a name="line.1092"></a>
  1101. <span class="sourceLineNo">1093</span> *<a name="line.1093"></a>
  1102. <span class="sourceLineNo">1094</span> * @throws CloneNotSupportedException if the legend item cannot be cloned.<a name="line.1094"></a>
  1103. <span class="sourceLineNo">1095</span> *<a name="line.1095"></a>
  1104. <span class="sourceLineNo">1096</span> * @since 1.0.10<a name="line.1096"></a>
  1105. <span class="sourceLineNo">1097</span> */<a name="line.1097"></a>
  1106. <span class="sourceLineNo">1098</span> @Override<a name="line.1098"></a>
  1107. <span class="sourceLineNo">1099</span> public Object clone() throws CloneNotSupportedException {<a name="line.1099"></a>
  1108. <span class="sourceLineNo">1100</span> LegendItem clone = (LegendItem) super.clone();<a name="line.1100"></a>
  1109. <span class="sourceLineNo">1101</span> if (this.seriesKey instanceof PublicCloneable) {<a name="line.1101"></a>
  1110. <span class="sourceLineNo">1102</span> PublicCloneable pc = (PublicCloneable) this.seriesKey;<a name="line.1102"></a>
  1111. <span class="sourceLineNo">1103</span> clone.seriesKey = (Comparable) pc.clone();<a name="line.1103"></a>
  1112. <span class="sourceLineNo">1104</span> }<a name="line.1104"></a>
  1113. <span class="sourceLineNo">1105</span> // FIXME: Clone the attributed string if it is not null<a name="line.1105"></a>
  1114. <span class="sourceLineNo">1106</span> clone.shape = ShapeUtilities.clone(this.shape);<a name="line.1106"></a>
  1115. <span class="sourceLineNo">1107</span> if (this.fillPaintTransformer instanceof PublicCloneable) {<a name="line.1107"></a>
  1116. <span class="sourceLineNo">1108</span> PublicCloneable pc = (PublicCloneable) this.fillPaintTransformer;<a name="line.1108"></a>
  1117. <span class="sourceLineNo">1109</span> clone.fillPaintTransformer = (GradientPaintTransformer) pc.clone();<a name="line.1109"></a>
  1118. <span class="sourceLineNo">1110</span><a name="line.1110"></a>
  1119. <span class="sourceLineNo">1111</span> }<a name="line.1111"></a>
  1120. <span class="sourceLineNo">1112</span> clone.line = ShapeUtilities.clone(this.line);<a name="line.1112"></a>
  1121. <span class="sourceLineNo">1113</span> return clone;<a name="line.1113"></a>
  1122. <span class="sourceLineNo">1114</span> }<a name="line.1114"></a>
  1123. <span class="sourceLineNo">1115</span><a name="line.1115"></a>
  1124. <span class="sourceLineNo">1116</span> /**<a name="line.1116"></a>
  1125. <span class="sourceLineNo">1117</span> * Provides serialization support.<a name="line.1117"></a>
  1126. <span class="sourceLineNo">1118</span> *<a name="line.1118"></a>
  1127. <span class="sourceLineNo">1119</span> * @param stream the output stream (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.1119"></a>
  1128. <span class="sourceLineNo">1120</span> *<a name="line.1120"></a>
  1129. <span class="sourceLineNo">1121</span> * @throws IOException if there is an I/O error.<a name="line.1121"></a>
  1130. <span class="sourceLineNo">1122</span> */<a name="line.1122"></a>
  1131. <span class="sourceLineNo">1123</span> private void writeObject(ObjectOutputStream stream) throws IOException {<a name="line.1123"></a>
  1132. <span class="sourceLineNo">1124</span> stream.defaultWriteObject();<a name="line.1124"></a>
  1133. <span class="sourceLineNo">1125</span> SerialUtilities.writeAttributedString(this.attributedLabel, stream);<a name="line.1125"></a>
  1134. <span class="sourceLineNo">1126</span> SerialUtilities.writeShape(this.shape, stream);<a name="line.1126"></a>
  1135. <span class="sourceLineNo">1127</span> SerialUtilities.writePaint(this.fillPaint, stream);<a name="line.1127"></a>
  1136. <span class="sourceLineNo">1128</span> SerialUtilities.writeStroke(this.outlineStroke, stream);<a name="line.1128"></a>
  1137. <span class="sourceLineNo">1129</span> SerialUtilities.writePaint(this.outlinePaint, stream);<a name="line.1129"></a>
  1138. <span class="sourceLineNo">1130</span> SerialUtilities.writeShape(this.line, stream);<a name="line.1130"></a>
  1139. <span class="sourceLineNo">1131</span> SerialUtilities.writeStroke(this.lineStroke, stream);<a name="line.1131"></a>
  1140. <span class="sourceLineNo">1132</span> SerialUtilities.writePaint(this.linePaint, stream);<a name="line.1132"></a>
  1141. <span class="sourceLineNo">1133</span> SerialUtilities.writePaint(this.labelPaint, stream);<a name="line.1133"></a>
  1142. <span class="sourceLineNo">1134</span> }<a name="line.1134"></a>
  1143. <span class="sourceLineNo">1135</span><a name="line.1135"></a>
  1144. <span class="sourceLineNo">1136</span> /**<a name="line.1136"></a>
  1145. <span class="sourceLineNo">1137</span> * Provides serialization support.<a name="line.1137"></a>
  1146. <span class="sourceLineNo">1138</span> *<a name="line.1138"></a>
  1147. <span class="sourceLineNo">1139</span> * @param stream the input stream (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.1139"></a>
  1148. <span class="sourceLineNo">1140</span> *<a name="line.1140"></a>
  1149. <span class="sourceLineNo">1141</span> * @throws IOException if there is an I/O error.<a name="line.1141"></a>
  1150. <span class="sourceLineNo">1142</span> * @throws ClassNotFoundException if there is a classpath problem.<a name="line.1142"></a>
  1151. <span class="sourceLineNo">1143</span> */<a name="line.1143"></a>
  1152. <span class="sourceLineNo">1144</span> private void readObject(ObjectInputStream stream)<a name="line.1144"></a>
  1153. <span class="sourceLineNo">1145</span> throws IOException, ClassNotFoundException {<a name="line.1145"></a>
  1154. <span class="sourceLineNo">1146</span> stream.defaultReadObject();<a name="line.1146"></a>
  1155. <span class="sourceLineNo">1147</span> this.attributedLabel = SerialUtilities.readAttributedString(stream);<a name="line.1147"></a>
  1156. <span class="sourceLineNo">1148</span> this.shape = SerialUtilities.readShape(stream);<a name="line.1148"></a>
  1157. <span class="sourceLineNo">1149</span> this.fillPaint = SerialUtilities.readPaint(stream);<a name="line.1149"></a>
  1158. <span class="sourceLineNo">1150</span> this.outlineStroke = SerialUtilities.readStroke(stream);<a name="line.1150"></a>
  1159. <span class="sourceLineNo">1151</span> this.outlinePaint = SerialUtilities.readPaint(stream);<a name="line.1151"></a>
  1160. <span class="sourceLineNo">1152</span> this.line = SerialUtilities.readShape(stream);<a name="line.1152"></a>
  1161. <span class="sourceLineNo">1153</span> this.lineStroke = SerialUtilities.readStroke(stream);<a name="line.1153"></a>
  1162. <span class="sourceLineNo">1154</span> this.linePaint = SerialUtilities.readPaint(stream);<a name="line.1154"></a>
  1163. <span class="sourceLineNo">1155</span> this.labelPaint = SerialUtilities.readPaint(stream);<a name="line.1155"></a>
  1164. <span class="sourceLineNo">1156</span> }<a name="line.1156"></a>
  1165. <span class="sourceLineNo">1157</span><a name="line.1157"></a>
  1166. <span class="sourceLineNo">1158</span>}<a name="line.1158"></a>
  1167. </pre>
  1168. </div>
  1169. </body>
  1170. </html>