PageRenderTime 141ms CodeModel.GetById 117ms app.highlight 19ms RepoModel.GetById 0ms app.codeStats 1ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/buffer/IndentFoldHandler.html

#
HTML | 281 lines | 235 code | 33 blank | 13 comment | 0 complexity | 399a9b1c84ab34d514142cabcf6772ff 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:13:50 GMT-08:00 2008 -->
  6<TITLE>
  7IndentFoldHandler (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.buffer.IndentFoldHandler class">
 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="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IndentFoldHandler.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/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/IndentFoldHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="IndentFoldHandler.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<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.buffer</FONT>
 78<BR>
 79Class IndentFoldHandler</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">org.gjt.sp.jedit.buffer.FoldHandler</A>
 83      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.buffer.IndentFoldHandler</B>
 84</PRE>
 85<HR>
 86<DL>
 87<DT><PRE>public class <B>IndentFoldHandler</B><DT>extends <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></DL>
 88</PRE>
 89
 90<P>
 91A fold handler that folds lines based on their indent level.
 92<P>
 93
 94<P>
 95<DL>
 96<DT><B>Since:</B></DT>
 97  <DD>jEdit 4.0pre1</DD>
 98</DL>
 99<HR>
100
101<P>
102<!-- =========== FIELD SUMMARY =========== -->
103
104<A NAME="field_summary"><!-- --></A>
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>Field Summary</B></FONT></TH>
109</TR>
110</TABLE>
111&nbsp;<A NAME="fields_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
114<TH ALIGN="left"><B>Fields inherited from class org.gjt.sp.jedit.buffer.<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></B></TH>
115</TR>
116<TR BGCOLOR="white" CLASS="TableRowColor">
117<TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#foldHandlerProvider">foldHandlerProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#SERVICE">SERVICE</A></CODE></TD>
118</TR>
119</TABLE>
120&nbsp;
121<!-- ======== CONSTRUCTOR SUMMARY ======== -->
122
123<A NAME="constructor_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127<B>Constructor Summary</B></FONT></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/IndentFoldHandler.html#IndentFoldHandler()">IndentFoldHandler</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- ========== METHOD SUMMARY =========== -->
138
139<A NAME="method_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Method Summary</B></FONT></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;int</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/IndentFoldHandler.html#getFoldLevel(org.gjt.sp.jedit.buffer.JEditBuffer, int, javax.swing.text.Segment)">getFoldLevel</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
149             int&nbsp;lineIndex,
150             javax.swing.text.Segment&nbsp;seg)</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the fold level of the specified line.</TD>
154</TR>
155</TABLE>
156&nbsp;<A NAME="methods_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
159<TH ALIGN="left"><B>Methods inherited from class org.gjt.sp.jedit.buffer.<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></B></TH>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#getFoldHandler(java.lang.String)">getFoldHandler</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#getFoldModes()">getFoldModes</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#getName()">getName</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#hashCode()">hashCode</A>, <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#toString()">toString</A></CODE></TD>
163</TR>
164</TABLE>
165&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
168<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
172</TR>
173</TABLE>
174&nbsp;
175<P>
176
177<!-- ========= CONSTRUCTOR DETAIL ======== -->
178
179<A NAME="constructor_detail"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
183<B>Constructor Detail</B></FONT></TH>
184</TR>
185</TABLE>
186
187<A NAME="IndentFoldHandler()"><!-- --></A><H3>
188IndentFoldHandler</H3>
189<PRE>
190public <B>IndentFoldHandler</B>()</PRE>
191<DL>
192</DL>
193
194<!-- ============ METHOD DETAIL ========== -->
195
196<A NAME="method_detail"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
200<B>Method Detail</B></FONT></TH>
201</TR>
202</TABLE>
203
204<A NAME="getFoldLevel(org.gjt.sp.jedit.buffer.JEditBuffer, int, javax.swing.text.Segment)"><!-- --></A><H3>
205getFoldLevel</H3>
206<PRE>
207public int <B>getFoldLevel</B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
208                        int&nbsp;lineIndex,
209                        javax.swing.text.Segment&nbsp;seg)</PRE>
210<DL>
211<DD>Returns the fold level of the specified line.
212<P>
213<DD><DL>
214<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html#getFoldLevel(org.gjt.sp.jedit.buffer.JEditBuffer, int, javax.swing.text.Segment)">getFoldLevel</A></CODE> in class <CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></CODE></DL>
215</DD>
216<DD><DL>
217<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The buffer in question<DD><CODE>lineIndex</CODE> - The line index<DD><CODE>seg</CODE> - A segment the fold handler can use to obtain any
218 text from the buffer, if necessary
219<DT><B>Returns:</B><DD>The fold level of the specified line<DT><B>Since:</B></DT>
220  <DD>jEdit 4.0pre1</DD>
221</DL>
222</DD>
223</DL>
224<!-- ========= END OF CLASS DATA ========= -->
225<HR>
226
227
228<!-- ======= START OF BOTTOM NAVBAR ====== -->
229<A NAME="navbar_bottom"><!-- --></A>
230<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
231<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
232<TR>
233<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
234<A NAME="navbar_bottom_firstrow"><!-- --></A>
235<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
236  <TR ALIGN="center" VALIGN="top">
237  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
238  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
239  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
240  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IndentFoldHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
241  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
242  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
243  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
244  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
245  </TR>
246</TABLE>
247</TD>
248<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
249</EM>
250</TD>
251</TR>
252
253<TR>
254<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
255&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
256&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer"><B>NEXT CLASS</B></A></FONT></TD>
257<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
258  <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/IndentFoldHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
259&nbsp;<A HREF="IndentFoldHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
260&nbsp;
261<NOSCRIPT>
262  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
263</NOSCRIPT>
264
265
266</FONT></TD>
267</TR>
268<TR>
269<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
270  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
271<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
272DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
273</TR>
274</TABLE>
275<A NAME="skip-navbar_bottom"></A>
276<!-- ======== END OF BOTTOM NAVBAR ======= -->
277
278<HR>
279
280</BODY>
281</HTML>