PageRenderTime 360ms CodeModel.GetById 335ms app.highlight 18ms RepoModel.GetById 1ms 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
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:17 GMT-08:00 2008 -->
  6<TITLE>
  7org.gjt.sp.jedit.textarea (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.textarea package">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
 34  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/syntax/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/visitors/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63</TABLE>
 64<A NAME="skip-navbar_top"></A>
 65<!-- ========= END OF TOP NAVBAR ========= -->
 66
 67<HR>
 68<H2>
 69Package org.gjt.sp.jedit.textarea
 70</H2>
 71 The classes in this package are in the process of being refactored, for jedit 4.3final.
 72<P>
 73<B>See:</B>
 74<BR>
 75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
 76<P>
 77
 78<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 79<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 80<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 81<B>Interface Summary</B></FONT></TH>
 82</TR>
 83<TR BGCOLOR="white" CLASS="TableRowColor">
 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<TD>&nbsp;</TD>
 86</TR>
 87<TR BGCOLOR="white" CLASS="TableRowColor">
 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<TD>A scroll listener will be notified when the text area is scrolled, either
 90 horizontally or vertically.</TD>
 91</TR>
 92<TR BGCOLOR="white" CLASS="TableRowColor">
 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<TD>Fired when the text area needs to display a status message.</TD>
 95</TR>
 96<TR BGCOLOR="white" CLASS="TableRowColor">
 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<TD>An interface for matching parts of a source file's stucture.</TD>
 99</TR>
100</TABLE>
101&nbsp;
102
103<P>
104
105<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
106<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
107<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
108<B>Class Summary</B></FONT></TH>
109</TR>
110<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>Class for representing AntiAlias values.</TD>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>Manages low-level text display tasks, such as folding.</TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>The gutter is the component that displays folding triangles and line
121 numbers to the left of the text area.</TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>jEdit's text component.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>The mouseHandler used for jEdit.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>An abstract class that holds data on a region of selected text.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>An ordinary range selection.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>A rectangular selection.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>Paints the structure match highlight.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>A structure match, denoted by a start and end position.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>jEdit's text component.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>Subclasses of this class can perform custom painting and tool tip
174 handling in the text area and gutter.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>The text area painter is the component responsible for displaying the
183 text of the current buffer.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>&nbsp;</TD>
188</TR>
189</TABLE>
190&nbsp;
191
192<P>
193
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
196<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
197<B>Exception Summary</B></FONT></TH>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
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<TD>Exception that the TextArea can throw when an error occurs.</TD>
202</TR>
203</TABLE>
204&nbsp;
205
206<P>
207<A NAME="package_description"><!-- --></A><H2>
208Package org.gjt.sp.jedit.textarea Description
209</H2>
210
211<P>
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</p>
214
215<h2> What has been done </h2>
216
217<ul>
218<li> @ref JEditBuffer and @ref Buffer were split into two classes. </li>
219
220<h2> What needs to be done: </h2>
221
222<ol>
223<li> Here is a list of todo items related to textarea refactoring. </li>
224</ol>
225
226<h2> The final goal </h2>
227 <p> 
228The refactored TextArea includes the packages "textarea", "buffer", "syntax", and should include nothing else.
229</p>
230</p>
231<P>
232
233<P>
234<DL>
235</DL>
236<HR>
237
238
239<!-- ======= START OF BOTTOM NAVBAR ====== -->
240<A NAME="navbar_bottom"><!-- --></A>
241<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
242<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
243<TR>
244<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
245<A NAME="navbar_bottom_firstrow"><!-- --></A>
246<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
247  <TR ALIGN="center" VALIGN="top">
248  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
249  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
250  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
251  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
252  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
253  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
254  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
255  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
256  </TR>
257</TABLE>
258</TD>
259<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
260</EM>
261</TD>
262</TR>
263
264<TR>
265<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
266&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/syntax/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
267&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/visitors/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
268<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
269  <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
270&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
271&nbsp;
272<NOSCRIPT>
273  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
274</NOSCRIPT>
275
276
277</FONT></TD>
278</TR>
279</TABLE>
280<A NAME="skip-navbar_bottom"></A>
281<!-- ======== END OF BOTTOM NAVBAR ======= -->
282
283<HR>
284
285</BODY>
286</HTML>