PageRenderTime 51ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 299 lines | 251 code | 36 blank | 12 comment | 0 complexity | d4c95f02b472e260705255189dfd3783 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. DefaultFoldHandlerProvider (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.buffer.DefaultFoldHandlerProvider 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/DefaultFoldHandlerProvider.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/ContentManager.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/DummyFoldHandler.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/DefaultFoldHandlerProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="DefaultFoldHandlerProvider.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;FIELD&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 DefaultFoldHandlerProvider</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.buffer.DefaultFoldHandlerProvider</B>
  71. </PRE>
  72. <DL>
  73. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer">FoldHandlerProvider</A></DD>
  74. </DL>
  75. <HR>
  76. <DL>
  77. <DT><PRE>public class <B>DefaultFoldHandlerProvider</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer">FoldHandlerProvider</A></DL>
  78. </PRE>
  79. <P>
  80. <HR>
  81. <P>
  82. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  83. <A NAME="constructor_summary"><!-- --></A>
  84. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  85. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  86. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  87. <B>Constructor Summary</B></FONT></TH>
  88. </TR>
  89. <TR BGCOLOR="white" CLASS="TableRowColor">
  90. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html#DefaultFoldHandlerProvider()">DefaultFoldHandlerProvider</A></B>()</CODE>
  91. <BR>
  92. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  93. </TR>
  94. </TABLE>
  95. &nbsp;
  96. <!-- ========== METHOD SUMMARY =========== -->
  97. <A NAME="method_summary"><!-- --></A>
  98. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  99. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  100. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  101. <B>Method Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  105. <CODE>&nbsp;void</CODE></FONT></TD>
  106. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html#addFoldHandler(org.gjt.sp.jedit.buffer.FoldHandler)">addFoldHandler</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A>&nbsp;foldHandler)</CODE>
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a new FoldHander.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html#getFoldHandler(java.lang.String)">getFoldHandler</A></B>(java.lang.String&nbsp;name)</CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the fold handler with the specified name, or null if
  116. there is no registered handler with that name.</TD>
  117. </TR>
  118. <TR BGCOLOR="white" CLASS="TableRowColor">
  119. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  120. <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
  121. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html#getFoldModes()">getFoldModes</A></B>()</CODE>
  122. <BR>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the names of all registered fold
  124. handlers.</TD>
  125. </TR>
  126. </TABLE>
  127. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  128. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  129. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  130. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  131. </TR>
  132. <TR BGCOLOR="white" CLASS="TableRowColor">
  133. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  134. </TR>
  135. </TABLE>
  136. &nbsp;
  137. <P>
  138. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  139. <A NAME="constructor_detail"><!-- --></A>
  140. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  141. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  142. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  143. <B>Constructor Detail</B></FONT></TH>
  144. </TR>
  145. </TABLE>
  146. <A NAME="DefaultFoldHandlerProvider()"><!-- --></A><H3>
  147. DefaultFoldHandlerProvider</H3>
  148. <PRE>
  149. public <B>DefaultFoldHandlerProvider</B>()</PRE>
  150. <DL>
  151. </DL>
  152. <!-- ============ METHOD DETAIL ========== -->
  153. <A NAME="method_detail"><!-- --></A>
  154. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  155. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  156. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  157. <B>Method Detail</B></FONT></TH>
  158. </TR>
  159. </TABLE>
  160. <A NAME="getFoldHandler(java.lang.String)"><!-- --></A><H3>
  161. getFoldHandler</H3>
  162. <PRE>
  163. public <A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A> <B>getFoldHandler</B>(java.lang.String&nbsp;name)</PRE>
  164. <DL>
  165. <DD>Returns the fold handler with the specified name, or null if
  166. there is no registered handler with that name.
  167. <P>
  168. <DD><DL>
  169. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html#getFoldHandler(java.lang.String)">getFoldHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer">FoldHandlerProvider</A></CODE></DL>
  170. </DD>
  171. <DD><DL>
  172. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the desired fold handler
  173. <DT><B>Returns:</B><DD>the FoldHandler or null if it doesn't exists<DT><B>Since:</B></DT>
  174. <DD>jEdit 4.3pre10</DD>
  175. </DL>
  176. </DD>
  177. </DL>
  178. <HR>
  179. <A NAME="getFoldModes()"><!-- --></A><H3>
  180. getFoldModes</H3>
  181. <PRE>
  182. public java.lang.String[] <B>getFoldModes</B>()</PRE>
  183. <DL>
  184. <DD>Returns an array containing the names of all registered fold
  185. handlers.
  186. <P>
  187. <DD><DL>
  188. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html#getFoldModes()">getFoldModes</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" title="interface in org.gjt.sp.jedit.buffer">FoldHandlerProvider</A></CODE></DL>
  189. </DD>
  190. <DD><DL>
  191. <DT><B>Since:</B></DT>
  192. <DD>jEdit 4.0pre6</DD>
  193. </DL>
  194. </DD>
  195. </DL>
  196. <HR>
  197. <A NAME="addFoldHandler(org.gjt.sp.jedit.buffer.FoldHandler)"><!-- --></A><H3>
  198. addFoldHandler</H3>
  199. <PRE>
  200. public void <B>addFoldHandler</B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A>&nbsp;foldHandler)</PRE>
  201. <DL>
  202. <DD>Add a new FoldHander.
  203. <P>
  204. <DD><DL>
  205. </DL>
  206. </DD>
  207. <DD><DL>
  208. <DT><B>Parameters:</B><DD><CODE>foldHandler</CODE> - the new foldHandler<DT><B>Since:</B></DT>
  209. <DD>jEdit 4.3pre13</DD>
  210. </DL>
  211. </DD>
  212. </DL>
  213. <!-- ========= END OF CLASS DATA ========= -->
  214. <HR>
  215. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  216. <A NAME="navbar_bottom"><!-- --></A>
  217. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  218. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  219. <TR>
  220. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  221. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  222. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  223. <TR ALIGN="center" VALIGN="top">
  224. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  225. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  226. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  227. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultFoldHandlerProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  228. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  229. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  230. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  231. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  232. </TR>
  233. </TABLE>
  234. </TD>
  235. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  236. </EM>
  237. </TD>
  238. </TR>
  239. <TR>
  240. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  241. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/ContentManager.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  242. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/DummyFoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>NEXT CLASS</B></A></FONT></TD>
  243. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  244. <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  245. &nbsp;<A HREF="DefaultFoldHandlerProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  246. &nbsp;
  247. <NOSCRIPT>
  248. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  249. </NOSCRIPT>
  250. </FONT></TD>
  251. </TR>
  252. <TR>
  253. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  254. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  255. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  256. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  257. </TR>
  258. </TABLE>
  259. <A NAME="skip-navbar_bottom"></A>
  260. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  261. <HR>
  262. </BODY>
  263. </HTML>