PageRenderTime 216ms CodeModel.GetById 160ms app.highlight 48ms RepoModel.GetById 1ms app.codeStats 0ms

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

#
HTML | 1037 lines | 909 code | 115 blank | 13 comment | 0 complexity | 8b267f38294f68be806c301bf7a9a348 MD5 | raw file

Large files files are truncated, but you can click here to view the full 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:13:45 GMT-08:00 2008 -->
  6<TITLE>
  7EditPlugin (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.EditPlugin 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/EditPlugin.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/EditPane.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.Broken.html" title="class in org.gjt.sp.jedit"><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/EditPlugin.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="EditPlugin.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;<A HREF="#nested_class_summary">NESTED</A>&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</FONT>
 78<BR>
 79Class EditPlugin</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.EditPlugin</B>
 83</PRE>
 84<DL>
 85<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/EBPlugin.html" title="class in org.gjt.sp.jedit">EBPlugin</A>, <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.Broken.html" title="class in org.gjt.sp.jedit">EditPlugin.Broken</A>, <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.Deferred.html" title="class in org.gjt.sp.jedit">EditPlugin.Deferred</A></DD>
 86</DL>
 87<HR>
 88<DL>
 89<DT><PRE>public abstract class <B>EditPlugin</B><DT>extends java.lang.Object</DL>
 90</PRE>
 91
 92<P>
 93The abstract base class that every plugin must implement.
 94 Alternatively, instead of extending this class, a plugin core class can
 95 extend <A HREF="../../../../org/gjt/sp/jedit/EBPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EBPlugin</CODE></A> to automatically receive EditBus messages.
 96
 97 <h3>Basic plugin information properties</h3>
 98
 99 Note that in all cases above where a <i>className</i> is needed, the fully
100 qualified class name, including the package name, if any, must be used.<p>
101
102 The following properties are required for jEdit to load the plugin:
103
104 <ul>
105 <li><code>plugin.<i>className</i>.activate</code> - set this to
106 <code>defer</code> if your plugin only needs to be loaded when it is first
107 invoked; set it to <code>startup</code> if your plugin must be loaded at
108 startup regardless; set it to a whitespace-separated list of property names
109 if your plugin should be loaded if at least one of these properties is set.
110 Note that if this property is <b>not</b> set, the plugin will not work with
111 jEdit 4.3final.
112 </li>
113 <li><code>plugin.<i>className</i>.name</code></li>
114 <li><code>plugin.<i>className</i>.version</code></li>
115 <li><code>plugin.<i>className</i>.jars</code> - only needed if your plugin
116 bundles external JAR files. Contains a whitespace-separated list of JAR
117 file names. Without this property, the plugin manager will leave behind the
118 external JAR files when removing the plugin.</li>
119 <li><code>plugin.<i>className</i>.files</code> - only needed if your plugin
120 bundles external files like libraries which MUST reside in the local
121 filesystem. Contains a whitespace-separated list of file names.
122 Without this property, the plugin manager will leave behind the
123 external files when removing the plugin.</li>
124 <li><code>plugin.<i>className</i>.description</code> - the short description
125 associated with the plugin.  The short description is used by the Plugin
126 Manager and on the list pages on Plugin Central. </li>
127 </ul>
128
129 The following properties are optional but recommended:
130
131 <ul>
132 <li><code>plugin.<i>className</i>.author</code></li>
133 <li><code>plugin.<i>className</i>.usePluginHome</code> - whether
134 the plugin uses the EditPlugin.getPluginHome API or not. Even
135 if the plugin doesn't store any data, this property should be set
136 so that the plugin manager can tell that there is no data stored.</li>
137 <li><code>plugin.<i>className</i>.docs</code> - the path to plugin
138 documentation in HTML format. </li>
139 <li><code>plugin.<i>className</i>.longdescription</code> - the path to
140 the long description in XHTML (no fancy stuff here, please - just proper
141 XHTML subset with the basic tags: <tt>html, h1, h2, p, li, ul, ol, a href,b ,i, u, br/ </tt>)
142 <p> The long description is extracted from the plugin at various times,
143 primarily at plugin packaging time to update the data on the
144 plugin detail pages of Plugin Central. </p>
145 <p>
146 If this property is left out, the default will be to look in a file
147 called &lt;description.html&gt;. </p>
148</li>
149</ul>
150<p>
151 For the previous two properties, if a relative path is supplied,
152 it should be both </p>
153 <ol>
154 <li> relative to the location of the .props file (when it is in the source tree) </li>
155 <li> relative to the root of the JAR (when it is packaged in the JAR file) </li>
156</ol>
157
158<p> Both conditions are easily satisfied if the .props file as well as
159 description.html are both located in the root directory of the plugin,
160 as well as the generated JAR. </p>
161
162 <h3>Plugin dependency properties</h3>
163
164 <p>Plugin dependencies are also specified using properties.
165 Each dependency is defined in a property named with
166 <code>plugin.<i>className</i>.depend.</code> followed by a number.
167 Dependencies must be numbered in order, starting from zero.
168 This determines the order that dependent plugins get loaded and activated,
169 so order is very important. </p>
170
171 <p> The value of a dependency property has one of the following forms: </p>
172
173 <ul>
174 <li> <code>jdk <i>minimumJavaVersion</i></code> </li>
175 <li> <code>jedit <i>minimumjEditVersion</i></code> - note that this must be
176 a version number in the form returned by <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getBuild()"><CODE>jEdit.getBuild()</CODE></A>,
177 not <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getVersion()"><CODE>jEdit.getVersion()</CODE></A>. Note that the documentation here describes
178 the jEdit 4.2 plugin API, so this dependency must be set to at least
179 <code>04.02.99.00</code> (4.2final).</li>
180 <li><code><i>pluginClassName pluginVersion</i></code> - the fully quailified
181 plugin class name with package must be specified.</li>
182 <li><code>optional plugin <i>pluginClassName pluginVersion</i></code> -
183 an optional dependency, indicating that the plugin will work without it,
184 but that the dependency should be loaded before this plugin. </li>
185</ul>
186
187 <p>In this example, the ProjectViewer plugin is an optional dependency of
188 the Console, beacause the Console only listens to events from the ProjectViewer.
189 It requires Jedit 4.2 final. </p>
190
191<pre>
192plugin.console.ConsolePlugin.depend.0=jedit 04.02.99.00
193plugin.console.ConsolePlugin.depend.1=jdk 1.5
194plugin.console.ConsolePlugin.depend.2=plugin errorlist.ErrorListPlugin 1.4
195plugin.console.ConsolePlugin.depend.3=optional plugin projectviewer.ProjectPlugin 2.1.0.92
196</pre>
197
198 <h3>Plugin menu item properties</h3>
199
200<p> To add your plugin to the view's <b>Plugins</b> menu, define one of these two
201 properties: </p>
202
203 <ul>
204 <li><code>plugin.<i>className</i>.menu-item</code> - if this is defined,
205 the action named by this property is added to the <b>Plugins</b> menu.</li>
206 <li><code>plugin.<i>className</i>.menu</code> - if this is defined,
207 a sub-menu is added to the <b>Plugins</b> menu whose content is the
208 whitespace-separated list of action names in this property. A separator may
209 be added to the sub-menu by listing <code>-</code> in the property.</li>
210 </ul>
211
212 <p>If you want the plugin's menu items to be determined at runtime, define a
213 property <code>plugin.<i>className</i>.menu.code</code> to be BeanShell
214 code that evaluates to an implementation of
215 <A HREF="../../../../org/gjt/sp/jedit/menu/DynamicMenuProvider.html" title="interface in org.gjt.sp.jedit.menu"><CODE>DynamicMenuProvider</CODE></A>.</p>
216<p>
217 To add your plugin to the file system browser's <b>Plugins</b> menu, define
218 one of these two properties:
219</p>
220 <ul>
221 <li><code>plugin.<i>className</i>.browser-menu-item</code> - if this is
222 defined, the action named by this property is added to the <b>Plugins</b>
223 menu.</li>
224 <li><code>plugin.<i>className</i>.browser-menu</code> - if this is defined,
225 a sub-menu is added to the <b>Plugins</b> menu whose content is the
226 whitespace-separated list of action names in this property. A separator may
227 be added to the sub-menu by listing <code>-</code> in the property.</li>
228 </ul>
229
230<p> In all cases, each action's
231 menu item label is taken from the <code><i>actionName</i>.label</code>
232 property. View actions are defined in an <code>actions.xml</code>
233 file, file system browser actions are defined in a
234 <code>browser.actions.xml</code> file; see <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit"><CODE>ActionSet</CODE></A>.
235</p>
236 <h3>Plugin option pane properties</h3>
237
238 <p>To add your plugin to the <b>Plugin Options</b> dialog box, define one of
239 these two properties:
240</p>
241 <ul>
242 <li><code>plugin.<i>className</i>.option-pane=<i>paneName</i></code> - if this is defined,
243 a single option pane with this name is added to the <b>Plugin Options</b>
244 menu.</li>
245 <li><code>plugin.<i>className</i>.option-group=<i>paneName1</i> [<i>paneName2 paneName3</i> ...]</code> - if this is defined,
246 a branch node is added to the <b>Plugin Options</b> dialog box whose content
247 is the whitespace-separated list of <i>paneNames</i> in this property.</li>
248 </ul>
249
250 Then for each option <i>paneName</i>, define these two properties:
251
252 <ul>
253 <li><code>options.<i>paneName</i>.label</code> - the label to show
254 for the pane in the dialog box.</li>
255 <li><code>options.<i>paneName</i>.code</code> - BeanShell code that
256 evaluates to an instance of the <A HREF="../../../../org/gjt/sp/jedit/OptionPane.html" title="interface in org.gjt.sp.jedit"><CODE>OptionPane</CODE></A> class.</li>
257
258 <h3>Example</h3>
259
260 Here is an example set of plugin properties:
261
262 <pre>plugin.QuickNotepadPlugin.activate=defer
263plugin.QuickNotepadPlugin.name=QuickNotepad
264plugin.QuickNotepadPlugin.author=John Gellene
265plugin.QuickNotepadPlugin.version=4.2
266plugin.QuickNotepadPlugin.docs=QuickNotepad.html
267plugin.QuickNotepadPlugin.depend.0=jedit 04.02.01.00
268plugin.QuickNotepadPlugin.menu=quicknotepad \
269    - \
270    quicknotepad.choose-file \
271    quicknotepad.save-file \
272    quicknotepad.copy-to-buffer
273plugin.QuickNotepadPlugin.option-pane=quicknotepad
274
275 plugin.QuickNotepadPlugin.option-pane=quicknotepad
276 plugin.QuickNotepadPlugin.usePluginHome=false
277 options.quicknotepad.code=new QuickNotepadOptionPane();
278 options.quicknotepad.label=QuickNotepad
279 options.quicknotepad.file=File:
280 options.quicknotepad.choose-file=Choose
281 options.quicknotepad.choose-file.title=Choose a notepad file
282 options.quicknotepad.choose-font=Font:
283 options.quicknotepad.show-filepath.title=Display notepad file path
284</pre>
285
286 Note that action and option pane labels are not shown in the above example.
287<P>
288
289<P>
290<DL>
291<DT><B>Since:</B></DT>
292  <DD>jEdit 2.1pre1</DD>
293<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getProperty(java.lang.String)"><CODE>jEdit.getProperty(String)</CODE></A>, 
294<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getPlugin(java.lang.String)"><CODE>jEdit.getPlugin(String)</CODE></A>, 
295<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getPlugins()"><CODE>jEdit.getPlugins()</CODE></A>, 
296<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getPluginJAR(java.lang.String)"><CODE>jEdit.getPluginJAR(String)</CODE></A>, 
297<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getPluginJARs()"><CODE>jEdit.getPluginJARs()</CODE></A>, 
298<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#addPluginJAR(java.lang.String)"><CODE>jEdit.addPluginJAR(String)</CODE></A>, 
299<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#removePluginJAR(org.gjt.sp.jedit.PluginJAR, boolean)"><CODE>jEdit.removePluginJAR(PluginJAR,boolean)</CODE></A>, 
300<A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit"><CODE>ActionSet</CODE></A>, 
301<A HREF="../../../../org/gjt/sp/jedit/gui/DockableWindowManager.html" title="class in org.gjt.sp.jedit.gui"><CODE>DockableWindowManager</CODE></A>, 
302<A HREF="../../../../org/gjt/sp/jedit/OptionPane.html" title="interface in org.gjt.sp.jedit"><CODE>OptionPane</CODE></A>, 
303<A HREF="../../../../org/gjt/sp/jedit/PluginJAR.html" title="class in org.gjt.sp.jedit"><CODE>PluginJAR</CODE></A>, 
304<A HREF="../../../../org/gjt/sp/jedit/ServiceManager.html" title="class in org.gjt.sp.jedit"><CODE>ServiceManager</CODE></A></DL>
305<HR>
306
307<P>
308<!-- ======== NESTED CLASS SUMMARY ======== -->
309
310<A NAME="nested_class_summary"><!-- --></A>
311<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
312<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
313<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
314<B>Nested Class Summary</B></FONT></TH>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>static&nbsp;class</CODE></FONT></TD>
319<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.Broken.html" title="class in org.gjt.sp.jedit">EditPlugin.Broken</A></B></CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A placeholder for a plugin that didn't load.</TD>
323</TR>
324<TR BGCOLOR="white" CLASS="TableRowColor">
325<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326<CODE>static&nbsp;class</CODE></FONT></TD>
327<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.Deferred.html" title="class in org.gjt.sp.jedit">EditPlugin.Deferred</A></B></CODE>
328
329<BR>
330&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A placeholder for a plugin that hasn't been loaded yet.</TD>
331</TR>
332</TABLE>
333&nbsp;
334<!-- ======== CONSTRUCTOR SUMMARY ======== -->
335
336<A NAME="constructor_summary"><!-- --></A>
337<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
338<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
339<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
340<B>Constructor Summary</B></FONT></TH>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#EditPlugin()">EditPlugin</A></B>()</CODE>
344
345<BR>
346&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
347</TR>
348</TABLE>
349&nbsp;
350<!-- ========== METHOD SUMMARY =========== -->
351
352<A NAME="method_summary"><!-- --></A>
353<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
354<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
355<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
356<B>Method Summary</B></FONT></TH>
357</TR>
358<TR BGCOLOR="white" CLASS="TableRowColor">
359<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
360<CODE>&nbsp;javax.swing.JMenuItem</CODE></FONT></TD>
361<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#createBrowserMenuItems()">createBrowserMenuItems</A></B>()</CODE>
362
363<BR>
364&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the filesystem browser when constructing its
365 <b>Plugins</b> menu.</TD>
366</TR>
367<TR BGCOLOR="white" CLASS="TableRowColor">
368<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369<CODE>&nbsp;javax.swing.JMenuItem</CODE></FONT></TD>
370<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#createMenuItems()">createMenuItems</A></B>()</CODE>
371
372<BR>
373&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the view when constructing its <b>Plugins</b> menu.</TD>
374</TR>
375<TR BGCOLOR="white" CLASS="TableRowColor">
376<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377<CODE>&nbsp;void</CODE></FONT></TD>
378<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#createMenuItems(java.util.Vector)">createMenuItems</A></B>(java.util.Vector&nbsp;menuItems)</CODE>
379
380<BR>
381&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Instead of overriding this method, define properties
382 as specified in the description of this class.</I></TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>&nbsp;void</CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#createOptionPanes(org.gjt.sp.jedit.gui.OptionsDialog)">createOptionPanes</A></B>(<A HREF="../../../../org/gjt/sp/jedit/gui/OptionsDialog.html" title="class in org.gjt.sp.jedit.gui">OptionsDialog</A>&nbsp;optionsDialog)</CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Instead of overriding this method, define properties
391 as specified in the description of this class.</I></TD>
392</TR>
393<TR BGCOLOR="white" CLASS="TableRowColor">
394<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
395<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
396<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getClassName()">getClassName</A></B>()</CODE>
397
398<BR>
399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the plugin's class name.</TD>
400</TR>
401<TR BGCOLOR="white" CLASS="TableRowColor">
402<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403<CODE>&nbsp;java.io.File</CODE></FONT></TD>
404<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()">getPluginHome</A></B>()</CODE>
405
406<BR>
407&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the home of your plugin.</TD>
408</TR>
409<TR BGCOLOR="white" CLASS="TableRowColor">
410<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411<CODE>static&nbsp;java.io.File</CODE></FONT></TD>
412<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome(java.lang.Class)">getPluginHome</A></B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz)</CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the home of the specified plugin.</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>static&nbsp;java.io.File</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome(org.gjt.sp.jedit.EditPlugin)">getPluginHome</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin)</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the home of the specified plugin.</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;<A HREF="../../../../org/gjt/sp/jedit/PluginJAR.html" title="class in org.gjt.sp.jedit">PluginJAR</A></CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginJAR()">getPluginJAR</A></B>()</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the JAR file containing this plugin.</TD>
432</TR>
433<TR BGCOLOR="white" CLASS="TableRowColor">
434<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435<CODE>static&nbsp;java.io.OutputStream</CODE></FONT></TD>
436<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)">getResourceAsOutputStream</A></B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
437                          java.lang.String&nbsp;path)</CODE>
438
439<BR>
440&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an output stream to the specified resource, or <code>null</code>
441 if access to that resource is denied.</TD>
442</TR>
443<TR BGCOLOR="white" CLASS="TableRowColor">
444<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
445<CODE>static&nbsp;java.io.OutputStream</CODE></FONT></TD>
446<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)">getResourceAsOutputStream</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
447                          java.lang.String&nbsp;path)</CODE>
448
449<BR>
450&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an output stream to the specified resource, or <code>null</node> if access
451 to that resource is denied.</TD>
452</TR>
453<TR BGCOLOR="white" CLASS="TableRowColor">
454<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
455<CODE>static&nbsp;java.io.InputStream</CODE></FONT></TD>
456<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)">getResourceAsStream</A></B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
457                    java.lang.String&nbsp;path)</CODE>
458
459<BR>
460&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an input stream to the specified resource, or <code>null</code>
461 if none is found.</TD>
462</TR>
463<TR BGCOLOR="white" CLASS="TableRowColor">
464<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
465<CODE>static&nbsp;java.io.InputStream</CODE></FONT></TD>
466<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)">getResourceAsStream</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
467                    java.lang.String&nbsp;path)</CODE>
468
469<BR>
470&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an input stream to the specified resource, or <code>null</code>
471 if none is found.</TD>
472</TR>
473<TR BGCOLOR="white" CLASS="TableRowColor">
474<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
475<CODE>static&nbsp;java.io.File</CODE></FONT></TD>
476<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)">getResourcePath</A></B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
477                java.lang.String&nbsp;path)</CODE>
478
479<BR>
480&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the full path of the specified plugin resource.</TD>
481</TR>
482<TR BGCOLOR="white" CLASS="TableRowColor">
483<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
484<CODE>static&nbsp;java.io.File</CODE></FONT></TD>
485<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(org.gjt.sp.jedit.EditPlugin, java.lang.String)">getResourcePath</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
486                java.lang.String&nbsp;path)</CODE>
487
488<BR>
489&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the full path of the specified plugin resource.</TD>
490</TR>
491<TR BGCOLOR="white" CLASS="TableRowColor">
492<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
493<CODE>&nbsp;void</CODE></FONT></TD>
494<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#start()">start</A></B>()</CODE>
495
496<BR>
497&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;jEdit calls this method when the plugin is being activated, either
498 during startup or at any other time.</TD>
499</TR>
500<TR BGCOLOR="white" CLASS="TableRowColor">
501<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
502<CODE>&nbsp;void</CODE></FONT></TD>
503<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#stop()">stop</A></B>()</CODE>
504
505<BR>
506&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;jEdit calls this method when the plugin is being unloaded.</TD>
507</TR>
508</TABLE>
509&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
510<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
511<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
512<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
513</TR>
514<TR BGCOLOR="white" CLASS="TableRowColor">
515<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
516</TR>
517</TABLE>
518&nbsp;
519<P>
520
521<!-- ========= CONSTRUCTOR DETAIL ======== -->
522
523<A NAME="constructor_detail"><!-- --></A>
524<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
525<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
526<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
527<B>Constructor Detail</B></FONT></TH>
528</TR>
529</TABLE>
530
531<A NAME="EditPlugin()"><!-- --></A><H3>
532EditPlugin</H3>
533<PRE>
534public <B>EditPlugin</B>()</PRE>
535<DL>
536</DL>
537
538<!-- ============ METHOD DETAIL ========== -->
539
540<A NAME="method_detail"><!-- --></A>
541<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
542<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
543<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
544<B>Method Detail</B></FONT></TH>
545</TR>
546</TABLE>
547
548<A NAME="start()"><!-- --></A><H3>
549start</H3>
550<PRE>
551public void <B>start</B>()</PRE>
552<DL>
553<DD>jEdit calls this method when the plugin is being activated, either
554 during startup or at any other time. A plugin can get activated for
555 a number of reasons:
556
557 <ul>
558 <li>The plugin is written for jEdit 4.1 or older, in which case it
559 will always be loaded at startup.</li>
560 <li>The plugin has its <code>activate</code> property set to
561 <code>startup</code>, in which case it will always be loaded at
562 startup.</li>
563 <li>One of the properties listed in the plugin's
564 <code>activate</code> property is set to <code>true</code>,
565 in which case it will always be loaded at startup.</li>
566 <li>One of the plugin's classes is being accessed by another plugin,
567 a macro, or a BeanShell snippet in a plugin API XML file.</li>
568 </ul>
569
570 Note that this method is always called from the event dispatch
571 thread, even if the activation resulted from a class being loaded
572 from another thread. A side effect of this is that some of your
573 plugin's code might get executed before this method finishes
574 running.<p>
575
576 When this method is being called for plugins written for jEdit 4.1
577 and below, no views or buffers are open. However, this is not the
578 case for plugins using the new API. For example, if your plugin adds
579 tool bars to views, make sure you correctly handle the case where
580 views are already open when the plugin is loaded.<p>
581
582 If your plugin must be loaded on startup, take care to have this
583 method return as quickly as possible.<p>
584
585 The default implementation of this method does nothing.
586<P>
587<DD><DL>
588<DT><B>Since:</B></DT>
589  <DD>jEdit 2.1pre1</DD>
590</DL>
591</DD>
592</DL>
593<HR>
594
595<A NAME="stop()"><!-- --></A><H3>
596stop</H3>
597<PRE>
598public void <B>stop</B>()</PRE>
599<DL>
600<DD>jEdit calls this method when the plugin is being unloaded. This can
601 be when the program is exiting, or at any other time.<p>
602
603 If a plugin uses state information or other persistent data
604 that should be stored in a special format, this would be a good place
605 to write the data to storage.  If the plugin uses jEdit's properties
606 API to hold settings, no special processing is needed for them on
607 exit, since they will be saved automatically.<p>
608
609 With plugins written for jEdit 4.1 and below, this method is only
610 called when the program is exiting. However, this is not the case
611 for plugins using the new API. For example, if your plugin adds
612 tool bars to views, make sure you correctly handle the case where
613 views are still open when the plugin is unloaded.<p>
614
615 To avoid memory leaks, this method should ensure that no references
616 to any objects created by this plugin remain in the heap. In the
617 case of actions, dockable windows and services, jEdit ensures this
618 automatically. For other objects, your plugin must clean up maually.
619 <p>
620
621 The default implementation of this method does nothing.
622<P>
623<DD><DL>
624<DT><B>Since:</B></DT>
625  <DD>jEdit 2.1pre1</DD>
626</DL>
627</DD>
628</DL>
629<HR>
630
631<A NAME="getPluginHome()"><!-- --></A><H3>
632getPluginHome</H3>
633<PRE>
634public java.io.File <B>getPluginHome</B>()</PRE>
635<DL>
636<DD>Returns the home of your plugin.
637<P>
638<DD><DL>
639
640<DT><B>Returns:</B><DD>the plugin home. It can be null if there is no 
641           settings directory<DT><B>Since:</B></DT>
642  <DD>4.3pre10</DD>
643<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
644<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
645<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
646</DD>
647</DL>
648<HR>
649
650<A NAME="getPluginHome(java.lang.Class)"><!-- --></A><H3>
651getPluginHome</H3>
652<PRE>
653public static java.io.File <B>getPluginHome</B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz)</PRE>
654<DL>
655<DD><p>Returns the home of the specified plugin.</p>
656
657 <p>Since the first parameter is a reference to the
658 <code>Class</code> instance for the plugin,
659 this method requires the plugin to be activated.</p>
660
661 <p>See <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome(org.gjt.sp.jedit.EditPlugin)"><CODE>getPluginHome(EditPlugin)</CODE></A> method, as
662 an alternate, for when the plugin doesn't need
663 to be activated, or when you do not have the
664 <code>Class</code> instance available.</p>
665<P>
666<DD><DL>
667<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the class of the plugin
668<DT><B>Returns:</B><DD>the plugin home. It can be null if there is no
669           settings directory<DT><B>Since:</B></DT>
670  <DD>4.3pre10</DD>
671<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome(org.gjt.sp.jedit.EditPlugin)"><CODE>getPluginHome(EditPlugin)</CODE></A>, 
672<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
673<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
674<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
675</DD>
676</DL>
677<HR>
678
679<A NAME="getPluginHome(org.gjt.sp.jedit.EditPlugin)"><!-- --></A><H3>
680getPluginHome</H3>
681<PRE>
682public static java.io.File <B>getPluginHome</B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin)</PRE>
683<DL>
684<DD><p>Returns the home of the specified plugin.</p>
685 
686 <p>This method doesn't need the plugin to be activated. You can pass
687 an <code>EditPlugin.Deferred</code> instance that you get from
688 <code>jEdit.getPlugin(String)</code> or <code>jEdit.getPlugins()</code> if
689 the plugin in question is not activated yet and this method doesn't
690 cause the plugin to get activated. If you have a reference to the
691 plugins <code>Class</code> instance available, consider using the
692 <code>Class</code> method.</p>
693<P>
694<DD><DL>
695<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin
696<DT><B>Returns:</B><DD>the plugin home. It can be null if there is no settings directory<DT><B>Since:</B></DT>
697  <DD>4.3pre10</DD>
698<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome(java.lang.Class)"><CODE>getPluginHome(Class)</CODE></A>, 
699<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
700<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
701<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
702</DD>
703</DL>
704<HR>
705
706<A NAME="getResourceAsStream(java.lang.Class, java.lang.String)"><!-- --></A><H3>
707getResourceAsStream</H3>
708<PRE>
709public static java.io.InputStream <B>getResourceAsStream</B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
710                                                      java.lang.String&nbsp;path)</PRE>
711<DL>
712<DD><p>Returns an input stream to the specified resource, or <code>null</code>
713 if none is found.</p>
714
715 <p>Since the first parameter is a reference to the
716 <code>Class</code> instance for the plugin,
717 this method requires the plugin to be activated.</p>
718
719 <p>See <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourceAsStream(EditPlugin,String)</CODE></A> method, as
720 an alternate, for when the plugin doesn't need
721 to be activated, or when you do not have the
722 <code>Class</code> instance available.</p>
723<P>
724<DD><DL>
725<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the plugin class<DD><CODE>path</CODE> - The path to the resource to be returned, relative to
726 the plugin's resource path.
727<DT><B>Returns:</B><DD>An input stream for the resource, or <code>null</code>.<DT><B>Since:</B></DT>
728  <DD>4.3pre10</DD>
729<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
730<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourceAsStream(EditPlugin,String)</CODE></A>, 
731<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
732<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
733</DD>
734</DL>
735<HR>
736
737<A NAME="getResourceAsStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><!-- --></A><H3>
738getResourceAsStream</H3>
739<PRE>
740public static java.io.InputStream <B>getResourceAsStream</B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
741                                                      java.lang.String&nbsp;path)</PRE>
742<DL>
743<DD><p>Returns an input stream to the specified resource, or <code>null</code>
744 if none is found.</p>
745 
746 <p>This method doesn't need the plugin to be activated. You can pass
747 an <code>EditPlugin.Deferred</code> instance that you get from
748 <code>jEdit.getPlugin(String)</code> or <code>jEdit.getPlugins()</code> if
749 the plugin in question is not activated yet and this method doesn't
750 cause the plugin to get activated. If you have a reference to the
751 plugins <code>Class</code> instance available, consider using the
752 <code>Class</code> method.</p>
753<P>
754<DD><DL>
755<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin<DD><CODE>path</CODE> - The path to the resource to be returned, relative to
756 the plugin's resource path.
757<DT><B>Returns:</B><DD>An input stream for the resource, or <code>null</code>.<DT><B>Since:</B></DT>
758  <DD>4.3pre10</DD>
759<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
760<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(Class,String)</CODE></A>, 
761<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
762<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
763</DD>
764</DL>
765<HR>
766
767<A NAME="getResourceAsOutputStream(java.lang.Class, java.lang.String)"><!-- --></A><H3>
768getResourceAsOutputStream</H3>
769<PRE>
770public static java.io.OutputStream <B>getResourceAsOutputStream</B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
771                                                             java.lang.String&nbsp;path)</PRE>
772<DL>
773<DD><p>Returns an output stream to the specified resource, or <code>null</code>
774 if access to that resource is denied.</p>
775
776 <p>Since the first parameter is a reference to the
777 <code>Class</code> instance for the plugin,
778 this method requires the plugin to be activated.</p>
779
780 <p>See <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourceAsOutputStream(EditPlugin,String)</CODE></A> method, as
781 an alternate, for when the plugin doesn't need
782 to be activated, or when you do not have the
783 <code>Class</code> instance available.</p>
784<P>
785<DD><DL>
786<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the plugin class<DD><CODE>path</CODE> - The path to the resource to be returned, relative to
787 the plugin's resource path.
788<DT><B>Returns:</B><DD>An output stream for the resource, or <code>null</code>.<DT><B>Since:</B></DT>
789  <DD>4.3pre10</DD>
790<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
791<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourceAsOutputStream(EditPlugin,String)</CODE></A>, 
792<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
793<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
794</DD>
795</DL>
796<HR>
797
798<A NAME="getResourceAsOutputStream(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><!-- --></A><H3>
799getResourceAsOutputStream</H3>
800<PRE>
801public static java.io.OutputStream <B>getResourceAsOutputStream</B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
802                                                             java.lang.String&nbsp;path)</PRE>
803<DL>
804<DD><p>Returns an output stream to the specified resource, or <code>null</node> if access
805 to that resource is denied.</p>
806
807 <p>This method doesn't need the plugin to be activated. You can pass
808 an <code>EditPlugin.Deferred</code> instance that you get from
809 <code>jEdit.getPlugin(String)</code> or <code>jEdit.getPlugins()</code> if
810 the plugin in question is not activated yet and this method doesn't
811 cause the plugin to get activated. If you have a reference to the
812 plugins <code>Class</code> instance available, consider using the
813 <code>Class</code> method.</p>
814<P>
815<DD><DL>
816<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin<DD><CODE>path</CODE> - The path to the resource to be returned, relative to
817 the plugin's resource path.
818<DT><B>Returns:</B><DD>An output stream for the resource, or <code>null</code>.<DT><B>Since:</B></DT>
819  <DD>4.3pre10</DD>
820<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
821<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(Class,String)</CODE></A>, 
822<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
823<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A></DL>
824</DD>
825</DL>
826<HR>
827
828<A NAME="getResourcePath(java.lang.Class, java.lang.String)"><!-- --></A><H3>
829getResourcePath</H3>
830<PRE>
831public static java.io.File <B>getResourcePath</B>(java.lang.Class&lt;? extends <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&gt;&nbsp;clazz,
832                                           java.lang.String&nbsp;path)</PRE>
833<DL>
834<DD><p>Returns the full path of the specified plugin resource.</p>
835
836 <p>Since the first parameter is a reference to the
837 <code>Class</code> instance for the plugin,
838 this method requires the plugin to be activated.</p>
839
840 <p>See <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourcePath(EditPlugin,String)</CODE></A> method, as
841 an alternate, for when the plugin doesn't need
842 to be activated, or when you do not have the
843 <code>Class</code> instance available.</p>
844<P>
845<DD><DL>
846<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the plugin class<DD><CODE>path</CODE> - The relative path to the resource from the plugin's
847 resource path.
848<DT><B>Returns:</B><DD>The absolute path to the resource or null if there is no plugin home.<DT><B>Since:</B></DT>
849  <DD>4.3pre10</DD>
850<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
851<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
852<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
853<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><CODE>getResourcePath(EditPlugin,String)</CODE></A></DL>
854</DD>
855</DL>
856<HR>
857
858<A NAME="getResourcePath(org.gjt.sp.jedit.EditPlugin, java.lang.String)"><!-- --></A><H3>
859getResourcePath</H3>
860<PRE>
861public static java.io.File <B>getResourcePath</B>(<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit">EditPlugin</A>&nbsp;plugin,
862                                           java.lang.String&nbsp;path)</PRE>
863<DL>
864<DD><p>Returns the full path of the specified plugin resource.</p>
865
866 <p>This method doesn't need the plugin to be activated. You can pass
867 an <code>EditPlugin.Deferred</code> instance that you get from
868 <code>jEdit.getPlugin(String)</code> or <code>jEdit.getPlugins()</code> if
869 the plugin in question is not activated yet and this method doesn't
870 cause the plugin to get activated. If you have a reference to the
871 plugins <code>Class</code> instance available, consider using the
872 <code>Class</code> method.</p>
873<P>
874<DD><DL>
875<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin<DD><CODE>path</CODE> - The relative path to the resource from the plugin's
876 resource path.
877<DT><B>Returns:</B><DD>The absolute path to the resource or null if there is no plugin home.<DT><B>Since:</B></DT>
878  <DD>4.3pre10</DD>
879<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getPluginHome()"><CODE>getPluginHome()</CODE></A>, 
880<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsOutputStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsOutputStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
881<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourceAsStream(java.lang.Class, java.lang.String)"><CODE>getResourceAsStream(java.lang.Class<? extends org.gjt.sp.jedit.EditPlugin>, java.lang.String)</CODE></A>, 
882<A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html#getResourcePath(java.lang.Class, java.lang.String)"><CODE>getResourcePath(Class,String)</CODE></A></DL>
883</DD>
884</DL>
885<HR>
886
887<A NAME="getClassName()"><!-- --></A><H3>
888getClassName</H3>
889<PRE>
890public java.lang.String <B>getClassName</B>()</PRE>
891<DL>
892<DD>Returns the plugin's class name. This might not be the same as
893 the class of the actual <code>EditPlugin</code> instance, for
894 example if the plugin is not loaded yet.
895<P>
896<DD><DL>
897<DT><B>Since:</B></DT>
898  <DD>jEdit 2.5pre3</DD>
899</DL>
900</DD>
901</DL>
902<HR>
903
904<A NAME="getPluginJAR()"><!-- --></A><H3>
905getPluginJAR</H3>
906<PRE>
907public <A HREF="../../../../org/gjt/sp/jedit/PluginJAR.html" title="class in org.gjt.sp.jedit">PluginJAR</A> <B>getPluginJAR</B>()</PRE>
908<DL>
909<DD>Returns the JAR file containing this plugin.
910<P>
911<DD><DL>
912<DT><B>Since:</B></DT>
913  <DD>jEdit 4.2pre1</DD>
914</DL>
915</DD>
916</DL>
917<HR>
918
919<A NAME="createMenuItems()"><!-- --></A><H3>
920createMenuItems</H3>
921<PRE>
922public final javax.swing.JMenuItem <B>createMenuItems</B>()</PRE>
923<DL>
924<DD>Called by the view when constructing its <b>Plugins</b> menu.
925 See the description of this class for details about how the
926 menu items are constructed from plugin properties.
927<P>
928<DD><DL>
929<DT><B>Since:</B></DT>
930  <DD>jEdit 4.2pre1</DD>
931</DL>
932</DD>
933</DL>
934<HR>
935
936<A NAME="createBrowserMenuItems()"><!-- --></A><H3>
937createBrowserMenuItems</H3>
938<PRE>
939public final javax.swing.JMenuItem <B>createBrowserMenuItems</B>()</PRE>
940<DL>
941<DD>Called by the filesystem browser when constructing its
942 <b>Plugins</b> menu.
943 See the description of this class for details about how the
944 menu items are constructed from plugin properties.
945<P>
946<DD><DL>
947<DT><B>Since:</B></DT>
948  <DD>jEdit 4.2pre1</DD>
949</DL>
950</DD>
951</DL>
952<HR>
953
954<A NAME="createMenuItems(java.util.Vector)"><!-- --></A><H3>
955createMenuItems</H3>
956<PRE>
957public void <B>createMenuItems</B>(java.util.Vector&nbsp;menuItems)</PRE>
958<DL>
959<DD><B>Deprecated.</B>&nbsp;<I>Instead of overriding this method, define properties
960 as specified in the description of this class.</I>
961<P>
962<DD><DL>
963</DL>
964</DD>
965</DL>
966<HR>
967
968<A NAME="createOptionPanes(org.gjt.sp.jedit.gui.OptionsDialog)"><!-- --></A><H3>
969createOptionPanes</H3>
970<PRE>
971public void <B>createOptionPanes</B>(<A HREF="../../../../org/gjt/sp/jedit/gui/OptionsDialog.html" title="class in org.gjt.sp.jedit.gui">OptionsDialog</A>&nbsp;optionsDialog)</PRE>
972<DL>
973<DD><B>Deprecated.</B>&nbsp;<I>Instead of overriding this method, define properties
974 as specified in the description of this class.</I>
975<P>
976<DD><DL>
977</DL>
978</DD>
979</DL>
980<!-- ========= END OF CLASS DATA ========= -->
981<HR>
982
983
984<!-- ======= START OF BOTTOM NAVBAR ====== -->
985<A NAME="navbar_bottom"><!-- --></A>
986<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
987<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
988<TR>
989<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
990<A NAME="navbar_b…

Large files files are truncated, but you can click here to view the full file