PageRenderTime 59ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 270 lines | 223 code | 35 blank | 12 comment | 0 complexity | 5d96e74bafd169b7952502a07a24011f 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:02 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. WhitespaceRule (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.indent.WhitespaceRule 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/WhitespaceRule.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/RegexpIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &nbsp;NEXT CLASS</FONT></TD>
    52. 

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

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

  54. &nbsp;<A HREF="WhitespaceRule.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 WhitespaceRule</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.WhitespaceRule</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>WhitespaceRule</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. Whitespace rule. This rule cancels all indent actions in the
    94. 

  94.  following case:
    95. 

  95. 

  96.  <ul>
    97. 

  97.  <li>The previous line is all whitespace</li>
    98. 

  98.  <li>The current line is not empty</li>
    99. 

  99.  </ul>
    100. 

  100. 

  101.  <p>The result is that this rule won't allow the indentation to be
    102. 

  102.  increased, only decreased (by rules triggered by unindentThisLine).
    103. 

  103.  If the requirements above do not apply, this rule does nothing.</p>
    104. 

  104. <P>
    105. 

  105. 

  106. <P>
    107. 

  107. <DL>
    108. 

  108. <DT><B>Since:</B></DT>
    109. 

  109.   <DD>jEdit 4.3pre10</DD>
    110. 

  110. </DL>
    111. 

  111. <HR>
    112. 

  112. 

  113. <P>
    114. 

  114. 

  115. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    116. 

  116. 

  117. <A NAME="constructor_summary"><!-- --></A>
    118. 

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

  119. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    120. 

  120. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    121. 

  121. <B>Constructor Summary</B></FONT></TH>
    122. 

  122. </TR>
    123. 

  123. <TR BGCOLOR="white" CLASS="TableRowColor">
    124. 

  124. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/WhitespaceRule.html#WhitespaceRule()">WhitespaceRule</A></B>()</CODE>
    125. 

  125. 

  126. <BR>
    127. 

  127. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    128. 

  128. </TR>
    129. 

  129. </TABLE>
    130. 

  130. &nbsp;
    131. 

  131. <!-- ========== METHOD SUMMARY =========== -->
    132. 

  132. 

  133. <A NAME="method_summary"><!-- --></A>
    134. 

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

  135. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    136. 

  136. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    137. 

  137. <B>Method Summary</B></FONT></TH>
    138. 

  138. </TR>
    139. 

  139. <TR BGCOLOR="white" CLASS="TableRowColor">
    140. 

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

  141. <CODE>&nbsp;void</CODE></FONT></TD>
    142. 

  142. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/WhitespaceRule.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,
    143. 

  143.       int&nbsp;thisLineIndex,
    144. 

  144.       int&nbsp;prevLineIndex,
    145. 

  145.       int&nbsp;prevPrevLineIndex,
    146. 

  146.       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>
    147. 

  147. 

  148. <BR>
    149. 

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

  150. </TR>
    151. 

  151. </TABLE>
    152. 

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

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

  154. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    155. 

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

  156. </TR>
    157. 

  157. <TR BGCOLOR="white" CLASS="TableRowColor">
    158. 

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

  159. </TR>
    160. 

  160. </TABLE>
    161. 

  161. &nbsp;
    162. 

  162. <P>
    163. 

  163. 

  164. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    165. 

  165. 

  166. <A NAME="constructor_detail"><!-- --></A>
    167. 

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

  168. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    169. 

  169. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    170. 

  170. <B>Constructor Detail</B></FONT></TH>
    171. 

  171. </TR>
    172. 

  172. </TABLE>
    173. 

  173. 

  174. <A NAME="WhitespaceRule()"><!-- --></A><H3>
    175. 

  175. WhitespaceRule</H3>
    176. 

  176. <PRE>
    177. 

  177. public <B>WhitespaceRule</B>()</PRE>
    178. 

  178. <DL>
    179. 

  179. </DL>
    180. 

  180. 

  181. <!-- ============ METHOD DETAIL ========== -->
    182. 

  182. 

  183. <A NAME="method_detail"><!-- --></A>
    184. 

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

  185. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    186. 

  186. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    187. 

  187. <B>Method Detail</B></FONT></TH>
    188. 

  188. </TR>
    189. 

  189. </TABLE>
    190. 

  190. 

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

  192. apply</H3>
    193. 

  193. <PRE>
    194. 

  194. 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,
    195. 

  195.                   int&nbsp;thisLineIndex,
    196. 

  196.                   int&nbsp;prevLineIndex,
    197. 

  197.                   int&nbsp;prevPrevLineIndex,
    198. 

  198.                   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>
    199. 

  199. <DL>
    200. 

  200. <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>
    201. 

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

  202. <P>
    203. 

  203. <DD><DL>
    204. 

  204. <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>
    205. 

  205. </DD>
    206. 

  206. <DD><DL>
    207. 

  207. <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
    208. 

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

  209.  (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
    210. 

  210.  it is necessary</DL>
    211. 

  211. </DD>
    212. 

  212. </DL>
    213. 

  213. <!-- ========= END OF CLASS DATA ========= -->
    214. 

  214. <HR>
    215. 

  215. 

  216. 

  217. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    218. 

  218. <A NAME="navbar_bottom"><!-- --></A>
    219. 

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

  220. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    221. 

  221. <TR>
    222. 

  222. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    223. 

  223. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    224. 

  224. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    225. 

  225.   <TR ALIGN="center" VALIGN="top">
    226. 

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

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

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

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

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

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

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

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

  234.   </TR>
    235. 

  235. </TABLE>
    236. 

  236. </TD>
    237. 

  237. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    238. 

  238. </EM>
    239. 

  239. </TD>
    240. 

  240. </TR>
    241. 

  241. 

  242. <TR>
    243. 

  243. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    244. 

  244. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/indent/RegexpIndentRule.html" title="class in org.gjt.sp.jedit.indent"><B>PREV CLASS</B></A>&nbsp;
    245. 

  245. &nbsp;NEXT CLASS</FONT></TD>
    246. 

  246. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    247. 

  247.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/WhitespaceRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    248. 

  248. &nbsp;<A HREF="WhitespaceRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    249. 

  249. &nbsp;
    250. 

  250. <NOSCRIPT>
    251. 

  251.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    252. 

  252. </NOSCRIPT>
    253. 

  253. 

  254. 

  255. </FONT></TD>
    256. 

  256. </TR>
    257. 

  257. <TR>
    258. 

  258. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    259. 

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

  260. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    261. 

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

  262. </TR>
    263. 

  263. </TABLE>
    264. 

  264. <A NAME="skip-navbar_bottom"></A>
    265. 

  265. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    266. 

  266. 

  267. <HR>
    268. 

  268. 

  269. </BODY>
    270. 

  270. </HTML>
    271. 

  271.