PageRenderTime 63ms CodeModel.GetById 52ms app.highlight 7ms RepoModel.GetById 1ms 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
  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:02 GMT-08:00 2008 -->
  6<TITLE>
  7WhitespaceRule (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.indent.WhitespaceRule class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WhitespaceRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 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&nbsp;NEXT CLASS</FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/WhitespaceRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="WhitespaceRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 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<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.indent</FONT>
 78<BR>
 79Class WhitespaceRule</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.indent.WhitespaceRule</B>
 83</PRE>
 84<DL>
 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</DL>
 87<HR>
 88<DL>
 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</PRE>
 91
 92<P>
 93Whitespace rule. This rule cancels all indent actions in the
 94 following case:
 95
 96 <ul>
 97 <li>The previous line is all whitespace</li>
 98 <li>The current line is not empty</li>
 99 </ul>
100
101 <p>The result is that this rule won't allow the indentation to be
102 increased, only decreased (by rules triggered by unindentThisLine).
103 If the requirements above do not apply, this rule does nothing.</p>
104<P>
105
106<P>
107<DL>
108<DT><B>Since:</B></DT>
109  <DD>jEdit 4.3pre10</DD>
110</DL>
111<HR>
112
113<P>
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117<A NAME="constructor_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Constructor Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/indent/WhitespaceRule.html#WhitespaceRule()">WhitespaceRule</A></B>()</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ========== METHOD SUMMARY =========== -->
132
133<A NAME="method_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
137<B>Method Summary</B></FONT></TH>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;void</CODE></FONT></TD>
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      int&nbsp;thisLineIndex,
144      int&nbsp;prevLineIndex,
145      int&nbsp;prevPrevLineIndex,
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
148<BR>
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</TR>
151</TABLE>
152&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
155<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
159</TR>
160</TABLE>
161&nbsp;
162<P>
163
164<!-- ========= CONSTRUCTOR DETAIL ======== -->
165
166<A NAME="constructor_detail"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
170<B>Constructor Detail</B></FONT></TH>
171</TR>
172</TABLE>
173
174<A NAME="WhitespaceRule()"><!-- --></A><H3>
175WhitespaceRule</H3>
176<PRE>
177public <B>WhitespaceRule</B>()</PRE>
178<DL>
179</DL>
180
181<!-- ============ METHOD DETAIL ========== -->
182
183<A NAME="method_detail"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
187<B>Method Detail</B></FONT></TH>
188</TR>
189</TABLE>
190
191<A NAME="apply(org.gjt.sp.jedit.buffer.JEditBuffer, int, int, int, java.util.List)"><!-- --></A><H3>
192apply</H3>
193<PRE>
194public 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                  int&nbsp;thisLineIndex,
196                  int&nbsp;prevLineIndex,
197                  int&nbsp;prevPrevLineIndex,
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<DL>
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<DD>Apply the indent rule to this line, and return an indent action.
202<P>
203<DD><DL>
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</DD>
206<DD><DL>
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 (or -1 if there is no prior non empty line)<DD><CODE>prevPrevLineIndex</CODE> - the prior non empty line index before the prevLineIndex
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 it is necessary</DL>
211</DD>
212</DL>
213<!-- ========= END OF CLASS DATA ========= -->
214<HR>
215
216
217<!-- ======= START OF BOTTOM NAVBAR ====== -->
218<A NAME="navbar_bottom"><!-- --></A>
219<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
220<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
221<TR>
222<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
223<A NAME="navbar_bottom_firstrow"><!-- --></A>
224<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
225  <TR ALIGN="center" VALIGN="top">
226  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
227  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
228  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
229  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WhitespaceRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
230  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
231  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
232  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
233  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
234  </TR>
235</TABLE>
236</TD>
237<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
238</EM>
239</TD>
240</TR>
241
242<TR>
243<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
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&nbsp;NEXT CLASS</FONT></TD>
246<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
247  <A HREF="../../../../../index.html?org/gjt/sp/jedit/indent/WhitespaceRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
248&nbsp;<A HREF="WhitespaceRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
249&nbsp;
250<NOSCRIPT>
251  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
252</NOSCRIPT>
253
254
255</FONT></TD>
256</TR>
257<TR>
258<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
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<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
261DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
262</TR>
263</TABLE>
264<A NAME="skip-navbar_bottom"></A>
265<!-- ======== END OF BOTTOM NAVBAR ======= -->
266
267<HR>
268
269</BODY>
270</HTML>