PageRenderTime 45ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

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

#
HTML | 285 lines | 241 code | 32 blank | 12 comment | 0 complexity | e98cfba65ce157c32fb26c538f3a973a 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. IndentAction.Collapse (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.indent.IndentAction.Collapse 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/IndentAction.Collapse.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/IndentAction.AlignParameter.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.Decrease.html" title="class 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/IndentAction.Collapse.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="IndentAction.Collapse.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.indent</FONT>
  66. <BR>
  67. Class IndentAction.Collapse</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.indent.IndentAction.Collapse</B>
  71. </PRE>
  72. <DL>
  73. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></DD>
  74. </DL>
  75. <DL>
  76. <DT><B>Enclosing interface:</B><DD><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></DD>
  77. </DL>
  78. <HR>
  79. <DL>
  80. <DT><PRE>public static class <B>IndentAction.Collapse</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></DL>
  81. </PRE>
  82. <P>
  83. See comments for each instance of this class below.
  84. <P>
  85. <P>
  86. <HR>
  87. <P>
  88. <!-- ======== NESTED CLASS SUMMARY ======== -->
  89. <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
  94. </TR>
  95. </TABLE>
  96. &nbsp;<A NAME="nested_classes_inherited_from_class_org.gjt.sp.jedit.indent.IndentAction"><!-- --></A>
  97. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  98. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  99. <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.gjt.sp.jedit.indent.<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></B></TH>
  100. </TR>
  101. <TR BGCOLOR="white" CLASS="TableRowColor">
  102. <TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.AlignOffset.html" title="class in org.gjt.sp.jedit.indent">IndentAction.AlignOffset</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.AlignParameter.html" title="class in org.gjt.sp.jedit.indent">IndentAction.AlignParameter</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Collapse.html" title="class in org.gjt.sp.jedit.indent">IndentAction.Collapse</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Decrease.html" title="class in org.gjt.sp.jedit.indent">IndentAction.Decrease</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Increase.html" title="class in org.gjt.sp.jedit.indent">IndentAction.Increase</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.NoIncrease.html" title="class in org.gjt.sp.jedit.indent">IndentAction.NoIncrease</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Reset.html" title="class in org.gjt.sp.jedit.indent">IndentAction.Reset</A></CODE></TD>
  103. </TR>
  104. </TABLE>
  105. &nbsp;
  106. <!-- =========== FIELD SUMMARY =========== -->
  107. <A NAME="field_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>Field Summary</B></FONT></TH>
  112. </TR>
  113. </TABLE>
  114. &nbsp;<A NAME="fields_inherited_from_class_org.gjt.sp.jedit.indent.IndentAction"><!-- --></A>
  115. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  116. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  117. <TH ALIGN="left"><B>Fields inherited from interface org.gjt.sp.jedit.indent.<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></B></TH>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html#PrevCollapse">PrevCollapse</A>, <A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html#PrevPrevCollapse">PrevPrevCollapse</A></CODE></TD>
  121. </TR>
  122. </TABLE>
  123. &nbsp;
  124. <!-- ========== METHOD SUMMARY =========== -->
  125. <A NAME="method_summary"><!-- --></A>
  126. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  127. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  128. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  129. <B>Method Summary</B></FONT></TH>
  130. </TR>
  131. <TR BGCOLOR="white" CLASS="TableRowColor">
  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  133. <CODE>&nbsp;int</CODE></FONT></TD>
  134. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Collapse.html#calculateIndent(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int)">calculateIndent</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
  135. int&nbsp;line,
  136. int&nbsp;oldIndent,
  137. int&nbsp;newIndent)</CODE>
  138. <BR>
  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This does nothing; it is merely a sentinel for the
  140. <code>OpenBracketIndentRule</code>.</TD>
  141. </TR>
  142. <TR BGCOLOR="white" CLASS="TableRowColor">
  143. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  144. <CODE>&nbsp;boolean</CODE></FONT></TD>
  145. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Collapse.html#keepChecking()">keepChecking</A></B>()</CODE>
  146. <BR>
  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  148. </TR>
  149. </TABLE>
  150. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  151. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  152. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  153. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  154. </TR>
  155. <TR BGCOLOR="white" CLASS="TableRowColor">
  156. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  157. </TR>
  158. </TABLE>
  159. &nbsp;
  160. <P>
  161. <!-- ============ METHOD DETAIL ========== -->
  162. <A NAME="method_detail"><!-- --></A>
  163. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  164. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  165. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  166. <B>Method Detail</B></FONT></TH>
  167. </TR>
  168. </TABLE>
  169. <A NAME="calculateIndent(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int)"><!-- --></A><H3>
  170. calculateIndent</H3>
  171. <PRE>
  172. public int <B>calculateIndent</B>(<A HREF="../../../../../org/gjt/sp/jedit/buffer/JEditBuffer.html" title="class in org.gjt.sp.jedit.buffer">JEditBuffer</A>&nbsp;buffer,
  173. int&nbsp;line,
  174. int&nbsp;oldIndent,
  175. int&nbsp;newIndent)</PRE>
  176. <DL>
  177. <DD>This does nothing; it is merely a sentinel for the
  178. <code>OpenBracketIndentRule</code>.
  179. <P>
  180. <DD><DL>
  181. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html#calculateIndent(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int)">calculateIndent</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></CODE></DL>
  182. </DD>
  183. <DD><DL>
  184. <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The buffer<DD><CODE>line</CODE> - The line number that matched the rule; not necessarily
  185. the line being indented.<DD><CODE>oldIndent</CODE> - Original indent.<DD><CODE>newIndent</CODE> - The new indent -- ie, indent returned by previous
  186. indent action.</DL>
  187. </DD>
  188. </DL>
  189. <HR>
  190. <A NAME="keepChecking()"><!-- --></A><H3>
  191. keepChecking</H3>
  192. <PRE>
  193. public boolean <B>keepChecking</B>()</PRE>
  194. <DL>
  195. <DD><DL>
  196. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html#keepChecking()">keepChecking</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.html" title="interface in org.gjt.sp.jedit.indent">IndentAction</A></CODE></DL>
  197. </DD>
  198. <DD><DL>
  199. <DT><B>Returns:</B><DD>true if the indent engine should keep processing after
  200. this rule.</DL>
  201. </DD>
  202. </DL>
  203. <!-- ========= END OF CLASS DATA ========= -->
  204. <HR>
  205. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  206. <A NAME="navbar_bottom"><!-- --></A>
  207. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  208. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  209. <TR>
  210. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  211. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  212. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  213. <TR ALIGN="center" VALIGN="top">
  214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  215. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  216. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  217. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IndentAction.Collapse.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  218. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  219. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  220. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  221. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  222. </TR>
  223. </TABLE>
  224. </TD>
  225. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  226. </EM>
  227. </TD>
  228. </TR>
  229. <TR>
  230. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  231. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.AlignParameter.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
  232. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/IndentAction.Decrease.html" title="class in org.gjt.sp.jedit.indent"><B>NEXT CLASS</B></A></FONT></TD>
  233. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  234. <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/IndentAction.Collapse.html" target="_top"><B>FRAMES</B></A> &nbsp;
  235. &nbsp;<A HREF="IndentAction.Collapse.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  236. &nbsp;
  237. <NOSCRIPT>
  238. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  239. </NOSCRIPT>
  240. </FONT></TD>
  241. </TR>
  242. <TR>
  243. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  244. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  245. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  246. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  247. </TR>
  248. </TABLE>
  249. <A NAME="skip-navbar_bottom"></A>
  250. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  251. <HR>
  252. </BODY>
  253. </HTML>