LineBorder.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:28 CEST 2014 -->
  6. <title>LineBorder (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="LineBorder (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};
  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/LineBorder.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/chart/block/LengthConstraintType.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/block/LineBorder.html" target="_top">Frames</a></li>
  57. <li><a href="LineBorder.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.block</div>
  96. <h2 title="Class LineBorder" class="title">Class LineBorder</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.block.LineBorder</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, <a href="../../../../org/jfree/chart/block/BlockFrame.html" title="interface in org.jfree.chart.block">BlockFrame</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.71">LineBorder</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/block/BlockFrame.html" title="interface in org.jfree.chart.block">BlockFrame</a>, java.io.Serializable</pre>
  119. <div class="block">A line border for any <a href="../../../../org/jfree/chart/block/AbstractBlock.html" title="class in org.jfree.chart.block"><code>AbstractBlock</code></a>.</div>
  120. <dl>
  121. <dt><span class="simpleTagLabel">Since:</span></dt>
  122. <dd>1.0.5</dd>
  123. <dt><span class="seeLabel">See Also:</span></dt>
  124. <dd><a href="../../../../serialized-form.html#org.jfree.chart.block.LineBorder">Serialized Form</a></dd>
  125. </dl>
  126. </li>
  127. </ul>
  128. </div>
  129. <div class="summary">
  130. <ul class="blockList">
  131. <li class="blockList">
  132. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  133. <ul class="blockList">
  134. <li class="blockList"><a name="constructor.summary">
  135. <!-- -->
  136. </a>
  137. <h3>Constructor Summary</h3>
  138. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  139. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  140. <tr>
  141. <th class="colOne" scope="col">Constructor and Description</th>
  142. </tr>
  143. <tr class="altColor">
  144. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#LineBorder--">LineBorder</a></span>()</code>
  145. <div class="block">Creates a default border.</div>
  146. </td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#LineBorder-java.awt.Paint-java.awt.Stroke-org.jfree.ui.RectangleInsets-">LineBorder</a></span>(java.awt.Paint&nbsp;paint,
  150. java.awt.Stroke&nbsp;stroke,
  151. org.jfree.ui.RectangleInsets&nbsp;insets)</code>
  152. <div class="block">Creates a new border with the specified color.</div>
  153. </td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. <!-- ========== METHOD SUMMARY =========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="method.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Method Summary</h3>
  164. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  165. <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>
  166. <tr>
  167. <th class="colFirst" scope="col">Modifier and Type</th>
  168. <th class="colLast" scope="col">Method and Description</th>
  169. </tr>
  170. <tr id="i0" class="altColor">
  171. <td class="colFirst"><code>void</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-">draw</a></span>(java.awt.Graphics2D&nbsp;g2,
  173. java.awt.geom.Rectangle2D&nbsp;area)</code>
  174. <div class="block">Draws the border by filling in the reserved space (in black).</div>
  175. </td>
  176. </tr>
  177. <tr id="i1" class="rowColor">
  178. <td class="colFirst"><code>boolean</code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  180. <div class="block">Tests this border for equality with an arbitrary instance.</div>
  181. </td>
  182. </tr>
  183. <tr id="i2" class="altColor">
  184. <td class="colFirst"><code>org.jfree.ui.RectangleInsets</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#getInsets--">getInsets</a></span>()</code>
  186. <div class="block">Returns the insets.</div>
  187. </td>
  188. </tr>
  189. <tr id="i3" class="rowColor">
  190. <td class="colFirst"><code>java.awt.Paint</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#getPaint--">getPaint</a></span>()</code>
  192. <div class="block">Returns the paint.</div>
  193. </td>
  194. </tr>
  195. <tr id="i4" class="altColor">
  196. <td class="colFirst"><code>java.awt.Stroke</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/block/LineBorder.html#getStroke--">getStroke</a></span>()</code>
  198. <div class="block">Returns the stroke.</div>
  199. </td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  207. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  208. </ul>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </div>
  214. <div class="details">
  215. <ul class="blockList">
  216. <li class="blockList">
  217. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  218. <ul class="blockList">
  219. <li class="blockList"><a name="constructor.detail">
  220. <!-- -->
  221. </a>
  222. <h3>Constructor Detail</h3>
  223. <a name="LineBorder--">
  224. <!-- -->
  225. </a>
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <h4>LineBorder</h4>
  229. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.88">LineBorder</a>()</pre>
  230. <div class="block">Creates a default border.</div>
  231. </li>
  232. </ul>
  233. <a name="LineBorder-java.awt.Paint-java.awt.Stroke-org.jfree.ui.RectangleInsets-">
  234. <!-- -->
  235. </a>
  236. <ul class="blockListLast">
  237. <li class="blockList">
  238. <h4>LineBorder</h4>
  239. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.100">LineBorder</a>(java.awt.Paint&nbsp;paint,
  240. java.awt.Stroke&nbsp;stroke,
  241. org.jfree.ui.RectangleInsets&nbsp;insets)</pre>
  242. <div class="block">Creates a new border with the specified color.</div>
  243. <dl>
  244. <dt><span class="paramLabel">Parameters:</span></dt>
  245. <dd><code>paint</code> - the color (<code>null</code> not permitted).</dd>
  246. <dd><code>stroke</code> - the border stroke (<code>null</code> not permitted).</dd>
  247. <dd><code>insets</code> - the insets (<code>null</code> not permitted).</dd>
  248. </dl>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. <!-- ============ METHOD DETAIL ========== -->
  254. <ul class="blockList">
  255. <li class="blockList"><a name="method.detail">
  256. <!-- -->
  257. </a>
  258. <h3>Method Detail</h3>
  259. <a name="getPaint--">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>getPaint</h4>
  265. <pre>public&nbsp;java.awt.Paint&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.114">getPaint</a>()</pre>
  266. <div class="block">Returns the paint.</div>
  267. <dl>
  268. <dt><span class="returnLabel">Returns:</span></dt>
  269. <dd>The paint (never <code>null</code>).</dd>
  270. </dl>
  271. </li>
  272. </ul>
  273. <a name="getInsets--">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>getInsets</h4>
  279. <pre>public&nbsp;org.jfree.ui.RectangleInsets&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.124">getInsets</a>()</pre>
  280. <div class="block">Returns the insets.</div>
  281. <dl>
  282. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  283. <dd><code><a href="../../../../org/jfree/chart/block/BlockFrame.html#getInsets--">getInsets</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/block/BlockFrame.html" title="interface in org.jfree.chart.block">BlockFrame</a></code></dd>
  284. <dt><span class="returnLabel">Returns:</span></dt>
  285. <dd>The insets (never <code>null</code>).</dd>
  286. </dl>
  287. </li>
  288. </ul>
  289. <a name="getStroke--">
  290. <!-- -->
  291. </a>
  292. <ul class="blockList">
  293. <li class="blockList">
  294. <h4>getStroke</h4>
  295. <pre>public&nbsp;java.awt.Stroke&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.133">getStroke</a>()</pre>
  296. <div class="block">Returns the stroke.</div>
  297. <dl>
  298. <dt><span class="returnLabel">Returns:</span></dt>
  299. <dd>The stroke (never <code>null</code>).</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. <a name="draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-">
  304. <!-- -->
  305. </a>
  306. <ul class="blockList">
  307. <li class="blockList">
  308. <h4>draw</h4>
  309. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.144">draw</a>(java.awt.Graphics2D&nbsp;g2,
  310. java.awt.geom.Rectangle2D&nbsp;area)</pre>
  311. <div class="block">Draws the border by filling in the reserved space (in black).</div>
  312. <dl>
  313. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  314. <dd><code><a href="../../../../org/jfree/chart/block/BlockFrame.html#draw-java.awt.Graphics2D-java.awt.geom.Rectangle2D-">draw</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/block/BlockFrame.html" title="interface in org.jfree.chart.block">BlockFrame</a></code></dd>
  315. <dt><span class="paramLabel">Parameters:</span></dt>
  316. <dd><code>g2</code> - the graphics device.</dd>
  317. <dd><code>area</code> - the area.</dd>
  318. </dl>
  319. </li>
  320. </ul>
  321. <a name="equals-java.lang.Object-">
  322. <!-- -->
  323. </a>
  324. <ul class="blockListLast">
  325. <li class="blockList">
  326. <h4>equals</h4>
  327. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/block/LineBorder.html#line.194">equals</a>(java.lang.Object&nbsp;obj)</pre>
  328. <div class="block">Tests this border for equality with an arbitrary instance.</div>
  329. <dl>
  330. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  331. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  332. <dt><span class="paramLabel">Parameters:</span></dt>
  333. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  334. <dt><span class="returnLabel">Returns:</span></dt>
  335. <dd>A boolean.</dd>
  336. </dl>
  337. </li>
  338. </ul>
  339. </li>
  340. </ul>
  341. </li>
  342. </ul>
  343. </div>
  344. </div>
  345. <!-- ========= END OF CLASS DATA ========= -->
  346. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  347. <div class="bottomNav"><a name="navbar.bottom">
  348. <!-- -->
  349. </a>
  350. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  351. <a name="navbar.bottom.firstrow">
  352. <!-- -->
  353. </a>
  354. <ul class="navList" title="Navigation">
  355. <li><a href="../../../../overview-summary.html">Overview</a></li>
  356. <li><a href="package-summary.html">Package</a></li>
  357. <li class="navBarCell1Rev">Class</li>
  358. <li><a href="class-use/LineBorder.html">Use</a></li>
  359. <li><a href="package-tree.html">Tree</a></li>
  360. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  361. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  362. <li><a href="../../../../help-doc.html">Help</a></li>
  363. </ul>
  364. </div>
  365. <div class="subNav">
  366. <ul class="navList">
  367. <li><a href="../../../../org/jfree/chart/block/LengthConstraintType.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  368. <li><a href="../../../../org/jfree/chart/block/RectangleConstraint.html" title="class in org.jfree.chart.block"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  369. </ul>
  370. <ul class="navList">
  371. <li><a href="../../../../index.html?org/jfree/chart/block/LineBorder.html" target="_top">Frames</a></li>
  372. <li><a href="LineBorder.html" target="_top">No&nbsp;Frames</a></li>
  373. </ul>
  374. <ul class="navList" id="allclasses_navbar_bottom">
  375. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  376. </ul>
  377. <div>
  378. <script type="text/javascript"><!--
  379. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  380. if(window==top) {
  381. allClassesLink.style.display = "block";
  382. }
  383. else {
  384. allClassesLink.style.display = "none";
  385. }
  386. //-->
  387. </script>
  388. </div>
  389. <div>
  390. <ul class="subNavList">
  391. <li>Summary:&nbsp;</li>
  392. <li>Nested&nbsp;|&nbsp;</li>
  393. <li>Field&nbsp;|&nbsp;</li>
  394. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  395. <li><a href="#method.summary">Method</a></li>
  396. </ul>
  397. <ul class="subNavList">
  398. <li>Detail:&nbsp;</li>
  399. <li>Field&nbsp;|&nbsp;</li>
  400. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  401. <li><a href="#method.detail">Method</a></li>
  402. </ul>
  403. </div>
  404. <a name="skip.navbar.bottom">
  405. <!-- -->
  406. </a></div>
  407. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  408. </body>
  409. </html>