| products/Sources/formale Sprachen/Isabelle/Tools/jEdit/dist/doc/api/org/gjt/sp/jedit/ |
|
Quellcode-Bibliothek© Kompilation durch diese Firma[Weder Korrektheit noch Funktionsfähigkeit der Software werden zugesichert.]Datei: BeanShell.html Sprache: HTMLOriginal von: Isabelle© |
|
||||||||
<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (11.0.7) on Thu Sep 03 05:32:24 CEST 2020 --> <title>PluginJAR (jEdit API Documentation)</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="dc.created" content="2020-09-03"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title= <script type="text/javascript" src="../../../../script.js"></script> <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></scr <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils <!--[if IE]> <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils <![endif]--> <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></scr <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="PluginJAR (jEdit API Documentation)"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10, var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../../"; var useModuleDirectories = true; loadScripts(document, 'script');</script> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navig <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/PluginJAR.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses.html">All Classes</a></li> </ul> <ul class="navListSearch"> <li><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summ <h2 title="Class PluginJAR" class="title">Class PluginJAR</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.gjt.sp.jedit.PluginJAR</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <pre>public class <span class="typeNameLabel">PluginJAR</span> extends java.lang.Object</pre> <div class="block">Loads and unloads plugins.<p> <h3>JAR file contents</h3> When loading a plugin, jEdit looks for the following resources: <ul> <li>A file named <code>actions.xml</code> defining plugin actions. Only one such file per plugin is allowed. See <a href="ActionSet.html" title="class in org.g syntax.</li> <li>A file named <code>browser.actions.xml</code> defining file system browser actions. Only one such file per plugin is allowed. See <a href="ActionSet.html" title="class in org.g syntax.</li> <li>A file named <code>dockables.xml</code> defining dockable windows. Only one such file per plugin is allowed. See <a href="gui/DockableWindowManager.html" title syntax.</li> <li>A file named <code>services.xml</code> defining additional services offered by the plugin, such as virtual file systems. Only one such file per plugin is allowed. See <a href="ServiceManager.html" title="class in syntax.</li> <li>File with extension <code>.props</code> containing name/value pairs separated by an equals sign. A plugin can supply any number of property files. Property files are used to define plugin men items, plugin option panes, as well as arbitriary settings and strings used by the plugin. See <a href="EditPlugin.html" title="class in org. information about properties used by jEdit. See <code>java.util.Properties</code> for property file syntax.</li> <li>Since jEdit 5.0, files named lang_[language_iso_code].properties are localization files. If one of those files match the current language, jEdit will load it. If a label is missing in the localization file, it will be loaded from the other .props files. Those files will be ignored by jEdit's versions older than 5.0 and do not cause any problem See <a href="http://sourceforge.net/apps/mediawiki/jedit/index.php?title=Localizati jEdit's localization wiki </ul> For a plugin to actually do something once it is resident in memory, it must contain a class whose name ends with <code>Plugin</code>. This class, known as the <i>plugin core class</i> must extend <a href="EditPlugin.html" title="class in org.gjt.sp.jedit"><code>EditPlugin</code></a> and ignored. <h3>Dynamic and deferred loading</h3> Unlike in prior jEdit versions, jEdit 4.2 and later allow plugins to be added and removed to the resident set at any time using the <a href="jEdit.html#addPluginJAR(java.lang.String)"><code>jEdit.addPluginJAR(Strin <a href="jEdit.html#removePluginJAR(org.gjt.sp.jedit.PluginJAR,boolean)"><code>jEdit. plugin core class might not be loaded until the plugin is first used. See <a href="EditPlugin.html#start()"><code>EditPlugin.start()</code></a> for a full description.< <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="jEdit.html#getProperty(java.lang.String)"><code>jEdit.getProperty(String)</ <a href="jEdit.html#getPlugin(java.lang.String)"><code>jEdit.getPlugin(String)</code></a> <a href="jEdit.html#getPlugins()"><code>jEdit.getPlugins()</code></a>, <a href="jEdit.html#getPluginJAR(java.lang.String)"><code>jEdit.getPluginJAR(String)</ <a href="jEdit.html#getPluginJARs()"><code>jEdit.getPluginJARs()</code></a>, <a href="jEdit.html#addPluginJAR(java.lang.String)"><code>jEdit.addPluginJAR(String)</ <a href="jEdit.html#removePluginJAR(org.gjt.sp.jedit.PluginJAR,boolean)"><code>jEdit. <a href="ActionSet.html" title="class in org.gjt.sp.jedit"><code>ActionSet</code></a>, <a href="gui/DockableWindowManager.html" title="class in org.gjt.sp.jedit.gui"><code>D <a href="OptionPane.html" title="interface in org.gjt.sp.jedit"><code>OptionPane</code></ <a href="PluginJAR.html" title="class in org.gjt.sp.jedit"><code>PluginJAR</code></a>, <a href="ServiceManager.html" title="class in org.gjt.sp.jedit"><code>ServiceManager</c </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="memberSummary"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Class</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PluginJAR.Plu <td class="colLast"> <div class="block">Used by the <code>DockableWindowManager</code> and <code>ServiceManager</code> to handle caching.</div> </td> </tr> </table> </li> </ul> </section> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Constructor</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3C <td class="colLast"> <div class="block">Creates a PluginJAR object which is not necessarily loaded, but can be later </td> </tr> </table> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </sp <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activatePlug <td class="colLast"> <div class="block">Loads the plugin core class.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activatePlug <td class="colLast"> <div class="block">Should be called after a new plugin is installed.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>boolean</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkDepende <td class="colLast"> <div class="block">Returns true if all dependencies are satisified, false otherwise.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deactivatePl <td class="colLast"> <div class="block">Unloads the plugin core class.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findPlugin(j <td class="colLast"> <div class="block">Unlike getPlugin(), will return a PluginJAR that is not yet loaded, given its classname.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="PluginJAR.PluginCacheEntry.html" title="class in org <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateCach <td class="colLast"> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="ActionSet.html" title="class in org.gjt.sp.jedit">Act <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActionSet <td class="colLast"> <div class="block">Returns the plugin's action set for the jEdit action context <a href="jEdit.html#getActionContext()"><code>jEdit.getActionContext()</code></a>.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllDepend <td class="colLast"> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code><a href="ActionSet.html" title="class in org.gjt.sp.jedit">Act <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBrowserAc <td class="colLast"> <div class="block">Returns the plugin's action set for the file system browser action context <a href="browser/VFSBrowser.html#getActionContext()"><code>VFSBrowser.getActio </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCachePath <td class="colLast"> <div class="block">Returns the full path name of this plugin's summary file. </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code><a href="JARClassLoader.html" title="class in org.gjt.sp.jedi <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassLoad <td class="colLast"> <div class="block">Returns the plugin's class loader. </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDependenc <td class="colLast"> <div class="block">Returns a list of dependencies by searching the plugin properties.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDependenc <td class="colLast"> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDependent <td class="colLast"> </td> </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>java.net.URL</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDockables <td class="colLast"> <div class="block">Returns the location of the plugin's <code>dockables.xml</code> file.</div> </td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFile()">ge <td class="colLast"> <div class="block">Returns a file pointing to the plugin JAR.</div> </td> </tr> <tr id="i16" class="altColor"> <td class="colFirst"><code>java.util.Collection<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFiles()">g <td class="colLast"> <div class="block">Get the files listed in this plugin and return full paths to them</div> </td> </tr> <tr id="i17" class="rowColor"> <td class="colFirst"><code>java.util.Collection<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJars()">ge <td class="colLast"> <div class="block">Get the jars listed in this plugin and return full paths to them</div> </td> </tr> <tr id="i18" class="altColor"> <td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptionalD <td class="colLast"> <div class="block">Returns a list of optional dependencies by searching the plugin properties </td> </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptionall <td class="colLast"> </td> </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">ge <td class="colLast"> <div class="block">Returns the full path name of this plugin's JAR file. </td> </tr> <tr id="i21" class="rowColor"> <td class="colFirst"><code><a href="EditPlugin.html" title="class in org.gjt.sp.jedit">Ed <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlugin()"> <td class="colLast"> <div class="block">Returns the plugin core class for this JAR file.</div> </td> </tr> <tr id="i22" class="altColor"> <td class="colFirst"><code>static <a href="PluginJAR.PluginCacheEntry.html" title="class <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginCac <td class="colLast"> </td> </tr> <tr id="i23" class="rowColor"> <td class="colFirst"><code>static <a href="PluginJAR.PluginCacheEntry.html" title="class <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginCac <td class="colLast"> <div class="block">Returns the cache entry for an installed but not loaded plugin.</div> </td> </tr> <tr id="i24" class="altColor"> <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequiredJ <td class="colLast"> <div class="block">Returns the required jars of this plugin.</div> </td> </tr> <tr id="i25" class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResources <td class="colLast"> </td> </tr> <tr id="i26" class="altColor"> <td class="colFirst"><code>java.net.URL</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServicesU <td class="colLast"> <div class="block">Returns the location of the plugin's <code>services.xml</code> file.</div> </td> </tr> <tr id="i27" class="rowColor"> <td class="colFirst"><code>java.util.zip.ZipFile</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getZipFile() <td class="colLast"> <div class="block">Returns the plugin's JAR file, opening it if necessary. </td> </tr> <tr id="i28" class="altColor"> <td class="colFirst"><code>boolean</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init()">init</ <td class="colLast"> </td> </tr> <tr id="i29" class="rowColor"> <td class="colFirst"><code>static <a href="PluginJAR.html" title="class in org.gjt.sp.jed <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#load(java.la boolean loadDependents)</code></th> <td class="colLast"> <div class="block">Loads a plugin, and its dependent plugins if necessary.</div> </td> </tr> <tr id="i30" class="altColor"> <td class="colFirst"><code>static java.util.Collection<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseJarsFil java.lang.String jarsString)</code></th> <td class="colLast"> <div class="block">parse the files listed in plugin.CLASSNAME.jars or plugin.CLASSNAME.fil and return full paths to each file of the list.</div> </td> </tr> <tr id="i31" class="rowColor"> <td class="colFirst"><code>static java.util.Collection<java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseJarsFil <td class="colLast"> <div class="block">parse the files listed in plugin.CLASSNAME.jars or plugin.CLASSNAME.fil and return them as a collection</div> </td> </tr> <tr id="i32" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">t <td class="colLast"> </td> </tr> <tr id="i33" class="rowColor"> <td class="colFirst"><code>static void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitiveCl java.util.List<java.lang.String> listModel)</code></th> <td class="colLast"> <div class="block">If plugin A is needed by B, and B is needed by C, we want to tell the user that A is needed by B and C when they try to unload A.</div> </td> </tr> <tr id="i34" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#uninit(boole <td class="colLast"> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code>< </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(java.io.File)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>PluginJAR</h4> <pre>public PluginJAR(java.io.File file)</pre> <div class="block">Creates a PluginJAR object which is not necessarily loaded, but can be later <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="#load(java.lang.String,boolean)"><code>load(String, boolean)</code></a></dd> </dl> </li> </ul> </li> </ul> </section> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="load(java.lang.String,boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>load</h4> <pre class="methodSignature">public static <a href="PluginJAR.html" title="class in org. boolean loadDependents)</pre> <div class="block">Loads a plugin, and its dependent plugins if necessary.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.3pre7</dd> </dl> </li> </ul> <a id="parseJarsFilesString(java.lang.String,java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>parseJarsFilesString</h4> <pre class="methodSignature">public static java.util.Collection<java.lang.String> parseJ java.lang.String jarsString)</pre> <div class="block">parse the files listed in plugin.CLASSNAME.jars or plugin.CLASSNAME.fil and return full paths to each file of the list.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 5.3pre1</dd> </dl> </li> </ul> <a id="parseJarsFilesStringNames(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>parseJarsFilesStringNames</h4> <pre class="methodSignature">public static java.util.Collection<java.lang.String> parseJ <div class="block">parse the files listed in plugin.CLASSNAME.jars or plugin.CLASSNAME.fil and return them as a collection</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 5.3pre1</dd> </dl> </li> </ul> <a id="getJars()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getJars</h4> <pre class="methodSignature">public java.util.Collection<java.lang.String> getJars()</pr <div class="block">Get the jars listed in this plugin and return full paths to them</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>jars full paths or empty collection if plugin is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 5.3pre1</dd> </dl> </li> </ul> <a id="getFiles()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFiles</h4> <pre class="methodSignature">public java.util.Collection<java.lang.String> getFiles()</p <div class="block">Get the files listed in this plugin and return full paths to them</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>files full paths or empty collection if plugin is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 5.3pre1</dd> </dl> </li> </ul> <a id="getPath()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPath</h4> <pre class="methodSignature">public java.lang.String getPath()</pre> <div class="block">Returns the full path name of this plugin's JAR file. </li> </ul> <a id="findPlugin(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findPlugin</h4> <pre class="methodSignature">public static java.lang.String findPlugin(java.lang.Strin <div class="block">Unlike getPlugin(), will return a PluginJAR that is not yet loaded, given its classname.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>className</code> - a class name</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the JARpath of the first PluginJAR it can find which contains this className, or null if not found.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>4.3pre7</dd> </dl> </li> </ul> <a id="getCachePath()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCachePath</h4> <pre class="methodSignature">public java.lang.String getCachePath()</pre> <div class="block">Returns the full path name of this plugin's summary file. The summary file is used to store certain information which allows loading of the plugin's resources and core class to be deferred until the plugin is first used. As long as a plugin is using the jEdit 4.2 plugin API, no extra effort is required to take advantage of the summary cache.</div> </li> </ul> <a id="getDependencySet(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDependencySet</h4> <pre class="methodSignature">public static java.util.Set<java.lang.String> getDependency <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>className</code> - of a plugin that we wish to load</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>an ordered set of JARpaths that contains the plugins that need to be (re)loaded, in the correct order.</dd> </dl> </li> </ul> <a id="getFile()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFile</h4> <pre class="methodSignature">public java.io.File getFile()</pre> <div class="block">Returns a file pointing to the plugin JAR.</div> </li> </ul> <a id="getClassLoader()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClassLoader</h4> <pre class="methodSignature">public <a href="JARClassLoader.html" title="class in org.g <div class="block">Returns the plugin's class loader. </li> </ul> <a id="getZipFile()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getZipFile</h4> <pre class="methodSignature">public java.util.zip.ZipFile getZipFile() throws java.io.IOException</pre> <div class="block">Returns the plugin's JAR file, opening it if necessary. <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="getActionSet()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getActionSet</h4> <pre class="methodSignature">public <a href="ActionSet.html" title="class in org.gjt.sp <div class="block">Returns the plugin's action set for the jEdit action context <a href="jEdit.html#getActionContext()"><code>jEdit.getActionContext()</code></a>. These ac the <code>actions.xml</code> file; see <a href="ActionSet.html" title="class in org.gjt.sp. .</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="getBrowserActionSet()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getBrowserActionSet</h4> <pre class="methodSignature">public <a href="ActionSet.html" title="class in org.gjt.sp <div class="block">Returns the plugin's action set for the file system browser action context <a href="browser/VFSBrowser.html#getActionContext()"><code>VFSBrowser.getActio These actions are loaded from the <code>browser.actions.xml</code> file; see <a href="ActionSet.html" title="class in org .</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="checkDependencies()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>checkDependencies</h4> <pre class="methodSignature">public boolean checkDependencies()</pre> <div class="block">Returns true if all dependencies are satisified, false otherwise. Also if dependencies are not satisfied, the plugin is marked as "broken".</div> </li> </ul> <a id="getRequiredJars()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRequiredJars</h4> <pre class="methodSignature">public java.util.Set<java.lang.String> getRequiredJars()</p <div class="block">Returns the required jars of this plugin.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the required jars of this plugin</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.3pre12</dd> </dl> </li> </ul> <a id="getDependencies(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDependencies</h4> <pre class="methodSignature">@Nonnull public static java.util.Set<java.lang.String> getDependencies(java.lang.String classna throws java.lang.IllegalArgumentException</pre> <div class="block">Returns a list of dependencies by searching the plugin properties.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>classname</code> - The classname of a plugin</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>A list of classnames of plugins the plugin depends on.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code></dd> </dl> </li> </ul> <a id="getOptionalDependencies(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOptionalDependencies</h4> <pre class="methodSignature">public static java.util.Set<java.lang.String> getOptionalDe throws java.lang.IllegalArgumentException</pre> <div class="block">Returns a list of optional dependencies by searching the plugin properties <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>classname</code> - The classname of a plugin</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>A list of classnames of plugins the plugin optionally depends on.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code></dd> </dl> </li> </ul> <a id="transitiveClosure(java.lang.String[],java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>transitiveClosure</h4> <pre class="methodSignature">public static void transitiveClosure(java.lang.String[] de java.util.List<java.lang.String> listModel)</pre> <div class="block">If plugin A is needed by B, and B is needed by C, we want to tell the user that A is needed by B and C when they try to unload A.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dependents</code> - a set of plugins which we wish to disable</dd> <dd><code>listModel</code> - a set of plugins which will be affected, and will need to be disabled also.</dd> </dl> </li> </ul> <a id="getDependentPlugins()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDependentPlugins</h4> <pre class="methodSignature">public java.lang.String[] getDependentPlugins()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an array of plugin names that have a hard dependency on this plugin</dd> </dl> </li> </ul> <a id="getOptionallyDependentPlugins()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOptionallyDependentPlugins</h4> <pre class="methodSignature">public java.lang.String[] getOptionallyDependentPlugins( <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an array of plugin names that have an optional dependency on this plugin</dd> </dl> </li> </ul> <a id="getAllDependentPlugins()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllDependentPlugins</h4> <pre class="methodSignature">public java.lang.String[] getAllDependentPlugins()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an array of plugin names that have a dependency or an optional dependency on this plugin, this returns a combination of <code>getDependentPlugins</code> and <code>getOptionallyDepende </dl> </li> </ul> <a id="getPlugin()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlugin</h4> <pre class="methodSignature">public <a href="EditPlugin.html" title="class in org.gjt.s <div class="block">Returns the plugin core class for this JAR file. Note that if the plugin has not been activated, this will return an instance of <a href="EditPlugin.Deferred.html" title="class in org.gjt.sp.jedit"><code>EditPlugin. class instance, call <a href="#activatePlugin()"><code>activatePlugin()</code></a> first. If the plugin is not yet loaded, returns null</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="activatePlugin()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>activatePlugin</h4> <pre class="methodSignature">public void activatePlugin()</pre> <div class="block">Loads the plugin core class. Does nothing if the plugin core class has already been loaded. This method might be called on startup, depending on what properties are set. See <a href="EditPlugin.html#start()"><code>EditPlugin This method is thread-safe.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="activatePluginIfNecessary()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>activatePluginIfNecessary</h4> <pre class="methodSignature">public void activatePluginIfNecessary()</pre> <div class="block">Should be called after a new plugin is installed.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre2</dd> </dl> </li> </ul> <a id="deactivatePlugin(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>deactivatePlugin</h4> <pre class="methodSignature">public void deactivatePlugin(boolean exit)</pre> <div class="block">Unloads the plugin core class. Does nothing if the plugin core class has not been loaded. This method can only be called from the AWT event dispatch thread!</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre3</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="EditPlugin.html#stop()"><code>EditPlugin.stop()</code></a></dd> </dl> </li> </ul> <a id="getDockablesURI()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDockablesURI</h4> <pre class="methodSignature">public java.net.URL getDockablesURI()</pre> <div class="block">Returns the location of the plugin's <code>dockables.xml</code> file.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="getServicesURI()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getServicesURI</h4> <pre class="methodSignature">public java.net.URL getServicesURI()</pre> <div class="block">Returns the location of the plugin's <code>services.xml</code> file.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 4.2pre1</dd> </dl> </li> </ul> <a id="toString()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre class="methodSignature">public java.lang.String toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a id="getPluginCache(org.gjt.sp.jedit.PluginJAR)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPluginCache</h4> <pre class="methodSignature">public static <a href="PluginJAR.PluginCacheEntry.html" tit </li> </ul> <a id="getPluginCacheEntry(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPluginCacheEntry</h4> <pre class="methodSignature">public static <a href="PluginJAR.PluginCacheEntry.html" tit throws java.io.IOException</pre> <div class="block">Returns the cache entry for an installed but not loaded plugin. There is no need to use this method if the plugin is loaded.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>path</code> - path to the the plugin jar</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>cache entry or null</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code> - if jEdit cannot generate cache</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>jEdit 5.3pre1</dd> </dl> </li> </ul> <a id="init()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>init</h4> <pre class="methodSignature">public boolean init()</pre> </li> </ul> <a id="uninit(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>uninit</h4> <pre class="methodSignature">public void uninit(boolean exit)</pre> </li> </ul> <a id="getResources()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResources</h4> <pre class="methodSignature">public java.lang.String[] getResources()</pre> </li> </ul> <a id="generateCache()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>generateCache</h4> <pre class="methodSignature">public <a href="PluginJAR.PluginCacheEntry.html" title="cl throws java.io.IOException</pre> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip na <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/PluginJAR.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html> ¤ Dauer der Verarbeitung: 0.182 Sekunden (vorverarbeitet) ¤ |
Haftungshinweis
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:Die farbliche Syntaxdarstellung ist noch experimentell.Bot Zugriff |
