PageRenderTime 48ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/textarea/package-summary.html

#
HTML | 286 lines | 248 code | 32 blank | 6 comment | 0 complexity | 6b067c07ac6559e1246e72ad761ed5c0 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:17 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. org.gjt.sp.jedit.textarea (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.textarea package">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/syntax/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/visitors/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. </TABLE>
    64. 

  64. <A NAME="skip-navbar_top"></A>
    65. 

  65. <!-- ========= END OF TOP NAVBAR ========= -->
    66. 

  66. 

  67. <HR>
    68. 

  68. <H2>
    69. 

  69. Package org.gjt.sp.jedit.textarea
    70. 

  70. </H2>
    71. 

  71.  The classes in this package are in the process of being refactored, for jedit 4.3final.
    72. 

  72. <P>
    73. 

  73. <B>See:</B>
    74. 

  74. <BR>
    75. 

  75. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
    76. 

  76. <P>
    77. 

  77. 

  78. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    79. 

  79. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    80. 

  80. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    81. 

  81. <B>Interface Summary</B></FONT></TH>
    82. 

  82. </TR>
    83. 

  83. <TR BGCOLOR="white" CLASS="TableRowColor">
    84. 

  84. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/MouseActionsProvider.html" title="interface in org.gjt.sp.jedit.textarea">MouseActionsProvider</A></B></TD>
    85. 

  85. <TD>&nbsp;</TD>
    86. 

  86. </TR>
    87. 

  87. <TR BGCOLOR="white" CLASS="TableRowColor">
    88. 

  88. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/ScrollListener.html" title="interface in org.gjt.sp.jedit.textarea">ScrollListener</A></B></TD>
    89. 

  89. <TD>A scroll listener will be notified when the text area is scrolled, either
    90. 

  90.  horizontally or vertically.</TD>
    91. 

  91. </TR>
    92. 

  92. <TR BGCOLOR="white" CLASS="TableRowColor">
    93. 

  93. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/StatusListener.html" title="interface in org.gjt.sp.jedit.textarea">StatusListener</A></B></TD>
    94. 

  94. <TD>Fired when the text area needs to display a status message.</TD>
    95. 

  95. </TR>
    96. 

  96. <TR BGCOLOR="white" CLASS="TableRowColor">
    97. 

  97. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/StructureMatcher.html" title="interface in org.gjt.sp.jedit.textarea">StructureMatcher</A></B></TD>
    98. 

  98. <TD>An interface for matching parts of a source file's stucture.</TD>
    99. 

  99. </TR>
    100. 

  100. </TABLE>
    101. 

  101. &nbsp;
    102. 

  102. 

  103. <P>
    104. 

  104. 

  105. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    106. 

  106. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    107. 

  107. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    108. 

  108. <B>Class Summary</B></FONT></TH>
    109. 

  109. </TR>
    110. 

  110. <TR BGCOLOR="white" CLASS="TableRowColor">
    111. 

  111. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/AntiAlias.html" title="class in org.gjt.sp.jedit.textarea">AntiAlias</A></B></TD>
    112. 

  112. <TD>Class for representing AntiAlias values.</TD>
    113. 

  113. </TR>
    114. 

  114. <TR BGCOLOR="white" CLASS="TableRowColor">
    115. 

  115. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/DisplayManager.html" title="class in org.gjt.sp.jedit.textarea">DisplayManager</A></B></TD>
    116. 

  116. <TD>Manages low-level text display tasks, such as folding.</TD>
    117. 

  117. </TR>
    118. 

  118. <TR BGCOLOR="white" CLASS="TableRowColor">
    119. 

  119. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/Gutter.html" title="class in org.gjt.sp.jedit.textarea">Gutter</A></B></TD>
    120. 

  120. <TD>The gutter is the component that displays folding triangles and line
    121. 

  121.  numbers to the left of the text area.</TD>
    122. 

  122. </TR>
    123. 

  123. <TR BGCOLOR="white" CLASS="TableRowColor">
    124. 

  124. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/JEditTextArea.html" title="class in org.gjt.sp.jedit.textarea">JEditTextArea</A></B></TD>
    125. 

  125. <TD>jEdit's text component.</TD>
    126. 

  126. </TR>
    127. 

  127. <TR BGCOLOR="white" CLASS="TableRowColor">
    128. 

  128. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/MouseActions.html" title="class in org.gjt.sp.jedit.textarea">MouseActions</A></B></TD>
    129. 

  129. <TD>&nbsp;</TD>
    130. 

  130. </TR>
    131. 

  131. <TR BGCOLOR="white" CLASS="TableRowColor">
    132. 

  132. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/MouseHandler.html" title="class in org.gjt.sp.jedit.textarea">MouseHandler</A></B></TD>
    133. 

  133. <TD>The mouseHandler used for jEdit.</TD>
    134. 

  134. </TR>
    135. 

  135. <TR BGCOLOR="white" CLASS="TableRowColor">
    136. 

  136. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/ScrollLayout.html" title="class in org.gjt.sp.jedit.textarea">ScrollLayout</A></B></TD>
    137. 

  137. <TD>&nbsp;</TD>
    138. 

  138. </TR>
    139. 

  139. <TR BGCOLOR="white" CLASS="TableRowColor">
    140. 

  140. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/Selection.html" title="class in org.gjt.sp.jedit.textarea">Selection</A></B></TD>
    141. 

  141. <TD>An abstract class that holds data on a region of selected text.</TD>
    142. 

  142. </TR>
    143. 

  143. <TR BGCOLOR="white" CLASS="TableRowColor">
    144. 

  144. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/Selection.Range.html" title="class in org.gjt.sp.jedit.textarea">Selection.Range</A></B></TD>
    145. 

  145. <TD>An ordinary range selection.</TD>
    146. 

  146. </TR>
    147. 

  147. <TR BGCOLOR="white" CLASS="TableRowColor">
    148. 

  148. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/Selection.Rect.html" title="class in org.gjt.sp.jedit.textarea">Selection.Rect</A></B></TD>
    149. 

  149. <TD>A rectangular selection.</TD>
    150. 

  150. </TR>
    151. 

  151. <TR BGCOLOR="white" CLASS="TableRowColor">
    152. 

  152. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/StructureMatcher.BracketMatcher.html" title="class in org.gjt.sp.jedit.textarea">StructureMatcher.BracketMatcher</A></B></TD>
    153. 

  153. <TD>&nbsp;</TD>
    154. 

  154. </TR>
    155. 

  155. <TR BGCOLOR="white" CLASS="TableRowColor">
    156. 

  156. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/StructureMatcher.Highlight.html" title="class in org.gjt.sp.jedit.textarea">StructureMatcher.Highlight</A></B></TD>
    157. 

  157. <TD>Paints the structure match highlight.</TD>
    158. 

  158. </TR>
    159. 

  159. <TR BGCOLOR="white" CLASS="TableRowColor">
    160. 

  160. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/StructureMatcher.Match.html" title="class in org.gjt.sp.jedit.textarea">StructureMatcher.Match</A></B></TD>
    161. 

  161. <TD>A structure match, denoted by a start and end position.</TD>
    162. 

  162. </TR>
    163. 

  163. <TR BGCOLOR="white" CLASS="TableRowColor">
    164. 

  164. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A></B></TD>
    165. 

  165. <TD>jEdit's text component.</TD>
    166. 

  166. </TR>
    167. 

  167. <TR BGCOLOR="white" CLASS="TableRowColor">
    168. 

  168. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaBorder.html" title="class in org.gjt.sp.jedit.textarea">TextAreaBorder</A></B></TD>
    169. 

  169. <TD>&nbsp;</TD>
    170. 

  170. </TR>
    171. 

  171. <TR BGCOLOR="white" CLASS="TableRowColor">
    172. 

  172. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html" title="class in org.gjt.sp.jedit.textarea">TextAreaExtension</A></B></TD>
    173. 

  173. <TD>Subclasses of this class can perform custom painting and tool tip
    174. 

  174.  handling in the text area and gutter.</TD>
    175. 

  175. </TR>
    176. 

  176. <TR BGCOLOR="white" CLASS="TableRowColor">
    177. 

  177. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaMouseHandler.html" title="class in org.gjt.sp.jedit.textarea">TextAreaMouseHandler</A></B></TD>
    178. 

  178. <TD>&nbsp;</TD>
    179. 

  179. </TR>
    180. 

  180. <TR BGCOLOR="white" CLASS="TableRowColor">
    181. 

  181. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaPainter.html" title="class in org.gjt.sp.jedit.textarea">TextAreaPainter</A></B></TD>
    182. 

  182. <TD>The text area painter is the component responsible for displaying the
    183. 

  183.  text of the current buffer.</TD>
    184. 

  184. </TR>
    185. 

  185. <TR BGCOLOR="white" CLASS="TableRowColor">
    186. 

  186. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaTransferHandler.html" title="class in org.gjt.sp.jedit.textarea">TextAreaTransferHandler</A></B></TD>
    187. 

  187. <TD>&nbsp;</TD>
    188. 

  188. </TR>
    189. 

  189. </TABLE>
    190. 

  190. &nbsp;
    191. 

  191. 

  192. <P>
    193. 

  193. 

  194. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    195. 

  195. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    196. 

  196. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    197. 

  197. <B>Exception Summary</B></FONT></TH>
    198. 

  198. </TR>
    199. 

  199. <TR BGCOLOR="white" CLASS="TableRowColor">
    200. 

  200. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaException.html" title="class in org.gjt.sp.jedit.textarea">TextAreaException</A></B></TD>
    201. 

  201. <TD>Exception that the TextArea can throw when an error occurs.</TD>
    202. 

  202. </TR>
    203. 

  203. </TABLE>
    204. 

  204. &nbsp;
    205. 

  205. 

  206. <P>
    207. 

  207. <A NAME="package_description"><!-- --></A><H2>
    208. 

  208. Package org.gjt.sp.jedit.textarea Description
    209. 

  209. </H2>
    210. 

  210. 

  211. <P>
    212. 

  212. <p> The classes in this package are in the process of being refactored, for jedit 4.3final. Here is a list of the tasks that were done. 
    213. 

  213. </p>
    214. 

  214. 

  215. <h2> What has been done </h2>
    216. 

  216. 

  217. <ul>
    218. 

  218. <li> @ref JEditBuffer and @ref Buffer were split into two classes. </li>
    219. 

  219. 

  220. <h2> What needs to be done: </h2>
    221. 

  221. 

  222. <ol>
    223. 

  223. <li> Here is a list of todo items related to textarea refactoring. </li>
    224. 

  224. </ol>
    225. 

  225. 

  226. <h2> The final goal </h2>
    227. 

  227.  <p> 
    228. 

  228. The refactored TextArea includes the packages "textarea", "buffer", "syntax", and should include nothing else.
    229. 

  229. </p>
    230. 

  230. </p>
    231. 

  231. <P>
    232. 

  232. 

  233. <P>
    234. 

  234. <DL>
    235. 

  235. </DL>
    236. 

  236. <HR>
    237. 

  237. 

  238. 

  239. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    240. 

  240. <A NAME="navbar_bottom"><!-- --></A>
    241. 

  241. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    242. 

  242. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    243. 

  243. <TR>
    244. 

  244. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    245. 

  245. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    246. 

  246. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    247. 

  247.   <TR ALIGN="center" VALIGN="top">
    248. 

  248.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    249. 

  249.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    250. 

  250.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    251. 

  251.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    252. 

  252.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    253. 

  253.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    254. 

  254.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    255. 

  255.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    256. 

  256.   </TR>
    257. 

  257. </TABLE>
    258. 

  258. </TD>
    259. 

  259. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    260. 

  260. </EM>
    261. 

  261. </TD>
    262. 

  262. </TR>
    263. 

  263. 

  264. <TR>
    265. 

  265. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    266. 

  266. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/syntax/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    267. 

  267. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/visitors/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    268. 

  268. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    269. 

  269.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    270. 

  270. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    271. 

  271. &nbsp;
    272. 

  272. <NOSCRIPT>
    273. 

  273.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    274. 

  274. </NOSCRIPT>
    275. 

  275. 

  276. 

  277. </FONT></TD>
    278. 

  278. </TR>
    279. 

  279. </TABLE>
    280. 

  280. <A NAME="skip-navbar_bottom"></A>
    281. 

  281. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    282. 

  282. 

  283. <HR>
    284. 

  284. 

  285. </BODY>
    286. 

  286. </HTML>
    287. 

  287.