PageRenderTime 35ms CodeModel.GetById 11ms app.highlight 16ms RepoModel.GetById 1ms app.codeStats 0ms

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

#
HTML | 627 lines | 544 code | 69 blank | 14 comment | 0 complexity | c8458bc0cc6a99a7ada0083a9be9a48d 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:13:46 GMT-08:00 2008 -->
  6<TITLE>
  7Mode (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.Mode 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/Mode.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/MiscUtilities.StringICaseCompare.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/OperatingSystem.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../index.html?org/gjt/sp/jedit/Mode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="Mode.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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</FONT>
 78<BR>
 79Class Mode</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.Mode</B>
 83</PRE>
 84<HR>
 85<DL>
 86<DT><PRE>public class <B>Mode</B><DT>extends java.lang.Object</DL>
 87</PRE>
 88
 89<P>
 90An edit mode defines specific settings for editing some type of file.
 91 One instance of this class is created for each supported edit mode.
 92<P>
 93
 94<P>
 95<HR>
 96
 97<P>
 98<!-- =========== FIELD SUMMARY =========== -->
 99
100<A NAME="field_summary"><!-- --></A>
101<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
102<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
103<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
104<B>Field Summary</B></FONT></TH>
105</TR>
106<TR BGCOLOR="white" CLASS="TableRowColor">
107<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
108<CODE>protected &nbsp;<A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A></CODE></FONT></TD>
109<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#marker">marker</A></B></CODE>
110
111<BR>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
116<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
117<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#name">name</A></B></CODE>
118
119<BR>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124<CODE>protected &nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;</CODE></FONT></TD>
125<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#props">props</A></B></CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ======== CONSTRUCTOR SUMMARY ======== -->
133
134<A NAME="constructor_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
138<B>Constructor Summary</B></FONT></TH>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#Mode(java.lang.String)">Mode</A></B>(java.lang.String&nbsp;name)</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new edit mode.</TD>
145</TR>
146</TABLE>
147&nbsp;
148<!-- ========== METHOD SUMMARY =========== -->
149
150<A NAME="method_summary"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
154<B>Method Summary</B></FONT></TH>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;boolean</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#accept(java.lang.String, java.lang.String)">accept</A></B>(java.lang.String&nbsp;fileName,
160       java.lang.String&nbsp;firstLine)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns if the edit mode is suitable for editing the specified
164 file.</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;boolean</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getBooleanProperty(java.lang.String)">getBooleanProperty</A></B>(java.lang.String&nbsp;key)</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of a boolean property.</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>&nbsp;boolean</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getIgnoreWhitespace()">getIgnoreWhitespace</A></B>()</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../org/gjt/sp/jedit/indent/IndentRule.html" title="interface in org.gjt.sp.jedit.indent">IndentRule</A>&gt;</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getIndentRules()">getIndentRules</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getName()">getName</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the internal name of this edit mode.</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String&nbsp;key)</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a mode property.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;<A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A></CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getTokenMarker()">getTokenMarker</A></B>()</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the token marker for this mode.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#init()">init</A></B>()</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the edit mode.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;boolean</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#isElectricKey(char)">isElectricKey</A></B>(char&nbsp;ch)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#loadIfNecessary()">loadIfNecessary</A></B>()</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the mode from disk if it hasn't been loaded already.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#setProperties(java.util.Map)">setProperties</A></B>(java.util.Map&nbsp;props)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should only be called by <code>XModeHandler</code>.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String&nbsp;key,
250            java.lang.Object&nbsp;value)</CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a mode property.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;void</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#setTokenMarker(org.gjt.sp.jedit.syntax.TokenMarker)">setTokenMarker</A></B>(<A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A>&nbsp;marker)</CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the token marker for this mode.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#toString()">toString</A></B>()</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this edit mode.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;void</CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#unsetProperty(java.lang.String)">unsetProperty</A></B>(java.lang.String&nbsp;key)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unsets a mode property.</TD>
278</TR>
279</TABLE>
280&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
281<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
282<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
283<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
287</TR>
288</TABLE>
289&nbsp;
290<P>
291
292<!-- ============ FIELD DETAIL =========== -->
293
294<A NAME="field_detail"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
297<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
298<B>Field Detail</B></FONT></TH>
299</TR>
300</TABLE>
301
302<A NAME="name"><!-- --></A><H3>
303name</H3>
304<PRE>
305protected java.lang.String <B>name</B></PRE>
306<DL>
307<DL>
308</DL>
309</DL>
310<HR>
311
312<A NAME="props"><!-- --></A><H3>
313props</H3>
314<PRE>
315protected java.util.Map&lt;java.lang.String,java.lang.Object&gt; <B>props</B></PRE>
316<DL>
317<DL>
318</DL>
319</DL>
320<HR>
321
322<A NAME="marker"><!-- --></A><H3>
323marker</H3>
324<PRE>
325protected <A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A> <B>marker</B></PRE>
326<DL>
327<DL>
328</DL>
329</DL>
330
331<!-- ========= CONSTRUCTOR DETAIL ======== -->
332
333<A NAME="constructor_detail"><!-- --></A>
334<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
335<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
336<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
337<B>Constructor Detail</B></FONT></TH>
338</TR>
339</TABLE>
340
341<A NAME="Mode(java.lang.String)"><!-- --></A><H3>
342Mode</H3>
343<PRE>
344public <B>Mode</B>(java.lang.String&nbsp;name)</PRE>
345<DL>
346<DD>Creates a new edit mode.
347<P>
348<DL>
349<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name used in mode listings and to query mode
350 properties<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getProperty(java.lang.String)"><CODE>getProperty(String)</CODE></A></DL>
351</DL>
352
353<!-- ============ METHOD DETAIL ========== -->
354
355<A NAME="method_detail"><!-- --></A>
356<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
357<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
358<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
359<B>Method Detail</B></FONT></TH>
360</TR>
361</TABLE>
362
363<A NAME="init()"><!-- --></A><H3>
364init</H3>
365<PRE>
366public void <B>init</B>()</PRE>
367<DL>
368<DD>Initializes the edit mode. Should be called after all properties
369 are loaded and set.
370<P>
371<DD><DL>
372</DL>
373</DD>
374</DL>
375<HR>
376
377<A NAME="getTokenMarker()"><!-- --></A><H3>
378getTokenMarker</H3>
379<PRE>
380public <A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A> <B>getTokenMarker</B>()</PRE>
381<DL>
382<DD>Returns the token marker for this mode.
383<P>
384<DD><DL>
385</DL>
386</DD>
387</DL>
388<HR>
389
390<A NAME="setTokenMarker(org.gjt.sp.jedit.syntax.TokenMarker)"><!-- --></A><H3>
391setTokenMarker</H3>
392<PRE>
393public void <B>setTokenMarker</B>(<A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A>&nbsp;marker)</PRE>
394<DL>
395<DD>Sets the token marker for this mode.
396<P>
397<DD><DL>
398<DT><B>Parameters:</B><DD><CODE>marker</CODE> - The new token marker</DL>
399</DD>
400</DL>
401<HR>
402
403<A NAME="loadIfNecessary()"><!-- --></A><H3>
404loadIfNecessary</H3>
405<PRE>
406public void <B>loadIfNecessary</B>()</PRE>
407<DL>
408<DD>Loads the mode from disk if it hasn't been loaded already.
409<P>
410<DD><DL>
411<DT><B>Since:</B></DT>
412  <DD>jEdit 2.5pre3</DD>
413</DL>
414</DD>
415</DL>
416<HR>
417
418<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
419getProperty</H3>
420<PRE>
421public java.lang.Object <B>getProperty</B>(java.lang.String&nbsp;key)</PRE>
422<DL>
423<DD>Returns a mode property.
424<P>
425<DD><DL>
426<DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
427  <DD>jEdit 2.2pre1</DD>
428</DL>
429</DD>
430</DL>
431<HR>
432
433<A NAME="getBooleanProperty(java.lang.String)"><!-- --></A><H3>
434getBooleanProperty</H3>
435<PRE>
436public boolean <B>getBooleanProperty</B>(java.lang.String&nbsp;key)</PRE>
437<DL>
438<DD>Returns the value of a boolean property.
439<P>
440<DD><DL>
441<DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
442  <DD>jEdit 2.5pre3</DD>
443</DL>
444</DD>
445</DL>
446<HR>
447
448<A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>
449setProperty</H3>
450<PRE>
451public void <B>setProperty</B>(java.lang.String&nbsp;key,
452                        java.lang.Object&nbsp;value)</PRE>
453<DL>
454<DD>Sets a mode property.
455<P>
456<DD><DL>
457<DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DD><CODE>value</CODE> - The property value</DL>
458</DD>
459</DL>
460<HR>
461
462<A NAME="unsetProperty(java.lang.String)"><!-- --></A><H3>
463unsetProperty</H3>
464<PRE>
465public void <B>unsetProperty</B>(java.lang.String&nbsp;key)</PRE>
466<DL>
467<DD>Unsets a mode property.
468<P>
469<DD><DL>
470<DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
471  <DD>jEdit 3.2pre3</DD>
472</DL>
473</DD>
474</DL>
475<HR>
476
477<A NAME="setProperties(java.util.Map)"><!-- --></A><H3>
478setProperties</H3>
479<PRE>
480public void <B>setProperties</B>(java.util.Map&nbsp;props)</PRE>
481<DL>
482<DD>Should only be called by <code>XModeHandler</code>.
483<P>
484<DD><DL>
485<DT><B>Since:</B></DT>
486  <DD>jEdit 4.0pre3</DD>
487</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="accept(java.lang.String, java.lang.String)"><!-- --></A><H3>
493accept</H3>
494<PRE>
495public boolean <B>accept</B>(java.lang.String&nbsp;fileName,
496                      java.lang.String&nbsp;firstLine)</PRE>
497<DL>
498<DD>Returns if the edit mode is suitable for editing the specified
499 file. The buffer name and first line is checked against the
500 file name and first line globs, respectively.
501<P>
502<DD><DL>
503<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The buffer's name<DD><CODE>firstLine</CODE> - The first line of the buffer<DT><B>Since:</B></DT>
504  <DD>jEdit 3.2pre3</DD>
505</DL>
506</DD>
507</DL>
508<HR>
509
510<A NAME="getName()"><!-- --></A><H3>
511getName</H3>
512<PRE>
513public java.lang.String <B>getName</B>()</PRE>
514<DL>
515<DD>Returns the internal name of this edit mode.
516<P>
517<DD><DL>
518</DL>
519</DD>
520</DL>
521<HR>
522
523<A NAME="toString()"><!-- --></A><H3>
524toString</H3>
525<PRE>
526public java.lang.String <B>toString</B>()</PRE>
527<DL>
528<DD>Returns a string representation of this edit mode.
529<P>
530<DD><DL>
531<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
532</DD>
533<DD><DL>
534</DL>
535</DD>
536</DL>
537<HR>
538
539<A NAME="getIgnoreWhitespace()"><!-- --></A><H3>
540getIgnoreWhitespace</H3>
541<PRE>
542public boolean <B>getIgnoreWhitespace</B>()</PRE>
543<DL>
544<DD><DL>
545</DL>
546</DD>
547</DL>
548<HR>
549
550<A NAME="getIndentRules()"><!-- --></A><H3>
551getIndentRules</H3>
552<PRE>
553public java.util.List&lt;<A HREF="../../../../org/gjt/sp/jedit/indent/IndentRule.html" title="interface in org.gjt.sp.jedit.indent">IndentRule</A>&gt; <B>getIndentRules</B>()</PRE>
554<DL>
555<DD><DL>
556</DL>
557</DD>
558</DL>
559<HR>
560
561<A NAME="isElectricKey(char)"><!-- --></A><H3>
562isElectricKey</H3>
563<PRE>
564public boolean <B>isElectricKey</B>(char&nbsp;ch)</PRE>
565<DL>
566<DD><DL>
567</DL>
568</DD>
569</DL>
570<!-- ========= END OF CLASS DATA ========= -->
571<HR>
572
573
574<!-- ======= START OF BOTTOM NAVBAR ====== -->
575<A NAME="navbar_bottom"><!-- --></A>
576<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
577<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
578<TR>
579<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
580<A NAME="navbar_bottom_firstrow"><!-- --></A>
581<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
582  <TR ALIGN="center" VALIGN="top">
583  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
584  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
585  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
586  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Mode.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
587  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
588  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
589  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
590  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
591  </TR>
592</TABLE>
593</TD>
594<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
595</EM>
596</TD>
597</TR>
598
599<TR>
600<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
601&nbsp;<A HREF="../../../../org/gjt/sp/jedit/MiscUtilities.StringICaseCompare.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
602&nbsp;<A HREF="../../../../org/gjt/sp/jedit/OperatingSystem.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
603<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
604  <A HREF="../../../../index.html?org/gjt/sp/jedit/Mode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
605&nbsp;<A HREF="Mode.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
606&nbsp;
607<NOSCRIPT>
608  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
609</NOSCRIPT>
610
611
612</FONT></TD>
613</TR>
614<TR>
615<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
616  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
617<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
618DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
619</TR>
620</TABLE>
621<A NAME="skip-navbar_bottom"></A>
622<!-- ======== END OF BOTTOM NAVBAR ======= -->
623
624<HR>
625
626</BODY>
627</HTML>