PageRenderTime 42ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/indent/DeepIndentRule.html

#
HTML | 258 lines | 213 code | 33 blank | 12 comment | 0 complexity | 740389be15af17ec186158641aed96cc 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:14:01 GMT-08:00 2008 -->
  6. <TITLE>
  7. DeepIndentRule (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.indent.DeepIndentRule 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/DeepIndentRule.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/indent/CloseBracketIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent"><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/indent/DeepIndentRule.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="DeepIndentRule.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.indent</FONT>
  66. <BR>
  67. Class DeepIndentRule</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.indent.DeepIndentRule</B>
  71. </PRE>
  72. <DL>
  73. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentRule.html" title="interface in org.gjt.sp.jedit.indent">IndentRule</A></DD>
  74. </DL>
  75. <HR>
  76. <DL>
  77. <DT><PRE>public class <B>DeepIndentRule</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentRule.html" title="interface in org.gjt.sp.jedit.indent">IndentRule</A></DL>
  78. </PRE>
  79. <P>
  80. Deep indent rule.
  81. <P>
  82. <P>
  83. <HR>
  84. <P>
  85. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  86. <A NAME="constructor_summary"><!-- --></A>
  87. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  88. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  89. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  90. <B>Constructor Summary</B></FONT></TH>
  91. </TR>
  92. <TR BGCOLOR="white" CLASS="TableRowColor">
  93. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/DeepIndentRule.html#DeepIndentRule(char, char)">DeepIndentRule</A></B>(char&nbsp;openChar,
  94. char&nbsp;closeChar)</CODE>
  95. <BR>
  96. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  97. </TR>
  98. </TABLE>
  99. &nbsp;
  100. <!-- ========== METHOD SUMMARY =========== -->
  101. <A NAME="method_summary"><!-- --></A>
  102. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  103. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  104. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  105. <B>Method Summary</B></FONT></TH>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  109. <CODE>&nbsp;void</CODE></FONT></TD>
  110. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/DeepIndentRule.html#apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)">apply</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
  111. int&nbsp;thisLineIndex,
  112. int&nbsp;prevLineIndex,
  113. int&nbsp;prevPrevLineIndex,
  114. java.util.List&lt;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A>&gt;&nbsp;indentActions)</CODE>
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Apply the indent rule to this line, and return an indent action.</TD>
  117. </TR>
  118. </TABLE>
  119. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  120. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  121. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  122. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  126. </TR>
  127. </TABLE>
  128. &nbsp;
  129. <P>
  130. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  131. <A NAME="constructor_detail"><!-- --></A>
  132. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  133. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  134. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  135. <B>Constructor Detail</B></FONT></TH>
  136. </TR>
  137. </TABLE>
  138. <A NAME="DeepIndentRule(char, char)"><!-- --></A><H3>
  139. DeepIndentRule</H3>
  140. <PRE>
  141. public <B>DeepIndentRule</B>(char&nbsp;openChar,
  142. char&nbsp;closeChar)</PRE>
  143. <DL>
  144. </DL>
  145. <!-- ============ METHOD DETAIL ========== -->
  146. <A NAME="method_detail"><!-- --></A>
  147. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  148. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  149. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  150. <B>Method Detail</B></FONT></TH>
  151. </TR>
  152. </TABLE>
  153. <A NAME="apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)"><!-- --></A><H3>
  154. apply</H3>
  155. <PRE>
  156. public void <B>apply</B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
  157. int&nbsp;thisLineIndex,
  158. int&nbsp;prevLineIndex,
  159. int&nbsp;prevPrevLineIndex,
  160. java.util.List&lt;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A>&gt;&nbsp;indentActions)</PRE>
  161. <DL>
  162. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentRule.html#apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)">IndentRule</A></CODE></B></DD>
  163. <DD>Apply the indent rule to this line, and return an indent action.
  164. <P>
  165. <DD><DL>
  166. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentRule.html#apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)">apply</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentRule.html" title="interface in org.gjt.sp.jedit.indent">IndentRule</A></CODE></DL>
  167. </DD>
  168. <DD><DL>
  169. <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - the buffer<DD><CODE>thisLineIndex</CODE> - the line index<DD><CODE>prevLineIndex</CODE> - the prior non empty line index
  170. (or -1 if there is no prior non empty line)<DD><CODE>prevPrevLineIndex</CODE> - the prior non empty line index before the prevLineIndex
  171. (or -1 if there is no prior non empty line)<DD><CODE>indentActions</CODE> - the indent actions list. The rule can add an action in it if
  172. it is necessary</DL>
  173. </DD>
  174. </DL>
  175. <!-- ========= END OF CLASS DATA ========= -->
  176. <HR>
  177. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  178. <A NAME="navbar_bottom"><!-- --></A>
  179. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  180. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  181. <TR>
  182. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  183. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  184. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  185. <TR ALIGN="center" VALIGN="top">
  186. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  187. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  188. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  189. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DeepIndentRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  190. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  191. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  192. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  193. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  194. </TR>
  195. </TABLE>
  196. </TD>
  197. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  198. </EM>
  199. </TD>
  200. </TR>
  201. <TR>
  202. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  203. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/CloseBracketIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
  204. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent"><B>NEXT CLASS</B></A></FONT></TD>
  205. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  206. <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/DeepIndentRule.html" target="_top"><B>FRAMES</B></A> &nbsp;
  207. &nbsp;<A HREF="DeepIndentRule.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  208. &nbsp;
  209. <NOSCRIPT>
  210. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  211. </NOSCRIPT>
  212. </FONT></TD>
  213. </TR>
  214. <TR>
  215. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  216. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  217. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  218. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  219. </TR>
  220. </TABLE>
  221. <A NAME="skip-navbar_bottom"></A>
  222. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  223. <HR>
  224. </BODY>
  225. </HTML>