PageRenderTime 34ms CodeModel.GetById 1ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 225 lines | 184 code | 31 blank | 10 comment | 0 complexity | a392d8d2e6e1299ff0161290d4ff10e7 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:02 GMT-08:00 2008 -->
  6. <TITLE>
  7. DynamicMenuProvider (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.menu.DynamicMenuProvider interface">
  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/DynamicMenuProvider.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/DirectoryProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/EnhancedCheckBoxMenuItem.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/DynamicMenuProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="DynamicMenuProvider.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;CONSTR&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;CONSTR&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. Interface DynamicMenuProvider</H2>
  68. <DL>
  69. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/menu/DirectoryProvider.html" title="class in org.gjt.sp.jedit.menu">DirectoryProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/FavoritesProvider.html" title="class in org.gjt.sp.jedit.menu">FavoritesProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/MacrosProvider.html" title="class in org.gjt.sp.jedit.menu">MacrosProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/MarkersProvider.html" title="class in org.gjt.sp.jedit.menu">MarkersProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/PluginsProvider.html" title="class in org.gjt.sp.jedit.menu">PluginsProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/RecentDirectoriesProvider.html" title="class in org.gjt.sp.jedit.menu">RecentDirectoriesProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/RecentFilesProvider.html" title="class in org.gjt.sp.jedit.menu">RecentFilesProvider</A>, <A HREF="../../../../../org/gjt/sp/jedit/menu/ReloadWithEncodingProvider.html" title="class in org.gjt.sp.jedit.menu">ReloadWithEncodingProvider</A></DD>
  70. </DL>
  71. <HR>
  72. <DL>
  73. <DT><PRE>public interface <B>DynamicMenuProvider</B></DL>
  74. </PRE>
  75. <P>
  76. Interface for a pull-down menu whose contents are determined at runtime.<p>
  77. See <A HREF="../../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EditPlugin</CODE></A> for properties you need to define to
  78. have your plugin provide a dynamic menu.
  79. <P>
  80. <P>
  81. <DL>
  82. <DT><B>Since:</B></DT>
  83. <DD>jEdit 4.2pre2</DD>
  84. </DL>
  85. <HR>
  86. <P>
  87. <!-- ========== METHOD SUMMARY =========== -->
  88. <A NAME="method_summary"><!-- --></A>
  89. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  90. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  91. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  92. <B>Method Summary</B></FONT></TH>
  93. </TR>
  94. <TR BGCOLOR="white" CLASS="TableRowColor">
  95. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  96. <CODE>&nbsp;void</CODE></FONT></TD>
  97. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#update(javax.swing.JMenu)">update</A></B>(javax.swing.JMenu&nbsp;menu)</CODE>
  98. <BR>
  99. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the menu items to the given menu.</TD>
  100. </TR>
  101. <TR BGCOLOR="white" CLASS="TableRowColor">
  102. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  103. <CODE>&nbsp;boolean</CODE></FONT></TD>
  104. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#updateEveryTime()">updateEveryTime</A></B>()</CODE>
  105. <BR>
  106. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the menu should be updated each time it is shown.</TD>
  107. </TR>
  108. </TABLE>
  109. &nbsp;
  110. <P>
  111. <!-- ============ METHOD DETAIL ========== -->
  112. <A NAME="method_detail"><!-- --></A>
  113. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  114. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  115. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  116. <B>Method Detail</B></FONT></TH>
  117. </TR>
  118. </TABLE>
  119. <A NAME="updateEveryTime()"><!-- --></A><H3>
  120. updateEveryTime</H3>
  121. <PRE>
  122. boolean <B>updateEveryTime</B>()</PRE>
  123. <DL>
  124. <DD>Returns true if the menu should be updated each time it is shown.
  125. Otherwise, it will only be updated when the menu is first created,
  126. 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.
  127. <P>
  128. <DD><DL>
  129. </DL>
  130. </DD>
  131. </DL>
  132. <HR>
  133. <A NAME="update(javax.swing.JMenu)"><!-- --></A><H3>
  134. update</H3>
  135. <PRE>
  136. void <B>update</B>(javax.swing.JMenu&nbsp;menu)</PRE>
  137. <DL>
  138. <DD>Adds the menu items to the given menu.
  139. <P>
  140. <DD><DL>
  141. <DT><B>Parameters:</B><DD><CODE>menu</CODE> - The menu</DL>
  142. </DD>
  143. </DL>
  144. <!-- ========= END OF CLASS DATA ========= -->
  145. <HR>
  146. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  147. <A NAME="navbar_bottom"><!-- --></A>
  148. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  149. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  150. <TR>
  151. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  152. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  153. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  154. <TR ALIGN="center" VALIGN="top">
  155. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  156. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  157. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  158. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DynamicMenuProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  159. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  160. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  161. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  162. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  163. </TR>
  164. </TABLE>
  165. </TD>
  166. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  167. </EM>
  168. </TD>
  169. </TR>
  170. <TR>
  171. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  172. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/DirectoryProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
  173. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/EnhancedCheckBoxMenuItem.html" title="class in org.gjt.sp.jedit.menu"><B>NEXT CLASS</B></A></FONT></TD>
  174. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  175. <A HREF="../../../../../index.html?org/gjt/sp/jedit/menu/DynamicMenuProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
  176. &nbsp;<A HREF="DynamicMenuProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  177. &nbsp;
  178. <NOSCRIPT>
  179. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  180. </NOSCRIPT>
  181. </FONT></TD>
  182. </TR>
  183. <TR>
  184. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  185. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  186. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  187. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  188. </TR>
  189. </TABLE>
  190. <A NAME="skip-navbar_bottom"></A>
  191. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  192. <HR>
  193. </BODY>
  194. </HTML>