PageRenderTime 67ms CodeModel.GetById 32ms RepoModel.GetById 1ms 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. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:01 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. DeepIndentRule (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.indent.DeepIndentRule class">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DeepIndentRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/CloseBracketIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &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>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/DeepIndentRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="DeepIndentRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. <TR>
    64. 

  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    65. 

  65.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    66. 

  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    67. 

  67. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    68. 

  68. </TR>
    69. 

  69. </TABLE>
    70. 

  70. <A NAME="skip-navbar_top"></A>
    71. 

  71. <!-- ========= END OF TOP NAVBAR ========= -->
    72. 

  72. 

  73. <HR>
    74. 

  74. <!-- ======== START OF CLASS DATA ======== -->
    75. 

  75. <H2>
    76. 

  76. <FONT SIZE="-1">
    77. 

  77. org.gjt.sp.jedit.indent</FONT>
    78. 

  78. <BR>
    79. 

  79. Class DeepIndentRule</H2>
    80. 

  80. <PRE>
    81. 

  81. java.lang.Object
    82. 

  82.   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.indent.DeepIndentRule</B>
    83. 

  83. </PRE>
    84. 

  84. <DL>
    85. 

  85. <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>
    86. 

  86. </DL>
    87. 

  87. <HR>
    88. 

  88. <DL>
    89. 

  89. <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>
    90. 

  90. </PRE>
    91. 

  91. 

  92. <P>
    93. 

  93. Deep indent rule.
    94. 

  94. <P>
    95. 

  95. 

  96. <P>
    97. 

  97. <HR>
    98. 

  98. 

  99. <P>
    100. 

  100. 

  101. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    102. 

  102. 

  103. <A NAME="constructor_summary"><!-- --></A>
    104. 

  104. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    105. 

  105. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    106. 

  106. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    107. 

  107. <B>Constructor Summary</B></FONT></TH>
    108. 

  108. </TR>
    109. 

  109. <TR BGCOLOR="white" CLASS="TableRowColor">
    110. 

  110. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/DeepIndentRule.html#DeepIndentRule(char, char)">DeepIndentRule</A></B>(char&nbsp;openChar,
    111. 

  111.                char&nbsp;closeChar)</CODE>
    112. 

  112. 

  113. <BR>
    114. 

  114. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    115. 

  115. </TR>
    116. 

  116. </TABLE>
    117. 

  117. &nbsp;
    118. 

  118. <!-- ========== METHOD SUMMARY =========== -->
    119. 

  119. 

  120. <A NAME="method_summary"><!-- --></A>
    121. 

  121. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    122. 

  122. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    123. 

  123. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    124. 

  124. <B>Method Summary</B></FONT></TH>
    125. 

  125. </TR>
    126. 

  126. <TR BGCOLOR="white" CLASS="TableRowColor">
    127. 

  127. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    128. 

  128. <CODE>&nbsp;void</CODE></FONT></TD>
    129. 

  129. <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,
    130. 

  130.       int&nbsp;thisLineIndex,
    131. 

  131.       int&nbsp;prevLineIndex,
    132. 

  132.       int&nbsp;prevPrevLineIndex,
    133. 

  133.       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>
    134. 

  134. 

  135. <BR>
    136. 

  136. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Apply the indent rule to this line, and return an indent action.</TD>
    137. 

  137. </TR>
    138. 

  138. </TABLE>
    139. 

  139. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    140. 

  140. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    141. 

  141. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    142. 

  142. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
    143. 

  143. </TR>
    144. 

  144. <TR BGCOLOR="white" CLASS="TableRowColor">
    145. 

  145. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
    146. 

  146. </TR>
    147. 

  147. </TABLE>
    148. 

  148. &nbsp;
    149. 

  149. <P>
    150. 

  150. 

  151. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    152. 

  152. 

  153. <A NAME="constructor_detail"><!-- --></A>
    154. 

  154. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    155. 

  155. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    156. 

  156. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    157. 

  157. <B>Constructor Detail</B></FONT></TH>
    158. 

  158. </TR>
    159. 

  159. </TABLE>
    160. 

  160. 

  161. <A NAME="DeepIndentRule(char, char)"><!-- --></A><H3>
    162. 

  162. DeepIndentRule</H3>
    163. 

  163. <PRE>
    164. 

  164. public <B>DeepIndentRule</B>(char&nbsp;openChar,
    165. 

  165.                       char&nbsp;closeChar)</PRE>
    166. 

  166. <DL>
    167. 

  167. </DL>
    168. 

  168. 

  169. <!-- ============ METHOD DETAIL ========== -->
    170. 

  170. 

  171. <A NAME="method_detail"><!-- --></A>
    172. 

  172. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    173. 

  173. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    174. 

  174. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    175. 

  175. <B>Method Detail</B></FONT></TH>
    176. 

  176. </TR>
    177. 

  177. </TABLE>
    178. 

  178. 

  179. <A NAME="apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)"><!-- --></A><H3>
    180. 

  180. apply</H3>
    181. 

  181. <PRE>
    182. 

  182. 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,
    183. 

  183.                   int&nbsp;thisLineIndex,
    184. 

  184.                   int&nbsp;prevLineIndex,
    185. 

  185.                   int&nbsp;prevPrevLineIndex,
    186. 

  186.                   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>
    187. 

  187. <DL>
    188. 

  188. <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>
    189. 

  189. <DD>Apply the indent rule to this line, and return an indent action.
    190. 

  190. <P>
    191. 

  191. <DD><DL>
    192. 

  192. <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>
    193. 

  193. </DD>
    194. 

  194. <DD><DL>
    195. 

  195. <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
    196. 

  196.  (or -1 if there is no prior non empty line)<DD><CODE>prevPrevLineIndex</CODE> - the prior non empty line index before the prevLineIndex
    197. 

  197.  (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
    198. 

  198.  it is necessary</DL>
    199. 

  199. </DD>
    200. 

  200. </DL>
    201. 

  201. <!-- ========= END OF CLASS DATA ========= -->
    202. 

  202. <HR>
    203. 

  203. 

  204. 

  205. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    206. 

  206. <A NAME="navbar_bottom"><!-- --></A>
    207. 

  207. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    208. 

  208. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    209. 

  209. <TR>
    210. 

  210. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    211. 

  211. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    212. 

  212. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    213. 

  213.   <TR ALIGN="center" VALIGN="top">
    214. 

  214.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    215. 

  215.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    216. 

  216.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    217. 

  217.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DeepIndentRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    218. 

  218.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    219. 

  219.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    220. 

  220.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    221. 

  221.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    222. 

  222.   </TR>
    223. 

  223. </TABLE>
    224. 

  224. </TD>
    225. 

  225. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    226. 

  226. </EM>
    227. 

  227. </TD>
    228. 

  228. </TR>
    229. 

  229. 

  230. <TR>
    231. 

  231. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    232. 

  232. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/CloseBracketIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
    233. 

  233. &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>
    234. 

  234. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    235. 

  235.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/DeepIndentRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    236. 

  236. &nbsp;<A HREF="DeepIndentRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    237. 

  237. &nbsp;
    238. 

  238. <NOSCRIPT>
    239. 

  239.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    240. 

  240. </NOSCRIPT>
    241. 

  241. 

  242. 

  243. </FONT></TD>
    244. 

  244. </TR>
    245. 

  245. <TR>
    246. 

  246. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    247. 

  247.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    248. 

  248. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    249. 

  249. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    250. 

  250. </TR>
    251. 

  251. </TABLE>
    252. 

  252. <A NAME="skip-navbar_bottom"></A>
    253. 

  253. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    254. 

  254. 

  255. <HR>
    256. 

  256. 

  257. </BODY>
    258. 

  258. </HTML>
    259. 

  259.