diff options
| author | Konrad Kolosowski | 2003-02-28 18:08:42 +0000 |
|---|---|---|
| committer | Konrad Kolosowski | 2003-02-28 18:08:42 +0000 |
| commit | a65f6bfe8e57a91c899e7fa7aa9c19ce40f1f3af (patch) | |
| tree | 915380695de9d139e52d5d2e4f8300ed20092ccd | |
| parent | c309ecad242b0194f99af463316188b6813e82d0 (diff) | |
| download | eclipse.platform.ua-a65f6bfe8e57a91c899e7fa7aa9c19ce40f1f3af.tar.gz eclipse.platform.ua-a65f6bfe8e57a91c899e7fa7aa9c19ce40f1f3af.tar.xz eclipse.platform.ua-a65f6bfe8e57a91c899e7fa7aa9c19ce40f1f3af.zip | |
finishing cleanup of old org.eclipse.help.ui.browser ext point
15 files changed, 17 insertions, 278 deletions
diff --git a/org.eclipse.help.ui/.classpath b/org.eclipse.help.ui/.classpath index 4f2ada38d..c5cfc924b 100644 --- a/org.eclipse.help.ui/.classpath +++ b/org.eclipse.help.ui/.classpath @@ -1,14 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" path="src/"/> - <classpathentry kind="src" path="/org.eclipse.core.resources"/> - <classpathentry kind="src" path="/org.eclipse.help"/> - <classpathentry kind="src" path="/org.eclipse.search"/> - <classpathentry kind="src" path="/org.eclipse.ui"/> - <classpathentry kind="src" path="/org.eclipse.tomcat"/> - <classpathentry kind="src" path="/org.eclipse.core.runtime"/> - <classpathentry kind="src" path="/org.eclipse.core.boot"/> - <classpathentry kind="var" path="JRE_LIB" sourcepath="JRE_SRC"/> - <classpathentry kind="src" path="/org.eclipse.help.appserver"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> <classpathentry kind="output" path="bin"/> </classpath> diff --git a/org.eclipse.help.ui/.project b/org.eclipse.help.ui/.project index 787f76c7e..d292740cc 100644 --- a/org.eclipse.help.ui/.project +++ b/org.eclipse.help.ui/.project @@ -3,14 +3,8 @@ <name>org.eclipse.help.ui</name> <comment></comment> <projects> - <project>org.eclipse.core.boot</project> - <project>org.eclipse.core.resources</project> - <project>org.eclipse.core.runtime</project> <project>org.eclipse.help</project> <project>org.eclipse.help.appserver</project> - <project>org.eclipse.search</project> - <project>org.eclipse.tomcat</project> - <project>org.eclipse.ui</project> </projects> <buildSpec> <buildCommand> diff --git a/org.eclipse.help.ui/doc/hglegal2002.htm b/org.eclipse.help.ui/doc/hglegal2002.htm deleted file mode 100644 index b8c411f08..000000000 --- a/org.eclipse.help.ui/doc/hglegal2002.htm +++ /dev/null @@ -1,14 +0,0 @@ -<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <LINK REL="STYLESHEET" HREF="book.css" CHARSET="ISO-8859-1" TYPE="text/css">
- <title>Legal Notices</title>
-</head>
-<body>
-
-<h3>
-<a NAME="Notices"></a>Notices</h3>
-(c) Copyright IBM Corp. and others 2000, 2002. All Rights Reserved.
-</body>
-</html>
diff --git a/org.eclipse.help.ui/doc/ngibmcpy2002.gif b/org.eclipse.help.ui/doc/ngibmcpy2002.gif Binary files differdeleted file mode 100644 index 61cef4852..000000000 --- a/org.eclipse.help.ui/doc/ngibmcpy2002.gif +++ /dev/null diff --git a/org.eclipse.help.ui/doc/org_eclipse_help_ui_browser.html b/org.eclipse.help.ui/doc/org_eclipse_help_ui_browser.html deleted file mode 100644 index f3a56855d..000000000 --- a/org.eclipse.help.ui/doc/org_eclipse_help_ui_browser.html +++ /dev/null @@ -1,72 +0,0 @@ -<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
- <title>org.eclipse.help.browser</title>
-</head>
-<body link="#0000FF" vlink="#800080">
-
-<table BORDER COLS=1 WIDTH="100%" >
-<tr>
-<td><b>Note: The help system is still under development and can be expected
-to change somewhat before reaching stability. It is being made available
-at this stage to solicit feedback from early adopters, on the understanding
-that the details of the contribution mechanisms might change in breaking
-ways.</b></td>
-</tr>
-</table>
-
-<center>
-<h1>
-Browser</h1></center>
-<b><i>Identifier: </i></b>org.eclipse.help.browser
-<p><b><i>Description:</i></b> For providing web browsers capable of displaying
-html documents at given URL<br>This extension point was added in 2.0.
-<p><b><i>Configuration Markup:</i></b>
-<p><tt> <!ELEMENT browser EMPTY></tt>
-<br><tt> <!ATTLIST browser id CDATA #REQUIRED</tt> <tt>></tt>
-<br><tt> <!ATTLIST browser factoryclass CDATA #REQUIRED></tt>
-<br><tt> <!ATTLIST browser name CDATA #REQUIRED</tt> <tt>></tt>
-<ul>
-<li>
-<b>id</b> - the unique ID of the browser.</li>
-</ul>
-
-<ul>
-<li>
-<b>factoryclass</b> - the implementation class for the browser factory.
-This class must implement the <tt>org.eclipse.help.ui.IBrowserFactory</tt>
-interface.</li>
-</ul>
-
-<ul>
-<li>
-<b>name</b> - the name of the browser (translatable).</li>
-</ul>
-<b><i>Examples:</i></b>
-<p>The following is a sample usage of the browser extension point:
-<p>(in file <tt>plugin.xml</tt>)
-<p><tt> <extension point="org.eclipse.help.browser"></tt>
-<br><tt> <browser id="org.eclipse.myPlugin.myBrowserID"</tt>
-<br><tt> factoryclass="org.eclipse.myPlugin.myPackage.MyFactoryClass"</tt>
-<br><tt> name="My Browser" /></tt>
-<br><tt> </extension></tt>
-<p><b><i>API Information</i>: </b>The supplied factory class must implement
-the
-<tt>org.eclipse.help.ui.IBrowserFactory</tt> interface. Methods in
-that interface determine whether the factory is available on the given
-system, i.e. is capable of supplying browser instances, and create browser
-instances that implement IBrowser interface.
-<p><i><b>Supplied Implementation:</b> </i>The <tt>org.eclipse.help.ui</tt>
-plug-in contains implementation of a browsers on common platforms.
-Other plugins can provide different implementation. In the preferences,
-user can select the default browser from among available browsers.
-
-<p><br>
-<a href="hglegal2002.htm"><img src="ngibmcpy2002.gif" alt=
-"Copyright IBM Corp. and others 2000, 2002. All Rights Reserved." border="0"></a>
-</p>
-
-</body>
-</html>
diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowser.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowser.java deleted file mode 100644 index baa154041..000000000 --- a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowser.java +++ /dev/null @@ -1,13 +0,0 @@ -/* - * (c) Copyright IBM Corp. 2000, 2002. - * All Rights Reserved. - */ -package org.eclipse.help.ui.browser; -/** - * Represents a web browser that can be used - * by clients to display documents for the given URLs. - * @deprecated Use the org.eclipse.help.browser.IBrowser instead. - */ -public interface IBrowser extends org.eclipse.help.browser.IBrowser { -} - diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowserFactory.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowserFactory.java deleted file mode 100644 index a666e7b7f..000000000 --- a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/IBrowserFactory.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * (c) Copyright IBM Corp. 2000, 2002. - * All Rights Reserved. - */ -package org.eclipse.help.ui.browser; -/** - * Implementators of org.eclipse.help.ui.browsers - * extension points must provide implementation of this - * interface. - * @deprecated Use the org.eclipse.help.browser.IBrowserFactory instead. - */ -public interface IBrowserFactory { - /** - * Checks whether the factory can work on the user system. - * @return false if the factory cannot work on this system; - * for example the required native browser required - * by browser adapters that it creates is not installed. - */ - public boolean isAvailable(); - /** - * Obtains a new instance of a web browser. - * @return instance of IBrowser - */ - public IBrowser createBrowser(); -}
\ No newline at end of file diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/package.html b/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/package.html index f7a8c16be..16bc2a435 100644 --- a/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/package.html +++ b/org.eclipse.help.ui/src/org/eclipse/help/ui/browser/package.html @@ -7,36 +7,10 @@ <title>Package-level Javadoc</title>
</head>
<body>
-Provides interfaces that need to be implemented by
-web browser adapters. Also contains an implementation of IWorkbenchWindowActionDelegate
+Provides an implementation of IWorkbenchWindowActionDelegate
for opening a URL in a browser.
<h2>
Package Specification</h2>
-Help System UI, requires web browser to display help document. Since
-availability of web browsers differ from system to system, it is possible
-to configure browser adapters in addition to ones provided by Help System
-UI plugin. The browser (or browser adapter) can be configured by
-providing extension <tt>org.eclipse.help.ui.browser</tt> extension point.
-If more than one browser is available on a user system, the default browser
-can be designated in Web Help preference page.
-<p>In general terms, implementing a web browser involves:
-<ul>
-<li>
-Implementing standalone UI element having the <tt>IBrowser</tt> API, and
-capable of displaying HTML documents given a URL.</li>
-
-<li>
-Providing a factory for managing of browsers on a particular system, by
-implementing <tt>IBrowserFactory</tt> interface.</li>
-
-<li>
-Declaring an extension of the <tt>org.eclipse.help.ui.browser</tt> extension
-point that mentions the name of that factory class.</li>
-</ul>
-Note that browser factory will be created on every system. If the
-factory is not capable of creating a browser on some system configurations,
-due to missing prerequisites e.t.c., its <tt>isAvailable()</tt> method
-should be returning false on these systems.
<p>LaunchURL class implementing <tt>IWorkbenchWindowActionDelegate</tt>
is an action that can be specified in the <tt>action</tt> element in plugin.xml
for extensions of <tt>org.eclipse.ui.actionSets</tt> extension point.
diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/browser/BrowserManager.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/browser/BrowserManager.java deleted file mode 100644 index 865efbdac..000000000 --- a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/browser/BrowserManager.java +++ /dev/null @@ -1,98 +0,0 @@ -/* - * (c) Copyright IBM Corp. 2000, 2002. - * All Rights Reserved. - */ -package org.eclipse.help.ui.internal.browser; -import org.eclipse.help.ui.browser.*; - -/** - * Creates browser by delegating - * to appropriate browser adapter - * @deprecated Use org.eclipse.help.interna - */ -public class BrowserManager { - private static BrowserManager instance; - - /** - * Private Constructor - */ - private BrowserManager() { - } - /** - * Obtains singleton instance. - */ - public static BrowserManager getInstance() { - if (instance == null) - instance = new BrowserManager(); - return instance; - } - - /** - * Creates web browser - */ - public IBrowser createBrowser() { - return new Browser(org.eclipse.help.internal.browser.BrowserManager.getInstance().createBrowser()); - } - - /** - * Closes all browsers created - */ - public void closeAll() { - } - - class Browser implements IBrowser { - private org.eclipse.help.browser.IBrowser browser; - public Browser(org.eclipse.help.browser.IBrowser browser) { - this.browser = browser; - } - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#close() - */ - public void close() { - browser.close(); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#displayURL(java.lang.String) - */ - public void displayURL(String url) throws Exception { - browser.displayURL(url); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#isCloseSupported() - */ - public boolean isCloseSupported() { - return browser.isCloseSupported(); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#isSetLocationSupported() - */ - public boolean isSetLocationSupported() { - return browser.isSetLocationSupported(); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#isSetSizeSupported() - */ - public boolean isSetSizeSupported() { - return browser.isSetSizeSupported(); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#setLocation(int, int) - */ - public void setLocation(int x, int y) { - browser.setLocation(x,y); - } - - /* (non-Javadoc) - * @see org.eclipse.help.browser.IBrowser#setSize(int, int) - */ - public void setSize(int width, int height) { - browser.setSize(width,height); - } - - } -}
\ No newline at end of file diff --git a/org.eclipse.help/doc/org_eclipse_help.html b/org.eclipse.help/doc/org_eclipse_help.html index 630559d94..551019de9 100644 --- a/org.eclipse.help/doc/org_eclipse_help.html +++ b/org.eclipse.help/doc/org_eclipse_help.html @@ -28,6 +28,7 @@ for plugging in a a help system UI.</p> <h1>Extension Points</h1>
The following extension points can be used to extend the help system:
<ul>
+ <li><a href="org_eclipse_help_browser.html">org.eclipse.help.browser</a></li>
<li><a href="org_eclipse_help_contexts.html">org.eclipse.help.contexts</a></li>
<li><a href="org_eclipse_help_luceneAnalyzer.html">org.eclipse.help.luceneAnalyzer</a></li>
<li><a href="org_eclipse_help_support.html">org.eclipse.help.support</a></li>
diff --git a/org.eclipse.help/schema/browser.mxsd b/org.eclipse.help/schema/browser.mxsd index c190511b6..dbd775f64 100644 --- a/org.eclipse.help/schema/browser.mxsd +++ b/org.eclipse.help/schema/browser.mxsd @@ -117,7 +117,7 @@ <p> <pre> - <extension point="org.eclipse.help.ui.browser"> + <extension point="org.eclipse.help.browser"> <browser id="org.eclipse.myPlugin.myBrowserID" factoryClass="org.eclipse.myPlugin.myPackage.MyFactoryClass" @@ -134,7 +134,7 @@ <meta.section type="apiInfo"/>
</appInfo>
<documentation>
- The supplied factory class must implement the <samp>org.eclipse.help.ui.IBrowserFactory</samp> interface. + The supplied factory class must implement the <samp>org.eclipse.help.IBrowserFactory</samp> interface. Methods in that interface determine whether the factory is available on the given system, i.e. is capable of supplying browser instances, and create browser instances that implement IBrowser interface.
</documentation>
@@ -145,7 +145,7 @@ of supplying browser instances, and create browser instances that implement IBro <meta.section type="implementation"/>
</appInfo>
<documentation>
- The <samp>org.eclipse.help.ui</samp> plug-in contains implementation of a browser on common platforms. + The <samp>org.eclipse.help</samp> and <samp>org.eclipse.help.ui</samp> plug-ins contain implementation of browsers on common platforms. Other plug-ins can provide different implementations. In the preferences, the user can select the default browser from among available browsers.
</documentation>
diff --git a/org.eclipse.help/src/org/eclipse/help/browser/IBrowser.java b/org.eclipse.help/src/org/eclipse/help/browser/IBrowser.java index 8a561e0fc..1ad31d573 100644 --- a/org.eclipse.help/src/org/eclipse/help/browser/IBrowser.java +++ b/org.eclipse.help/src/org/eclipse/help/browser/IBrowser.java @@ -1,12 +1,12 @@ /* - * (c) Copyright IBM Corp. 2000, 2002. + * (c) Copyright IBM Corp. 2000, 2003. * All Rights Reserved. */ package org.eclipse.help.browser; /** * Represents a web browser that can be used * by clients to display documents for the given URLs. - * @since 2.0 + * @since 2.1 */ public interface IBrowser { /** diff --git a/org.eclipse.help/src/org/eclipse/help/browser/IBrowserFactory.java b/org.eclipse.help/src/org/eclipse/help/browser/IBrowserFactory.java index 54d27259a..b61161f56 100644 --- a/org.eclipse.help/src/org/eclipse/help/browser/IBrowserFactory.java +++ b/org.eclipse.help/src/org/eclipse/help/browser/IBrowserFactory.java @@ -1,5 +1,5 @@ /* - * (c) Copyright IBM Corp. 2000, 2002. + * (c) Copyright IBM Corp. 2000, 2003. * All Rights Reserved. */ package org.eclipse.help.browser; @@ -7,7 +7,7 @@ package org.eclipse.help.browser; * Implementators of org.eclipse.help.ui.browsers * extension points must provide implementation of this * interface. - * @since 2.0 + * @since 2.1 */ public interface IBrowserFactory { /** diff --git a/org.eclipse.help/src/org/eclipse/help/browser/package.html b/org.eclipse.help/src/org/eclipse/help/browser/package.html index 0088e80dd..656a98351 100644 --- a/org.eclipse.help/src/org/eclipse/help/browser/package.html +++ b/org.eclipse.help/src/org/eclipse/help/browser/package.html @@ -8,16 +8,15 @@ </head> <body> Provides interfaces that need to be implemented by -web browser adapters. . +web browser adapters. <h2> Package Specification</h2> -Help System UI, requires web browser to display help document. Since +Help System, requires web browser to display help document. Since availability of web browsers differ from system to system, it is possible -to configure browser adapters in addition to ones provided by Help System -UI plugin. The browser (or browser adapter) can be configured by -providing extension <tt>org.eclipse.help.browser</tt> extension point. +to configure browser adapters in addition to ones provided by Help System. The browser (or browser adapter) can be configured by +providing extension for <tt>org.eclipse.help.browser</tt> extension point. If more than one browser is available on a user system, the default browser -can be designated in Web Help preference page. +can be designated in Help preference page. <p>In general terms, implementing a web browser involves: <ul> <li> diff --git a/org.eclipse.help/src/org/eclipse/help/internal/browser/BrowserManager.java b/org.eclipse.help/src/org/eclipse/help/internal/browser/BrowserManager.java index 7c6277d76..c9fa4362b 100644 --- a/org.eclipse.help/src/org/eclipse/help/internal/browser/BrowserManager.java +++ b/org.eclipse.help/src/org/eclipse/help/internal/browser/BrowserManager.java @@ -1,5 +1,5 @@ /* - * (c) Copyright IBM Corp. 2000, 2002. + * (c) Copyright IBM Corp. 2000, 2003. * All Rights Reserved. */ package org.eclipse.help.internal.browser; |
