PageRenderTime 48ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 1ms

/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
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. <!--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>
  7. ExplicitFoldHandler (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.buffer.ExplicitFoldHandler class">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  11. <NOSCRIPT>
  12. </NOSCRIPT>
  13. </HEAD>
  14. <BODY BGCOLOR="white" >
  15. <!-- ========= START OF TOP NAVBAR ======= -->
  16. <A NAME="navbar_top"><!-- --></A>
  17. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  18. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  19. <TR>
  20. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  21. <A NAME="navbar_top_firstrow"><!-- --></A>
  22. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  23. <TR ALIGN="center" VALIGN="top">
  24. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  25. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  26. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  27. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ExplicitFoldHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  28. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  29. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  30. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  32. </TR>
  33. </TABLE>
  34. </TD>
  35. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  36. </EM>
  37. </TD>
  38. </TR>
  39. <TR>
  40. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  41. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/DummyFoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  42. &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>
  43. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  44. <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/ExplicitFoldHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="ExplicitFoldHandler.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  46. &nbsp;
  47. <NOSCRIPT>
  48. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  49. </NOSCRIPT>
  50. </FONT></TD>
  51. </TR>
  52. <TR>
  53. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  54. 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>
  55. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  56. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  57. </TR>
  58. </TABLE>
  59. <A NAME="skip-navbar_top"></A>
  60. <!-- ========= END OF TOP NAVBAR ========= -->
  61. <HR>
  62. <!-- ======== START OF CLASS DATA ======== -->
  63. <H2>
  64. <FONT SIZE="-1">
  65. org.gjt.sp.jedit.buffer</FONT>
  66. <BR>
  67. Class ExplicitFoldHandler</H2>
  68. <PRE>
  69. java.lang.Object
  70. <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>
  71. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.buffer.ExplicitFoldHandler</B>
  72. </PRE>
  73. <HR>
  74. <DL>
  75. <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>
  76. </PRE>
  77. <P>
  78. A fold handler that folds lines based on markers ("{{{" and "}}}")
  79. embedded in the text.
  80. <P>
  81. <P>
  82. <DL>
  83. <DT><B>Since:</B></DT>
  84. <DD>jEdit 4.0pre1</DD>
  85. </DL>
  86. <HR>
  87. <P>
  88. <!-- =========== FIELD SUMMARY =========== -->
  89. <A NAME="field_summary"><!-- --></A>
  90. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  91. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  92. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  93. <B>Field Summary</B></FONT></TH>
  94. </TR>
  95. </TABLE>
  96. &nbsp;<A NAME="fields_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler"><!-- --></A>
  97. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  98. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  99. <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>
  100. </TR>
  101. <TR BGCOLOR="white" CLASS="TableRowColor">
  102. <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>
  103. </TR>
  104. </TABLE>
  105. &nbsp;
  106. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  107. <A NAME="constructor_summary"><!-- --></A>
  108. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  109. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  110. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  111. <B>Constructor Summary</B></FONT></TH>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/ExplicitFoldHandler.html#ExplicitFoldHandler()">ExplicitFoldHandler</A></B>()</CODE>
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  117. </TR>
  118. </TABLE>
  119. &nbsp;
  120. <!-- ========== METHOD SUMMARY =========== -->
  121. <A NAME="method_summary"><!-- --></A>
  122. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  123. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  124. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  125. <B>Method Summary</B></FONT></TH>
  126. </TR>
  127. <TR BGCOLOR="white" CLASS="TableRowColor">
  128. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  129. <CODE>&nbsp;int</CODE></FONT></TD>
  130. <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,
  131. int&nbsp;lineIndex,
  132. javax.swing.text.Segment&nbsp;seg)</CODE>
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the fold level of the specified line.</TD>
  135. </TR>
  136. </TABLE>
  137. &nbsp;<A NAME="methods_inherited_from_class_org.gjt.sp.jedit.buffer.FoldHandler"><!-- --></A>
  138. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  139. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  140. <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>
  141. </TR>
  142. <TR BGCOLOR="white" CLASS="TableRowColor">
  143. <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>
  144. </TR>
  145. </TABLE>
  146. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  147. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  148. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  149. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  150. </TR>
  151. <TR BGCOLOR="white" CLASS="TableRowColor">
  152. <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
  153. </TR>
  154. </TABLE>
  155. &nbsp;
  156. <P>
  157. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  158. <A NAME="constructor_detail"><!-- --></A>
  159. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  160. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  161. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  162. <B>Constructor Detail</B></FONT></TH>
  163. </TR>
  164. </TABLE>
  165. <A NAME="ExplicitFoldHandler()"><!-- --></A><H3>
  166. ExplicitFoldHandler</H3>
  167. <PRE>
  168. public <B>ExplicitFoldHandler</B>()</PRE>
  169. <DL>
  170. </DL>
  171. <!-- ============ METHOD DETAIL ========== -->
  172. <A NAME="method_detail"><!-- --></A>
  173. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  174. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  175. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  176. <B>Method Detail</B></FONT></TH>
  177. </TR>
  178. </TABLE>
  179. <A NAME="getFoldLevel(org.gjt.sp.jedit.buffer.JEditBuffer, int, javax.swing.text.Segment)"><!-- --></A><H3>
  180. getFoldLevel</H3>
  181. <PRE>
  182. public 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,
  183. int&nbsp;lineIndex,
  184. javax.swing.text.Segment&nbsp;seg)</PRE>
  185. <DL>
  186. <DD>Returns the fold level of the specified line.
  187. <P>
  188. <DD><DL>
  189. <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>
  190. </DD>
  191. <DD><DL>
  192. <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
  193. text from the buffer, if necessary
  194. <DT><B>Returns:</B><DD>The fold level of the specified line<DT><B>Since:</B></DT>
  195. <DD>jEdit 4.0pre1</DD>
  196. </DL>
  197. </DD>
  198. </DL>
  199. <!-- ========= END OF CLASS DATA ========= -->
  200. <HR>
  201. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  202. <A NAME="navbar_bottom"><!-- --></A>
  203. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  204. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  205. <TR>
  206. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  207. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  208. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  209. <TR ALIGN="center" VALIGN="top">
  210. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  211. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  212. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  213. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ExplicitFoldHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  215. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  216. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  217. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  218. </TR>
  219. </TABLE>
  220. </TD>
  221. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  222. </EM>
  223. </TD>
  224. </TR>
  225. <TR>
  226. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  227. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/DummyFoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  228. &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>
  229. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  230. <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/ExplicitFoldHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
  231. &nbsp;<A HREF="ExplicitFoldHandler.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  232. &nbsp;
  233. <NOSCRIPT>
  234. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  235. </NOSCRIPT>
  236. </FONT></TD>
  237. </TR>
  238. <TR>
  239. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  240. 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>
  241. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  242. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  243. </TR>
  244. </TABLE>
  245. <A NAME="skip-navbar_bottom"></A>
  246. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  247. <HR>
  248. </BODY>
  249. </HTML>