PageRenderTime 81ms CodeModel.GetById 62ms app.highlight 14ms RepoModel.GetById 1ms 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
  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>
  7DynamicMenuProvider (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.menu.DynamicMenuProvider interface">
 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/DynamicMenuProvider.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/menu/DirectoryProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
 51&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>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/menu/DynamicMenuProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="DynamicMenuProvider.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.menu</FONT>
 78<BR>
 79Interface DynamicMenuProvider</H2>
 80<DL>
 81<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>
 82</DL>
 83<HR>
 84<DL>
 85<DT><PRE>public interface <B>DynamicMenuProvider</B></DL>
 86</PRE>
 87
 88<P>
 89Interface for a pull-down menu whose contents are determined at runtime.<p>
 90
 91 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
 92 have your plugin provide a dynamic menu.
 93<P>
 94
 95<P>
 96<DL>
 97<DT><B>Since:</B></DT>
 98  <DD>jEdit 4.2pre2</DD>
 99</DL>
100<HR>
101
102<P>
103
104<!-- ========== METHOD SUMMARY =========== -->
105
106<A NAME="method_summary"><!-- --></A>
107<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
108<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
109<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
110<B>Method Summary</B></FONT></TH>
111</TR>
112<TR BGCOLOR="white" CLASS="TableRowColor">
113<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
114<CODE>&nbsp;void</CODE></FONT></TD>
115<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>
116
117<BR>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the menu items to the given menu.</TD>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122<CODE>&nbsp;boolean</CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html#updateEveryTime()">updateEveryTime</A></B>()</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the menu should be updated each time it is shown.</TD>
127</TR>
128</TABLE>
129&nbsp;
130<P>
131
132<!-- ============ METHOD DETAIL ========== -->
133
134<A NAME="method_detail"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
138<B>Method Detail</B></FONT></TH>
139</TR>
140</TABLE>
141
142<A NAME="updateEveryTime()"><!-- --></A><H3>
143updateEveryTime</H3>
144<PRE>
145boolean <B>updateEveryTime</B>()</PRE>
146<DL>
147<DD>Returns true if the menu should be updated each time it is shown.
148 Otherwise, it will only be updated when the menu is first created,
149 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.
150<P>
151<DD><DL>
152</DL>
153</DD>
154</DL>
155<HR>
156
157<A NAME="update(javax.swing.JMenu)"><!-- --></A><H3>
158update</H3>
159<PRE>
160void <B>update</B>(javax.swing.JMenu&nbsp;menu)</PRE>
161<DL>
162<DD>Adds the menu items to the given menu.
163<P>
164<DD><DL>
165<DT><B>Parameters:</B><DD><CODE>menu</CODE> - The menu</DL>
166</DD>
167</DL>
168<!-- ========= END OF CLASS DATA ========= -->
169<HR>
170
171
172<!-- ======= START OF BOTTOM NAVBAR ====== -->
173<A NAME="navbar_bottom"><!-- --></A>
174<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
175<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
176<TR>
177<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
178<A NAME="navbar_bottom_firstrow"><!-- --></A>
179<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
180  <TR ALIGN="center" VALIGN="top">
181  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
182  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
183  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
184  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DynamicMenuProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
185  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
186  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
187  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
188  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
189  </TR>
190</TABLE>
191</TD>
192<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
193</EM>
194</TD>
195</TR>
196
197<TR>
198<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
199&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/menu/DirectoryProvider.html" title="class in org.gjt.sp.jedit.menu"><B>PREV CLASS</B></A>&nbsp;
200&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>
201<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
202  <A HREF="../../../../../index.html?org/gjt/sp/jedit/menu/DynamicMenuProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
203&nbsp;<A HREF="DynamicMenuProvider.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
204&nbsp;
205<NOSCRIPT>
206  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
207</NOSCRIPT>
208
209
210</FONT></TD>
211</TR>
212<TR>
213<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
214  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
215<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
216DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
217</TR>
218</TABLE>
219<A NAME="skip-navbar_bottom"></A>
220<!-- ======== END OF BOTTOM NAVBAR ======= -->
221
222<HR>
223
224</BODY>
225</HTML>