PageRenderTime 51ms CodeModel.GetById 25ms RepoModel.GetById 0ms 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
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:13:46 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. Mode (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

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

  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. 

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

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

  54. &nbsp;<A HREF="Mode.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;<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. 

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

  67. DETAIL:&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. 

  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</FONT>
    78. 

  78. <BR>
    79. 

  79. Class Mode</H2>
    80. 

  80. <PRE>
    81. 

  81. java.lang.Object
    82. 

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

  83. </PRE>
    84. 

  84. <HR>
    85. 

  85. <DL>
    86. 

  86. <DT><PRE>public class <B>Mode</B><DT>extends java.lang.Object</DL>
    87. 

  87. </PRE>
    88. 

  88. 

  89. <P>
    90. 

  90. An edit mode defines specific settings for editing some type of file.
    91. 

  91.  One instance of this class is created for each supported edit mode.
    92. 

  92. <P>
    93. 

  93. 

  94. <P>
    95. 

  95. <HR>
    96. 

  96. 

  97. <P>
    98. 

  98. <!-- =========== FIELD SUMMARY =========== -->
    99. 

  99. 

  100. <A NAME="field_summary"><!-- --></A>
    101. 

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

  102. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    103. 

  103. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    104. 

  104. <B>Field Summary</B></FONT></TH>
    105. 

  105. </TR>
    106. 

  106. <TR BGCOLOR="white" CLASS="TableRowColor">
    107. 

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

  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. 

  109. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#marker">marker</A></B></CODE>
    110. 

  110. 

  111. <BR>
    112. 

  112. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    113. 

  113. </TR>
    114. 

  114. <TR BGCOLOR="white" CLASS="TableRowColor">
    115. 

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

  116. <CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
    117. 

  117. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#name">name</A></B></CODE>
    118. 

  118. 

  119. <BR>
    120. 

  120. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    121. 

  121. </TR>
    122. 

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

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

  124. <CODE>protected &nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;</CODE></FONT></TD>
    125. 

  125. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#props">props</A></B></CODE>
    126. 

  126. 

  127. <BR>
    128. 

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

  129. </TR>
    130. 

  130. </TABLE>
    131. 

  131. &nbsp;
    132. 

  132. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    133. 

  133. 

  134. <A NAME="constructor_summary"><!-- --></A>
    135. 

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

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

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

  138. <B>Constructor Summary</B></FONT></TH>
    139. 

  139. </TR>
    140. 

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

  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. 

  142. 

  143. <BR>
    144. 

  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new edit mode.</TD>
    145. 

  145. </TR>
    146. 

  146. </TABLE>
    147. 

  147. &nbsp;
    148. 

  148. <!-- ========== METHOD SUMMARY =========== -->
    149. 

  149. 

  150. <A NAME="method_summary"><!-- --></A>
    151. 

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

  152. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    153. 

  153. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    154. 

  154. <B>Method Summary</B></FONT></TH>
    155. 

  155. </TR>
    156. 

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

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

  158. <CODE>&nbsp;boolean</CODE></FONT></TD>
    159. 

  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. 

  160.        java.lang.String&nbsp;firstLine)</CODE>
    161. 

  161. 

  162. <BR>
    163. 

  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns if the edit mode is suitable for editing the specified
    164. 

  164.  file.</TD>
    165. 

  165. </TR>
    166. 

  166. <TR BGCOLOR="white" CLASS="TableRowColor">
    167. 

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

  168. <CODE>&nbsp;boolean</CODE></FONT></TD>
    169. 

  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. 

  170. 

  171. <BR>
    172. 

  172. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of a boolean property.</TD>
    173. 

  173. </TR>
    174. 

  174. <TR BGCOLOR="white" CLASS="TableRowColor">
    175. 

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

  176. <CODE>&nbsp;boolean</CODE></FONT></TD>
    177. 

  177. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getIgnoreWhitespace()">getIgnoreWhitespace</A></B>()</CODE>
    178. 

  178. 

  179. <BR>
    180. 

  180. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    181. 

  181. </TR>
    182. 

  182. <TR BGCOLOR="white" CLASS="TableRowColor">
    183. 

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

  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. 

  185. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getIndentRules()">getIndentRules</A></B>()</CODE>
    186. 

  186. 

  187. <BR>
    188. 

  188. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    189. 

  189. </TR>
    190. 

  190. <TR BGCOLOR="white" CLASS="TableRowColor">
    191. 

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

  192. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
    193. 

  193. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getName()">getName</A></B>()</CODE>
    194. 

  194. 

  195. <BR>
    196. 

  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the internal name of this edit mode.</TD>
    197. 

  197. </TR>
    198. 

  198. <TR BGCOLOR="white" CLASS="TableRowColor">
    199. 

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

  200. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
    201. 

  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. 

  202. 

  203. <BR>
    204. 

  204. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a mode property.</TD>
    205. 

  205. </TR>
    206. 

  206. <TR BGCOLOR="white" CLASS="TableRowColor">
    207. 

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

  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. 

  209. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#getTokenMarker()">getTokenMarker</A></B>()</CODE>
    210. 

  210. 

  211. <BR>
    212. 

  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the token marker for this mode.</TD>
    213. 

  213. </TR>
    214. 

  214. <TR BGCOLOR="white" CLASS="TableRowColor">
    215. 

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

  216. <CODE>&nbsp;void</CODE></FONT></TD>
    217. 

  217. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#init()">init</A></B>()</CODE>
    218. 

  218. 

  219. <BR>
    220. 

  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the edit mode.</TD>
    221. 

  221. </TR>
    222. 

  222. <TR BGCOLOR="white" CLASS="TableRowColor">
    223. 

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

  224. <CODE>&nbsp;boolean</CODE></FONT></TD>
    225. 

  225. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#isElectricKey(char)">isElectricKey</A></B>(char&nbsp;ch)</CODE>
    226. 

  226. 

  227. <BR>
    228. 

  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    229. 

  229. </TR>
    230. 

  230. <TR BGCOLOR="white" CLASS="TableRowColor">
    231. 

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

  232. <CODE>&nbsp;void</CODE></FONT></TD>
    233. 

  233. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#loadIfNecessary()">loadIfNecessary</A></B>()</CODE>
    234. 

  234. 

  235. <BR>
    236. 

  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. 

  237. </TR>
    238. 

  238. <TR BGCOLOR="white" CLASS="TableRowColor">
    239. 

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

  240. <CODE>&nbsp;void</CODE></FONT></TD>
    241. 

  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. 

  242. 

  243. <BR>
    244. 

  244. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should only be called by <code>XModeHandler</code>.</TD>
    245. 

  245. </TR>
    246. 

  246. <TR BGCOLOR="white" CLASS="TableRowColor">
    247. 

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

  248. <CODE>&nbsp;void</CODE></FONT></TD>
    249. 

  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. 

  250.             java.lang.Object&nbsp;value)</CODE>
    251. 

  251. 

  252. <BR>
    253. 

  253. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a mode property.</TD>
    254. 

  254. </TR>
    255. 

  255. <TR BGCOLOR="white" CLASS="TableRowColor">
    256. 

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

  257. <CODE>&nbsp;void</CODE></FONT></TD>
    258. 

  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. 

  259. 

  260. <BR>
    261. 

  261. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the token marker for this mode.</TD>
    262. 

  262. </TR>
    263. 

  263. <TR BGCOLOR="white" CLASS="TableRowColor">
    264. 

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

  265. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
    266. 

  266. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Mode.html#toString()">toString</A></B>()</CODE>
    267. 

  267. 

  268. <BR>
    269. 

  269. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this edit mode.</TD>
    270. 

  270. </TR>
    271. 

  271. <TR BGCOLOR="white" CLASS="TableRowColor">
    272. 

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

  273. <CODE>&nbsp;void</CODE></FONT></TD>
    274. 

  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. 

  275. 

  276. <BR>
    277. 

  277. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unsets a mode property.</TD>
    278. 

  278. </TR>
    279. 

  279. </TABLE>
    280. 

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

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

  282. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    283. 

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

  284. </TR>
    285. 

  285. <TR BGCOLOR="white" CLASS="TableRowColor">
    286. 

  286. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
    287. 

  287. </TR>
    288. 

  288. </TABLE>
    289. 

  289. &nbsp;
    290. 

  290. <P>
    291. 

  291. 

  292. <!-- ============ FIELD DETAIL =========== -->
    293. 

  293. 

  294. <A NAME="field_detail"><!-- --></A>
    295. 

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

  296. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    297. 

  297. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    298. 

  298. <B>Field Detail</B></FONT></TH>
    299. 

  299. </TR>
    300. 

  300. </TABLE>
    301. 

  301. 

  302. <A NAME="name"><!-- --></A><H3>
    303. 

  303. name</H3>
    304. 

  304. <PRE>
    305. 

  305. protected java.lang.String <B>name</B></PRE>
    306. 

  306. <DL>
    307. 

  307. <DL>
    308. 

  308. </DL>
    309. 

  309. </DL>
    310. 

  310. <HR>
    311. 

  311. 

  312. <A NAME="props"><!-- --></A><H3>
    313. 

  313. props</H3>
    314. 

  314. <PRE>
    315. 

  315. protected java.util.Map&lt;java.lang.String,java.lang.Object&gt; <B>props</B></PRE>
    316. 

  316. <DL>
    317. 

  317. <DL>
    318. 

  318. </DL>
    319. 

  319. </DL>
    320. 

  320. <HR>
    321. 

  321. 

  322. <A NAME="marker"><!-- --></A><H3>
    323. 

  323. marker</H3>
    324. 

  324. <PRE>
    325. 

  325. protected <A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A> <B>marker</B></PRE>
    326. 

  326. <DL>
    327. 

  327. <DL>
    328. 

  328. </DL>
    329. 

  329. </DL>
    330. 

  330. 

  331. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    332. 

  332. 

  333. <A NAME="constructor_detail"><!-- --></A>
    334. 

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

  335. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    336. 

  336. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    337. 

  337. <B>Constructor Detail</B></FONT></TH>
    338. 

  338. </TR>
    339. 

  339. </TABLE>
    340. 

  340. 

  341. <A NAME="Mode(java.lang.String)"><!-- --></A><H3>
    342. 

  342. Mode</H3>
    343. 

  343. <PRE>
    344. 

  344. public <B>Mode</B>(java.lang.String&nbsp;name)</PRE>
    345. 

  345. <DL>
    346. 

  346. <DD>Creates a new edit mode.
    347. 

  347. <P>
    348. 

  348. <DL>
    349. 

  349. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name used in mode listings and to query mode
    350. 

  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. 

  351. </DL>
    352. 

  352. 

  353. <!-- ============ METHOD DETAIL ========== -->
    354. 

  354. 

  355. <A NAME="method_detail"><!-- --></A>
    356. 

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

  357. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    358. 

  358. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    359. 

  359. <B>Method Detail</B></FONT></TH>
    360. 

  360. </TR>
    361. 

  361. </TABLE>
    362. 

  362. 

  363. <A NAME="init()"><!-- --></A><H3>
    364. 

  364. init</H3>
    365. 

  365. <PRE>
    366. 

  366. public void <B>init</B>()</PRE>
    367. 

  367. <DL>
    368. 

  368. <DD>Initializes the edit mode. Should be called after all properties
    369. 

  369.  are loaded and set.
    370. 

  370. <P>
    371. 

  371. <DD><DL>
    372. 

  372. </DL>
    373. 

  373. </DD>
    374. 

  374. </DL>
    375. 

  375. <HR>
    376. 

  376. 

  377. <A NAME="getTokenMarker()"><!-- --></A><H3>
    378. 

  378. getTokenMarker</H3>
    379. 

  379. <PRE>
    380. 

  380. public <A HREF="../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A> <B>getTokenMarker</B>()</PRE>
    381. 

  381. <DL>
    382. 

  382. <DD>Returns the token marker for this mode.
    383. 

  383. <P>
    384. 

  384. <DD><DL>
    385. 

  385. </DL>
    386. 

  386. </DD>
    387. 

  387. </DL>
    388. 

  388. <HR>
    389. 

  389. 

  390. <A NAME="setTokenMarker(org.gjt.sp.jedit.syntax.TokenMarker)"><!-- --></A><H3>
    391. 

  391. setTokenMarker</H3>
    392. 

  392. <PRE>
    393. 

  393. public 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. 

  394. <DL>
    395. 

  395. <DD>Sets the token marker for this mode.
    396. 

  396. <P>
    397. 

  397. <DD><DL>
    398. 

  398. <DT><B>Parameters:</B><DD><CODE>marker</CODE> - The new token marker</DL>
    399. 

  399. </DD>
    400. 

  400. </DL>
    401. 

  401. <HR>
    402. 

  402. 

  403. <A NAME="loadIfNecessary()"><!-- --></A><H3>
    404. 

  404. loadIfNecessary</H3>
    405. 

  405. <PRE>
    406. 

  406. public void <B>loadIfNecessary</B>()</PRE>
    407. 

  407. <DL>
    408. 

  408. <DD>Loads the mode from disk if it hasn't been loaded already.
    409. 

  409. <P>
    410. 

  410. <DD><DL>
    411. 

  411. <DT><B>Since:</B></DT>
    412. 

  412.   <DD>jEdit 2.5pre3</DD>
    413. 

  413. </DL>
    414. 

  414. </DD>
    415. 

  415. </DL>
    416. 

  416. <HR>
    417. 

  417. 

  418. <A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
    419. 

  419. getProperty</H3>
    420. 

  420. <PRE>
    421. 

  421. public java.lang.Object <B>getProperty</B>(java.lang.String&nbsp;key)</PRE>
    422. 

  422. <DL>
    423. 

  423. <DD>Returns a mode property.
    424. 

  424. <P>
    425. 

  425. <DD><DL>
    426. 

  426. <DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
    427. 

  427.   <DD>jEdit 2.2pre1</DD>
    428. 

  428. </DL>
    429. 

  429. </DD>
    430. 

  430. </DL>
    431. 

  431. <HR>
    432. 

  432. 

  433. <A NAME="getBooleanProperty(java.lang.String)"><!-- --></A><H3>
    434. 

  434. getBooleanProperty</H3>
    435. 

  435. <PRE>
    436. 

  436. public boolean <B>getBooleanProperty</B>(java.lang.String&nbsp;key)</PRE>
    437. 

  437. <DL>
    438. 

  438. <DD>Returns the value of a boolean property.
    439. 

  439. <P>
    440. 

  440. <DD><DL>
    441. 

  441. <DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
    442. 

  442.   <DD>jEdit 2.5pre3</DD>
    443. 

  443. </DL>
    444. 

  444. </DD>
    445. 

  445. </DL>
    446. 

  446. <HR>
    447. 

  447. 

  448. <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>
    449. 

  449. setProperty</H3>
    450. 

  450. <PRE>
    451. 

  451. public void <B>setProperty</B>(java.lang.String&nbsp;key,
    452. 

  452.                         java.lang.Object&nbsp;value)</PRE>
    453. 

  453. <DL>
    454. 

  454. <DD>Sets a mode property.
    455. 

  455. <P>
    456. 

  456. <DD><DL>
    457. 

  457. <DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DD><CODE>value</CODE> - The property value</DL>
    458. 

  458. </DD>
    459. 

  459. </DL>
    460. 

  460. <HR>
    461. 

  461. 

  462. <A NAME="unsetProperty(java.lang.String)"><!-- --></A><H3>
    463. 

  463. unsetProperty</H3>
    464. 

  464. <PRE>
    465. 

  465. public void <B>unsetProperty</B>(java.lang.String&nbsp;key)</PRE>
    466. 

  466. <DL>
    467. 

  467. <DD>Unsets a mode property.
    468. 

  468. <P>
    469. 

  469. <DD><DL>
    470. 

  470. <DT><B>Parameters:</B><DD><CODE>key</CODE> - The property name<DT><B>Since:</B></DT>
    471. 

  471.   <DD>jEdit 3.2pre3</DD>
    472. 

  472. </DL>
    473. 

  473. </DD>
    474. 

  474. </DL>
    475. 

  475. <HR>
    476. 

  476. 

  477. <A NAME="setProperties(java.util.Map)"><!-- --></A><H3>
    478. 

  478. setProperties</H3>
    479. 

  479. <PRE>
    480. 

  480. public void <B>setProperties</B>(java.util.Map&nbsp;props)</PRE>
    481. 

  481. <DL>
    482. 

  482. <DD>Should only be called by <code>XModeHandler</code>.
    483. 

  483. <P>
    484. 

  484. <DD><DL>
    485. 

  485. <DT><B>Since:</B></DT>
    486. 

  486.   <DD>jEdit 4.0pre3</DD>
    487. 

  487. </DL>
    488. 

  488. </DD>
    489. 

  489. </DL>
    490. 

  490. <HR>
    491. 

  491. 

  492. <A NAME="accept(java.lang.String, java.lang.String)"><!-- --></A><H3>
    493. 

  493. accept</H3>
    494. 

  494. <PRE>
    495. 

  495. public boolean <B>accept</B>(java.lang.String&nbsp;fileName,
    496. 

  496.                       java.lang.String&nbsp;firstLine)</PRE>
    497. 

  497. <DL>
    498. 

  498. <DD>Returns if the edit mode is suitable for editing the specified
    499. 

  499.  file. The buffer name and first line is checked against the
    500. 

  500.  file name and first line globs, respectively.
    501. 

  501. <P>
    502. 

  502. <DD><DL>
    503. 

  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. 

  504.   <DD>jEdit 3.2pre3</DD>
    505. 

  505. </DL>
    506. 

  506. </DD>
    507. 

  507. </DL>
    508. 

  508. <HR>
    509. 

  509. 

  510. <A NAME="getName()"><!-- --></A><H3>
    511. 

  511. getName</H3>
    512. 

  512. <PRE>
    513. 

  513. public java.lang.String <B>getName</B>()</PRE>
    514. 

  514. <DL>
    515. 

  515. <DD>Returns the internal name of this edit mode.
    516. 

  516. <P>
    517. 

  517. <DD><DL>
    518. 

  518. </DL>
    519. 

  519. </DD>
    520. 

  520. </DL>
    521. 

  521. <HR>
    522. 

  522. 

  523. <A NAME="toString()"><!-- --></A><H3>
    524. 

  524. toString</H3>
    525. 

  525. <PRE>
    526. 

  526. public java.lang.String <B>toString</B>()</PRE>
    527. 

  527. <DL>
    528. 

  528. <DD>Returns a string representation of this edit mode.
    529. 

  529. <P>
    530. 

  530. <DD><DL>
    531. 

  531. <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
    532. 

  532. </DD>
    533. 

  533. <DD><DL>
    534. 

  534. </DL>
    535. 

  535. </DD>
    536. 

  536. </DL>
    537. 

  537. <HR>
    538. 

  538. 

  539. <A NAME="getIgnoreWhitespace()"><!-- --></A><H3>
    540. 

  540. getIgnoreWhitespace</H3>
    541. 

  541. <PRE>
    542. 

  542. public boolean <B>getIgnoreWhitespace</B>()</PRE>
    543. 

  543. <DL>
    544. 

  544. <DD><DL>
    545. 

  545. </DL>
    546. 

  546. </DD>
    547. 

  547. </DL>
    548. 

  548. <HR>
    549. 

  549. 

  550. <A NAME="getIndentRules()"><!-- --></A><H3>
    551. 

  551. getIndentRules</H3>
    552. 

  552. <PRE>
    553. 

  553. public 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. 

  554. <DL>
    555. 

  555. <DD><DL>
    556. 

  556. </DL>
    557. 

  557. </DD>
    558. 

  558. </DL>
    559. 

  559. <HR>
    560. 

  560. 

  561. <A NAME="isElectricKey(char)"><!-- --></A><H3>
    562. 

  562. isElectricKey</H3>
    563. 

  563. <PRE>
    564. 

  564. public boolean <B>isElectricKey</B>(char&nbsp;ch)</PRE>
    565. 

  565. <DL>
    566. 

  566. <DD><DL>
    567. 

  567. </DL>
    568. 

  568. </DD>
    569. 

  569. </DL>
    570. 

  570. <!-- ========= END OF CLASS DATA ========= -->
    571. 

  571. <HR>
    572. 

  572. 

  573. 

  574. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    575. 

  575. <A NAME="navbar_bottom"><!-- --></A>
    576. 

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

  577. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    578. 

  578. <TR>
    579. 

  579. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    580. 

  580. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    581. 

  581. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    582. 

  582.   <TR ALIGN="center" VALIGN="top">
    583. 

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

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

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

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

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

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

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

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

  591.   </TR>
    592. 

  592. </TABLE>
    593. 

  593. </TD>
    594. 

  594. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    595. 

  595. </EM>
    596. 

  596. </TD>
    597. 

  597. </TR>
    598. 

  598. 

  599. <TR>
    600. 

  600. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    601. 

  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. 

  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. 

  603. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    604. 

  604.   <A HREF="../../../../index.html?org/gjt/sp/jedit/Mode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    605. 

  605. &nbsp;<A HREF="Mode.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    606. 

  606. &nbsp;
    607. 

  607. <NOSCRIPT>
    608. 

  608.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    609. 

  609. </NOSCRIPT>
    610. 

  610. 

  611. 

  612. </FONT></TD>
    613. 

  613. </TR>
    614. 

  614. <TR>
    615. 

  615. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    616. 

  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. 

  617. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    618. 

  618. DETAIL:&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. 

  619. </TR>
    620. 

  620. </TABLE>
    621. 

  621. <A NAME="skip-navbar_bottom"></A>
    622. 

  622. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    623. 

  623. 

  624. <HR>
    625. 

  625. 

  626. </BODY>
    627. 

  627. </HTML>
    628. 

  628.