TextUtils.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:41 CEST 2014 -->
  6. <title>TextUtils (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="TextUtils (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/TextUtils.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/util/ShadowGenerator.html" title="interface in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/util/XYCoordinateType.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/util/TextUtils.html" target="_top">Frames</a></li>
  57. <li><a href="TextUtils.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.util</div>
  96. <h2 title="Class TextUtils" class="title">Class TextUtils</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.util.TextUtils</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.56">TextUtils</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">Text utility functions.</div>
  115. <dl>
  116. <dt><span class="simpleTagLabel">Since:</span></dt>
  117. <dd>1.0.18</dd>
  118. </dl>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor.summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/TextUtils.html#TextUtils--">TextUtils</a></span>()</code>&nbsp;</td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr id="i0" class="altColor">
  155. <td class="colFirst"><code>static java.awt.geom.Rectangle2D</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/TextUtils.html#calcAlignedStringBounds-java.lang.String-java.awt.Graphics2D-float-float-org.jfree.ui.TextAnchor-">calcAlignedStringBounds</a></span>(java.lang.String&nbsp;text,
  157. java.awt.Graphics2D&nbsp;g2,
  158. float&nbsp;x,
  159. float&nbsp;y,
  160. org.jfree.ui.TextAnchor&nbsp;anchor)</code>
  161. <div class="block">Returns the bounds of an aligned string.</div>
  162. </td>
  163. </tr>
  164. <tr id="i1" class="rowColor">
  165. <td class="colFirst"><code>static java.awt.geom.Rectangle2D</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/TextUtils.html#drawAlignedString-java.lang.String-java.awt.Graphics2D-float-float-org.jfree.ui.TextAnchor-">drawAlignedString</a></span>(java.lang.String&nbsp;text,
  167. java.awt.Graphics2D&nbsp;g2,
  168. float&nbsp;x,
  169. float&nbsp;y,
  170. org.jfree.ui.TextAnchor&nbsp;anchor)</code>
  171. <div class="block">Draws a string such that the specified anchor point is aligned to the
  172. given <code>(x, y)</code> location, and returns a bounding rectangle
  173. for the text.</div>
  174. </td>
  175. </tr>
  176. <tr id="i2" class="altColor">
  177. <td class="colFirst"><code>static java.awt.geom.Rectangle2D</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/TextUtils.html#getTextBounds-java.lang.String-double-double-java.awt.FontMetrics-">getTextBounds</a></span>(java.lang.String&nbsp;text,
  179. double&nbsp;x,
  180. double&nbsp;y,
  181. java.awt.FontMetrics&nbsp;fm)</code>
  182. <div class="block">Returns the bounds for the specified text when it is drawn with the
  183. left-baseline aligned to the point <code>(x, y)</code>.</div>
  184. </td>
  185. </tr>
  186. <tr id="i3" class="rowColor">
  187. <td class="colFirst"><code>static java.awt.geom.Rectangle2D</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/util/TextUtils.html#getTextBounds-java.lang.String-java.awt.FontMetrics-">getTextBounds</a></span>(java.lang.String&nbsp;text,
  189. java.awt.FontMetrics&nbsp;fm)</code>
  190. <div class="block">Returns the bounds for the specified text.</div>
  191. </td>
  192. </tr>
  193. </table>
  194. <ul class="blockList">
  195. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  196. <!-- -->
  197. </a>
  198. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  199. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  200. </ul>
  201. </li>
  202. </ul>
  203. </li>
  204. </ul>
  205. </div>
  206. <div class="details">
  207. <ul class="blockList">
  208. <li class="blockList">
  209. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="constructor.detail">
  212. <!-- -->
  213. </a>
  214. <h3>Constructor Detail</h3>
  215. <a name="TextUtils--">
  216. <!-- -->
  217. </a>
  218. <ul class="blockListLast">
  219. <li class="blockList">
  220. <h4>TextUtils</h4>
  221. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.56">TextUtils</a>()</pre>
  222. </li>
  223. </ul>
  224. </li>
  225. </ul>
  226. <!-- ============ METHOD DETAIL ========== -->
  227. <ul class="blockList">
  228. <li class="blockList"><a name="method.detail">
  229. <!-- -->
  230. </a>
  231. <h3>Method Detail</h3>
  232. <a name="drawAlignedString-java.lang.String-java.awt.Graphics2D-float-float-org.jfree.ui.TextAnchor-">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>drawAlignedString</h4>
  238. <pre>public static&nbsp;java.awt.geom.Rectangle2D&nbsp;<a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.71">drawAlignedString</a>(java.lang.String&nbsp;text,
  239. java.awt.Graphics2D&nbsp;g2,
  240. float&nbsp;x,
  241. float&nbsp;y,
  242. org.jfree.ui.TextAnchor&nbsp;anchor)</pre>
  243. <div class="block">Draws a string such that the specified anchor point is aligned to the
  244. given <code>(x, y)</code> location, and returns a bounding rectangle
  245. for the text.</div>
  246. <dl>
  247. <dt><span class="paramLabel">Parameters:</span></dt>
  248. <dd><code>text</code> - the text.</dd>
  249. <dd><code>g2</code> - the graphics device.</dd>
  250. <dd><code>x</code> - the x coordinate (Java 2D).</dd>
  251. <dd><code>y</code> - the y coordinate (Java 2D).</dd>
  252. <dd><code>anchor</code> - the anchor location.</dd>
  253. <dt><span class="returnLabel">Returns:</span></dt>
  254. <dd>The text bounds (adjusted for the text position).</dd>
  255. </dl>
  256. </li>
  257. </ul>
  258. <a name="calcAlignedStringBounds-java.lang.String-java.awt.Graphics2D-float-float-org.jfree.ui.TextAnchor-">
  259. <!-- -->
  260. </a>
  261. <ul class="blockList">
  262. <li class="blockList">
  263. <h4>calcAlignedStringBounds</h4>
  264. <pre>public static&nbsp;java.awt.geom.Rectangle2D&nbsp;<a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.98">calcAlignedStringBounds</a>(java.lang.String&nbsp;text,
  265. java.awt.Graphics2D&nbsp;g2,
  266. float&nbsp;x,
  267. float&nbsp;y,
  268. org.jfree.ui.TextAnchor&nbsp;anchor)</pre>
  269. <div class="block">Returns the bounds of an aligned string.</div>
  270. <dl>
  271. <dt><span class="paramLabel">Parameters:</span></dt>
  272. <dd><code>text</code> - the string (<code>null</code> not permitted).</dd>
  273. <dd><code>g2</code> - the graphics target (<code>null</code> not permitted).</dd>
  274. <dd><code>x</code> - the x-coordinate.</dd>
  275. <dd><code>y</code> - the y-coordinate.</dd>
  276. <dd><code>anchor</code> - the anchor point that will be aligned to
  277. <code>(x, y)</code> (<code>null</code> not permitted).</dd>
  278. <dt><span class="returnLabel">Returns:</span></dt>
  279. <dd>The text bounds (never <code>null</code>).</dd>
  280. <dt><span class="simpleTagLabel">Since:</span></dt>
  281. <dd>1.3</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="getTextBounds-java.lang.String-java.awt.FontMetrics-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>getTextBounds</h4>
  291. <pre>public static&nbsp;java.awt.geom.Rectangle2D&nbsp;<a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.240">getTextBounds</a>(java.lang.String&nbsp;text,
  292. java.awt.FontMetrics&nbsp;fm)</pre>
  293. <div class="block">Returns the bounds for the specified text. The supplied text is
  294. assumed to be on a single line (no carriage return or newline
  295. characters).</div>
  296. <dl>
  297. <dt><span class="paramLabel">Parameters:</span></dt>
  298. <dd><code>text</code> - the text (<code>null</code> not permitted).</dd>
  299. <dd><code>fm</code> - the font metrics (<code>null</code> not permitted).</dd>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>The text bounds.</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="getTextBounds-java.lang.String-double-double-java.awt.FontMetrics-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockListLast">
  309. <li class="blockList">
  310. <h4>getTextBounds</h4>
  311. <pre>public static&nbsp;java.awt.geom.Rectangle2D&nbsp;<a href="../../../../src-html/org/jfree/chart/util/TextUtils.html#line.255">getTextBounds</a>(java.lang.String&nbsp;text,
  312. double&nbsp;x,
  313. double&nbsp;y,
  314. java.awt.FontMetrics&nbsp;fm)</pre>
  315. <div class="block">Returns the bounds for the specified text when it is drawn with the
  316. left-baseline aligned to the point <code>(x, y)</code>.</div>
  317. <dl>
  318. <dt><span class="paramLabel">Parameters:</span></dt>
  319. <dd><code>text</code> - the text (<code>null</code> not permitted).</dd>
  320. <dd><code>x</code> - the x-coordinate.</dd>
  321. <dd><code>y</code> - the y-coordinate.</dd>
  322. <dd><code>fm</code> - the font metrics (<code>null</code> not permitted).</dd>
  323. <dt><span class="returnLabel">Returns:</span></dt>
  324. <dd>The bounding rectangle (never <code>null</code>).</dd>
  325. </dl>
  326. </li>
  327. </ul>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. </div>
  333. </div>
  334. <!-- ========= END OF CLASS DATA ========= -->
  335. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  336. <div class="bottomNav"><a name="navbar.bottom">
  337. <!-- -->
  338. </a>
  339. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  340. <a name="navbar.bottom.firstrow">
  341. <!-- -->
  342. </a>
  343. <ul class="navList" title="Navigation">
  344. <li><a href="../../../../overview-summary.html">Overview</a></li>
  345. <li><a href="package-summary.html">Package</a></li>
  346. <li class="navBarCell1Rev">Class</li>
  347. <li><a href="class-use/TextUtils.html">Use</a></li>
  348. <li><a href="package-tree.html">Tree</a></li>
  349. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  350. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  351. <li><a href="../../../../help-doc.html">Help</a></li>
  352. </ul>
  353. </div>
  354. <div class="subNav">
  355. <ul class="navList">
  356. <li><a href="../../../../org/jfree/chart/util/ShadowGenerator.html" title="interface in org.jfree.chart.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  357. <li><a href="../../../../org/jfree/chart/util/XYCoordinateType.html" title="class in org.jfree.chart.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  358. </ul>
  359. <ul class="navList">
  360. <li><a href="../../../../index.html?org/jfree/chart/util/TextUtils.html" target="_top">Frames</a></li>
  361. <li><a href="TextUtils.html" target="_top">No&nbsp;Frames</a></li>
  362. </ul>
  363. <ul class="navList" id="allclasses_navbar_bottom">
  364. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  365. </ul>
  366. <div>
  367. <script type="text/javascript"><!--
  368. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  369. if(window==top) {
  370. allClassesLink.style.display = "block";
  371. }
  372. else {
  373. allClassesLink.style.display = "none";
  374. }
  375. //-->
  376. </script>
  377. </div>
  378. <div>
  379. <ul class="subNavList">
  380. <li>Summary:&nbsp;</li>
  381. <li>Nested&nbsp;|&nbsp;</li>
  382. <li>Field&nbsp;|&nbsp;</li>
  383. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  384. <li><a href="#method.summary">Method</a></li>
  385. </ul>
  386. <ul class="subNavList">
  387. <li>Detail:&nbsp;</li>
  388. <li>Field&nbsp;|&nbsp;</li>
  389. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  390. <li><a href="#method.detail">Method</a></li>
  391. </ul>
  392. </div>
  393. <a name="skip.navbar.bottom">
  394. <!-- -->
  395. </a></div>
  396. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  397. </body>
  398. </html>