PageRenderTime 43ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 268 lines | 222 code | 34 blank | 12 comment | 0 complexity | c229061366912f5b446d3298d67cae9c 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:03 GMT-08:00 2008 -->
  6. <TITLE>
  7. MacrosProvider (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.menu.MacrosProvider 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/MacrosProvider.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/menu/FavoritesProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/MarkersProvider.html" title="class in org.gjt.sp.jedit.menu"><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/menu/MacrosProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="MacrosProvider.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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.menu</FONT>
  66. <BR>
  67. Class MacrosProvider</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.menu.MacrosProvider</B>
  71. </PRE>
  72. <DL>
  73. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html" title="interface in org.gjt.sp.jedit.menu">DynamicMenuProvider</A></DD>
  74. </DL>
  75. <HR>
  76. <DL>
  77. <DT><PRE>public class <B>MacrosProvider</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html" title="interface in org.gjt.sp.jedit.menu">DynamicMenuProvider</A></DL>
  78. </PRE>
  79. <P>
  80. <HR>
  81. <P>
  82. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  83. <A NAME="constructor_summary"><!-- --></A>
  84. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  85. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  86. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  87. <B>Constructor Summary</B></FONT></TH>
  88. </TR>
  89. <TR BGCOLOR="white" CLASS="TableRowColor">
  90. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/MacrosProvider.html#MacrosProvider()">MacrosProvider</A></B>()</CODE>
  91. <BR>
  92. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  93. </TR>
  94. </TABLE>
  95. &nbsp;
  96. <!-- ========== METHOD SUMMARY =========== -->
  97. <A NAME="method_summary"><!-- --></A>
  98. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  99. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  100. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  101. <B>Method Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  105. <CODE>&nbsp;void</CODE></FONT></TD>
  106. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/MacrosProvider.html#update(javax.swing.JMenu)">update</A></B>(javax.swing.JMenu&nbsp;menu)</CODE>
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the menu items to the given menu.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>&nbsp;boolean</CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/MacrosProvider.html#updateEveryTime()">updateEveryTime</A></B>()</CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the menu should be updated each time it is shown.</TD>
  116. </TR>
  117. </TABLE>
  118. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  119. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  120. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  121. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  122. </TR>
  123. <TR BGCOLOR="white" CLASS="TableRowColor">
  124. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  125. </TR>
  126. </TABLE>
  127. &nbsp;
  128. <P>
  129. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  130. <A NAME="constructor_detail"><!-- --></A>
  131. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  132. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  133. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  134. <B>Constructor Detail</B></FONT></TH>
  135. </TR>
  136. </TABLE>
  137. <A NAME="MacrosProvider()"><!-- --></A><H3>
  138. MacrosProvider</H3>
  139. <PRE>
  140. public <B>MacrosProvider</B>()</PRE>
  141. <DL>
  142. </DL>
  143. <!-- ============ METHOD DETAIL ========== -->
  144. <A NAME="method_detail"><!-- --></A>
  145. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  146. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  147. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  148. <B>Method Detail</B></FONT></TH>
  149. </TR>
  150. </TABLE>
  151. <A NAME="updateEveryTime()"><!-- --></A><H3>
  152. updateEveryTime</H3>
  153. <PRE>
  154. public boolean <B>updateEveryTime</B>()</PRE>
  155. <DL>
  156. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#updateEveryTime()">DynamicMenuProvider</A></CODE></B></DD>
  157. <DD>Returns true if the menu should be updated each time it is shown.
  158. Otherwise, it will only be updated when the menu is first created,
  159. and if the menu receives a <A HREF="../../../../../org/gjt/sp/jedit/msg/DynamicMenuChanged.html" title="class in org.gjt.sp.jedit.msg"><CODE>DynamicMenuChanged</CODE></A> message.
  160. <P>
  161. <DD><DL>
  162. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#updateEveryTime()">updateEveryTime</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html" title="interface in org.gjt.sp.jedit.menu">DynamicMenuProvider</A></CODE></DL>
  163. </DD>
  164. <DD><DL>
  165. </DL>
  166. </DD>
  167. </DL>
  168. <HR>
  169. <A NAME="update(javax.swing.JMenu)"><!-- --></A><H3>
  170. update</H3>
  171. <PRE>
  172. public void <B>update</B>(javax.swing.JMenu&nbsp;menu)</PRE>
  173. <DL>
  174. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#update(javax.swing.JMenu)">DynamicMenuProvider</A></CODE></B></DD>
  175. <DD>Adds the menu items to the given menu.
  176. <P>
  177. <DD><DL>
  178. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#update(javax.swing.JMenu)">update</A></CODE> in interface <CODE><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html" title="interface in org.gjt.sp.jedit.menu">DynamicMenuProvider</A></CODE></DL>
  179. </DD>
  180. <DD><DL>
  181. <DT><B>Parameters:</B><DD><CODE>menu</CODE> - The menu</DL>
  182. </DD>
  183. </DL>
  184. <!-- ========= END OF CLASS DATA ========= -->
  185. <HR>
  186. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  187. <A NAME="navbar_bottom"><!-- --></A>
  188. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  189. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  190. <TR>
  191. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  192. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  193. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  194. <TR ALIGN="center" VALIGN="top">
  195. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  196. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  197. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  198. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MacrosProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  199. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  200. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  201. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  202. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  203. </TR>
  204. </TABLE>
  205. </TD>
  206. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  207. </EM>
  208. </TD>
  209. </TR>
  210. <TR>
  211. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  212. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/FavoritesProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
  213. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/MarkersProvider.html" title="class in org.gjt.sp.jedit.menu"><B>NEXT CLASS</B></A></FONT></TD>
  214. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  215. <A HREF="../../../../../index.html?org/gjt/sp/jedit/menu/MacrosProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  216. &nbsp;<A HREF="MacrosProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  217. &nbsp;
  218. <NOSCRIPT>
  219. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  220. </NOSCRIPT>
  221. </FONT></TD>
  222. </TR>
  223. <TR>
  224. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  225. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  226. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  227. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  228. </TR>
  229. </TABLE>
  230. <A NAME="skip-navbar_bottom"></A>
  231. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  232. <HR>
  233. </BODY>
  234. </HTML>