PageRenderTime 385ms CodeModel.GetById 373ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

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

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