PageRenderTime 23ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 225 lines | 186 code | 29 blank | 10 comment | 0 complexity | e2563b16c51a7ad03b96bcb092f3aec6 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. FoldHandlerProvider (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.buffer.FoldHandlerProvider interface">
  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/FoldHandlerProvider.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/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/IndentFoldHandler.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/FoldHandlerProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="FoldHandlerProvider.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;CONSTR&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;CONSTR&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. Interface FoldHandlerProvider</H2>
  68. <DL>
  69. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/buffer/DefaultFoldHandlerProvider.html" title="class in org.gjt.sp.jedit.buffer">DefaultFoldHandlerProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/ServiceManager.ServiceFoldHandlerProvider.html" title="class in org.gjt.sp.jedit">ServiceManager.ServiceFoldHandlerProvider</A></DD>
  70. </DL>
  71. <HR>
  72. <DL>
  73. <DT><PRE>public interface <B>FoldHandlerProvider</B></DL>
  74. </PRE>
  75. <P>
  76. <DL>
  77. <DT><B>Since:</B></DT>
  78. <DD>jEdit 4.3pre10</DD>
  79. </DL>
  80. <HR>
  81. <P>
  82. <!-- ========== METHOD SUMMARY =========== -->
  83. <A NAME="method_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>Method Summary</B></FONT></TH>
  88. </TR>
  89. <TR BGCOLOR="white" CLASS="TableRowColor">
  90. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  91. <CODE>&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer">FoldHandler</A></CODE></FONT></TD>
  92. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html#getFoldHandler(java.lang.String)">getFoldHandler</A></B>(java.lang.String&nbsp;name)</CODE>
  93. <BR>
  94. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the fold handler with the specified name, or null if
  95. there is no registered handler with that name.</TD>
  96. </TR>
  97. <TR BGCOLOR="white" CLASS="TableRowColor">
  98. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  99. <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
  100. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandlerProvider.html#getFoldModes()">getFoldModes</A></B>()</CODE>
  101. <BR>
  102. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the names of all registered fold
  103. handlers.</TD>
  104. </TR>
  105. </TABLE>
  106. &nbsp;
  107. <P>
  108. <!-- ============ METHOD DETAIL ========== -->
  109. <A NAME="method_detail"><!-- --></A>
  110. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  111. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  112. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  113. <B>Method Detail</B></FONT></TH>
  114. </TR>
  115. </TABLE>
  116. <A NAME="getFoldHandler(java.lang.String)"><!-- --></A><H3>
  117. getFoldHandler</H3>
  118. <PRE>
  119. <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>
  120. <DL>
  121. <DD>Returns the fold handler with the specified name, or null if
  122. there is no registered handler with that name.
  123. <P>
  124. <DD><DL>
  125. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the desired fold handler
  126. <DT><B>Returns:</B><DD>the FoldHandler or null if it doesn't exists<DT><B>Since:</B></DT>
  127. <DD>jEdit 4.3pre10</DD>
  128. </DL>
  129. </DD>
  130. </DL>
  131. <HR>
  132. <A NAME="getFoldModes()"><!-- --></A><H3>
  133. getFoldModes</H3>
  134. <PRE>
  135. java.lang.String[] <B>getFoldModes</B>()</PRE>
  136. <DL>
  137. <DD>Returns an array containing the names of all registered fold
  138. handlers.
  139. <P>
  140. <DD><DL>
  141. <DT><B>Since:</B></DT>
  142. <DD>jEdit 4.0pre6</DD>
  143. </DL>
  144. </DD>
  145. </DL>
  146. <!-- ========= END OF CLASS DATA ========= -->
  147. <HR>
  148. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  149. <A NAME="navbar_bottom"><!-- --></A>
  150. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  151. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  152. <TR>
  153. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  154. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  155. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  156. <TR ALIGN="center" VALIGN="top">
  157. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  158. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  159. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  160. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FoldHandlerProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  161. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  162. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  163. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  164. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  165. </TR>
  166. </TABLE>
  167. </TD>
  168. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  169. </EM>
  170. </TD>
  171. </TR>
  172. <TR>
  173. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  174. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/FoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>PREV CLASS</B></A>&nbsp;
  175. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/buffer/IndentFoldHandler.html" title="class in org.gjt.sp.jedit.buffer"><B>NEXT CLASS</B></A></FONT></TD>
  176. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  177. <A HREF="../../../../../index.html?org/gjt/sp/jedit/buffer/FoldHandlerProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  178. &nbsp;<A HREF="FoldHandlerProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  179. &nbsp;
  180. <NOSCRIPT>
  181. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  182. </NOSCRIPT>
  183. </FONT></TD>
  184. </TR>
  185. <TR>
  186. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  187. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  188. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  189. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  190. </TR>
  191. </TABLE>
  192. <A NAME="skip-navbar_bottom"></A>
  193. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  194. <HR>
  195. </BODY>
  196. </HTML>