PageRenderTime 131ms CodeModel.GetById 118ms app.highlight 9ms RepoModel.GetById 1ms app.codeStats 0ms

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

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