StrokeMap.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:26 CEST 2014 -->
  6. <title>StrokeMap (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="StrokeMap (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/StrokeMap.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../org/jfree/chart/StandardChartTheme.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li>Next&nbsp;Class</li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/chart/StrokeMap.html" target="_top">Frames</a></li>
  57. <li><a href="StrokeMap.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart</div>
  96. <h2 title="Class StrokeMap" class="title">Class StrokeMap</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.StrokeMap</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, java.lang.Cloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.68">StrokeMap</a>
  117. extends java.lang.Object
  118. implements java.lang.Cloneable, java.io.Serializable</pre>
  119. <div class="block">A storage structure that maps <code>Comparable</code> instances with
  120. <code>Stroke</code> instances.
  121. <br><br>
  122. To support cloning and serialization, you should only use keys that are
  123. cloneable and serializable. Special handling for the <code>Stroke</code>
  124. instances is included in this class.</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">Since:</span></dt>
  127. <dd>1.0.3</dd>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../serialized-form.html#org.jfree.chart.StrokeMap">Serialized Form</a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#StrokeMap--">StrokeMap</a></span>()</code>
  150. <div class="block">Creates a new (empty) map.</div>
  151. </td>
  152. </tr>
  153. </table>
  154. </li>
  155. </ul>
  156. <!-- ========== METHOD SUMMARY =========== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="method.summary">
  159. <!-- -->
  160. </a>
  161. <h3>Method Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  163. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  164. <tr>
  165. <th class="colFirst" scope="col">Modifier and Type</th>
  166. <th class="colLast" scope="col">Method and Description</th>
  167. </tr>
  168. <tr id="i0" class="altColor">
  169. <td class="colFirst"><code>void</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#clear--">clear</a></span>()</code>
  171. <div class="block">Resets the map to empty.</div>
  172. </td>
  173. </tr>
  174. <tr id="i1" class="rowColor">
  175. <td class="colFirst"><code>java.lang.Object</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#clone--">clone</a></span>()</code>
  177. <div class="block">Returns a clone of this <code>StrokeMap</code>.</div>
  178. </td>
  179. </tr>
  180. <tr id="i2" class="altColor">
  181. <td class="colFirst"><code>boolean</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#containsKey-java.lang.Comparable-">containsKey</a></span>(java.lang.Comparable&nbsp;key)</code>
  183. <div class="block">Returns <code>true</code> if the map contains the specified key, and
  184. <code>false</code> otherwise.</div>
  185. </td>
  186. </tr>
  187. <tr id="i3" class="rowColor">
  188. <td class="colFirst"><code>boolean</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  190. <div class="block">Tests this map for equality with an arbitrary object.</div>
  191. </td>
  192. </tr>
  193. <tr id="i4" class="altColor">
  194. <td class="colFirst"><code>java.awt.Stroke</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#getStroke-java.lang.Comparable-">getStroke</a></span>(java.lang.Comparable&nbsp;key)</code>
  196. <div class="block">Returns the stroke associated with the specified key, or
  197. <code>null</code>.</div>
  198. </td>
  199. </tr>
  200. <tr id="i5" class="rowColor">
  201. <td class="colFirst"><code>void</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/chart/StrokeMap.html#put-java.lang.Comparable-java.awt.Stroke-">put</a></span>(java.lang.Comparable&nbsp;key,
  203. java.awt.Stroke&nbsp;stroke)</code>
  204. <div class="block">Adds a mapping between the specified <code>key</code> and
  205. <code>stroke</code> values.</div>
  206. </td>
  207. </tr>
  208. </table>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  211. <!-- -->
  212. </a>
  213. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  214. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. <div class="details">
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="constructor.detail">
  227. <!-- -->
  228. </a>
  229. <h3>Constructor Detail</h3>
  230. <a name="StrokeMap--">
  231. <!-- -->
  232. </a>
  233. <ul class="blockListLast">
  234. <li class="blockList">
  235. <h4>StrokeMap</h4>
  236. <pre>public&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.79">StrokeMap</a>()</pre>
  237. <div class="block">Creates a new (empty) map.</div>
  238. </li>
  239. </ul>
  240. </li>
  241. </ul>
  242. <!-- ============ METHOD DETAIL ========== -->
  243. <ul class="blockList">
  244. <li class="blockList"><a name="method.detail">
  245. <!-- -->
  246. </a>
  247. <h3>Method Detail</h3>
  248. <a name="getStroke-java.lang.Comparable-">
  249. <!-- -->
  250. </a>
  251. <ul class="blockList">
  252. <li class="blockList">
  253. <h4>getStroke</h4>
  254. <pre>public&nbsp;java.awt.Stroke&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.94">getStroke</a>(java.lang.Comparable&nbsp;key)</pre>
  255. <div class="block">Returns the stroke associated with the specified key, or
  256. <code>null</code>.</div>
  257. <dl>
  258. <dt><span class="paramLabel">Parameters:</span></dt>
  259. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  260. <dt><span class="returnLabel">Returns:</span></dt>
  261. <dd>The stroke, or <code>null</code>.</dd>
  262. <dt><span class="throwsLabel">Throws:</span></dt>
  263. <dd><code>java.lang.IllegalArgumentException</code> - if <code>key</code> is
  264. <code>null</code>.</dd>
  265. </dl>
  266. </li>
  267. </ul>
  268. <a name="containsKey-java.lang.Comparable-">
  269. <!-- -->
  270. </a>
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <h4>containsKey</h4>
  274. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.108">containsKey</a>(java.lang.Comparable&nbsp;key)</pre>
  275. <div class="block">Returns <code>true</code> if the map contains the specified key, and
  276. <code>false</code> otherwise.</div>
  277. <dl>
  278. <dt><span class="paramLabel">Parameters:</span></dt>
  279. <dd><code>key</code> - the key.</dd>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd><code>true</code> if the map contains the specified key, and
  282. <code>false</code> otherwise.</dd>
  283. </dl>
  284. </li>
  285. </ul>
  286. <a name="put-java.lang.Comparable-java.awt.Stroke-">
  287. <!-- -->
  288. </a>
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <h4>put</h4>
  292. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.119">put</a>(java.lang.Comparable&nbsp;key,
  293. java.awt.Stroke&nbsp;stroke)</pre>
  294. <div class="block">Adds a mapping between the specified <code>key</code> and
  295. <code>stroke</code> values.</div>
  296. <dl>
  297. <dt><span class="paramLabel">Parameters:</span></dt>
  298. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  299. <dd><code>stroke</code> - the stroke.</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. <a name="clear--">
  304. <!-- -->
  305. </a>
  306. <ul class="blockList">
  307. <li class="blockList">
  308. <h4>clear</h4>
  309. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.127">clear</a>()</pre>
  310. <div class="block">Resets the map to empty.</div>
  311. </li>
  312. </ul>
  313. <a name="equals-java.lang.Object-">
  314. <!-- -->
  315. </a>
  316. <ul class="blockList">
  317. <li class="blockList">
  318. <h4>equals</h4>
  319. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.139">equals</a>(java.lang.Object&nbsp;obj)</pre>
  320. <div class="block">Tests this map for equality with an arbitrary object.</div>
  321. <dl>
  322. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  323. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  324. <dt><span class="paramLabel">Parameters:</span></dt>
  325. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  326. <dt><span class="returnLabel">Returns:</span></dt>
  327. <dd>A boolean.</dd>
  328. </dl>
  329. </li>
  330. </ul>
  331. <a name="clone--">
  332. <!-- -->
  333. </a>
  334. <ul class="blockListLast">
  335. <li class="blockList">
  336. <h4>clone</h4>
  337. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/chart/StrokeMap.html#line.171">clone</a>()
  338. throws java.lang.CloneNotSupportedException</pre>
  339. <div class="block">Returns a clone of this <code>StrokeMap</code>.</div>
  340. <dl>
  341. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  342. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  343. <dt><span class="returnLabel">Returns:</span></dt>
  344. <dd>A clone of this instance.</dd>
  345. <dt><span class="throwsLabel">Throws:</span></dt>
  346. <dd><code>java.lang.CloneNotSupportedException</code> - if any key is not cloneable.</dd>
  347. </dl>
  348. </li>
  349. </ul>
  350. </li>
  351. </ul>
  352. </li>
  353. </ul>
  354. </div>
  355. </div>
  356. <!-- ========= END OF CLASS DATA ========= -->
  357. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  358. <div class="bottomNav"><a name="navbar.bottom">
  359. <!-- -->
  360. </a>
  361. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  362. <a name="navbar.bottom.firstrow">
  363. <!-- -->
  364. </a>
  365. <ul class="navList" title="Navigation">
  366. <li><a href="../../../overview-summary.html">Overview</a></li>
  367. <li><a href="package-summary.html">Package</a></li>
  368. <li class="navBarCell1Rev">Class</li>
  369. <li><a href="class-use/StrokeMap.html">Use</a></li>
  370. <li><a href="package-tree.html">Tree</a></li>
  371. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  372. <li><a href="../../../index-files/index-1.html">Index</a></li>
  373. <li><a href="../../../help-doc.html">Help</a></li>
  374. </ul>
  375. </div>
  376. <div class="subNav">
  377. <ul class="navList">
  378. <li><a href="../../../org/jfree/chart/StandardChartTheme.html" title="class in org.jfree.chart"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  379. <li>Next&nbsp;Class</li>
  380. </ul>
  381. <ul class="navList">
  382. <li><a href="../../../index.html?org/jfree/chart/StrokeMap.html" target="_top">Frames</a></li>
  383. <li><a href="StrokeMap.html" target="_top">No&nbsp;Frames</a></li>
  384. </ul>
  385. <ul class="navList" id="allclasses_navbar_bottom">
  386. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  387. </ul>
  388. <div>
  389. <script type="text/javascript"><!--
  390. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  391. if(window==top) {
  392. allClassesLink.style.display = "block";
  393. }
  394. else {
  395. allClassesLink.style.display = "none";
  396. }
  397. //-->
  398. </script>
  399. </div>
  400. <div>
  401. <ul class="subNavList">
  402. <li>Summary:&nbsp;</li>
  403. <li>Nested&nbsp;|&nbsp;</li>
  404. <li>Field&nbsp;|&nbsp;</li>
  405. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  406. <li><a href="#method.summary">Method</a></li>
  407. </ul>
  408. <ul class="subNavList">
  409. <li>Detail:&nbsp;</li>
  410. <li>Field&nbsp;|&nbsp;</li>
  411. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  412. <li><a href="#method.detail">Method</a></li>
  413. </ul>
  414. </div>
  415. <a name="skip.navbar.bottom">
  416. <!-- -->
  417. </a></div>
  418. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  419. </body>
  420. </html>