From 8a58482bbea4a761e312bcf46a28d11709325da7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D0=BB=D0=B5=D0=BA=D1=81=D0=B0=D0=BD=D0=B4=D1=8A?= =?UTF-8?q?=D1=80=20=D0=9A=D1=83=D1=80=D1=82=D0=B0=D0=BA=D0=BE=D0=B2?= Date: Wed, 24 Dec 2025 11:32:04 +0200 Subject: [PATCH] Delete IHelp API Deprecated since 3.0 and marked for removal since 2023-12. One should use org.eclipse.help.HelpSystem#getTocs() and org.eclipse.help.HelpSystem#getContext(String). --- .../.settings/.api_filters | 14 + ua/org.eclipse.help.base/META-INF/MANIFEST.MF | 2 +- ua/org.eclipse.help.base/pom.xml | 2 +- ua/org.eclipse.help/.settings/.api_filters | 19 ++ ua/org.eclipse.help/META-INF/MANIFEST.MF | 2 +- ua/org.eclipse.help/pom.xml | 2 +- .../src/org/eclipse/help/IHelp.java | 257 ------------------ 7 files changed, 37 insertions(+), 261 deletions(-) create mode 100644 ua/org.eclipse.help/.settings/.api_filters delete mode 100644 ua/org.eclipse.help/src/org/eclipse/help/IHelp.java diff --git a/ua/org.eclipse.help.base/.settings/.api_filters b/ua/org.eclipse.help.base/.settings/.api_filters index a95275fa2e1..43430296a4b 100644 --- a/ua/org.eclipse.help.base/.settings/.api_filters +++ b/ua/org.eclipse.help.base/.settings/.api_filters @@ -1,6 +1,12 @@ + + + + + + @@ -266,4 +272,12 @@ + + + + + + + + diff --git a/ua/org.eclipse.help.base/META-INF/MANIFEST.MF b/ua/org.eclipse.help.base/META-INF/MANIFEST.MF index a1f05320bb7..0ec71fb21b1 100644 --- a/ua/org.eclipse.help.base/META-INF/MANIFEST.MF +++ b/ua/org.eclipse.help.base/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %help_base_plugin_name Bundle-SymbolicName: org.eclipse.help.base; singleton:=true -Bundle-Version: 4.5.400.qualifier +Bundle-Version: 4.6.0.qualifier Bundle-Activator: org.eclipse.help.internal.base.HelpBasePlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/ua/org.eclipse.help.base/pom.xml b/ua/org.eclipse.help.base/pom.xml index 0b759e7cb76..1172cd8f73f 100644 --- a/ua/org.eclipse.help.base/pom.xml +++ b/ua/org.eclipse.help.base/pom.xml @@ -18,7 +18,7 @@ org.eclipse.platform org.eclipse.help.base - 4.5.400-SNAPSHOT + 4.6.0-SNAPSHOT eclipse-plugin true diff --git a/ua/org.eclipse.help/.settings/.api_filters b/ua/org.eclipse.help/.settings/.api_filters new file mode 100644 index 00000000000..c550bad5ff9 --- /dev/null +++ b/ua/org.eclipse.help/.settings/.api_filters @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/ua/org.eclipse.help/META-INF/MANIFEST.MF b/ua/org.eclipse.help/META-INF/MANIFEST.MF index 6748817b1e7..b2bfb185af5 100644 --- a/ua/org.eclipse.help/META-INF/MANIFEST.MF +++ b/ua/org.eclipse.help/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %help_plugin_name Bundle-SymbolicName: org.eclipse.help; singleton:=true -Bundle-Version: 3.10.600.qualifier +Bundle-Version: 3.11.0.qualifier Bundle-Activator: org.eclipse.help.internal.HelpPlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/ua/org.eclipse.help/pom.xml b/ua/org.eclipse.help/pom.xml index 8e39e816f04..350dc960088 100644 --- a/ua/org.eclipse.help/pom.xml +++ b/ua/org.eclipse.help/pom.xml @@ -18,6 +18,6 @@ org.eclipse.platform org.eclipse.help - 3.10.600-SNAPSHOT + 3.11.0-SNAPSHOT eclipse-plugin diff --git a/ua/org.eclipse.help/src/org/eclipse/help/IHelp.java b/ua/org.eclipse.help/src/org/eclipse/help/IHelp.java deleted file mode 100644 index d4b6947e8e5..00000000000 --- a/ua/org.eclipse.help/src/org/eclipse/help/IHelp.java +++ /dev/null @@ -1,257 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2015 IBM Corporation and others. - * - * This program and the accompanying materials - * are made available under the terms of the Eclipse Public License 2.0 - * which accompanies this distribution, and is available at - * https://www.eclipse.org/legal/epl-2.0/ - * - * SPDX-License-Identifier: EPL-2.0 - * - * Contributors: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.help; - -/** - * Former interface to the help system UI. - * - * @deprecated marked for deletion, see Bug 442959. This interface became - * obsolete in 3.0, along with the extension point that it was - * associated with. The functionality provided by this interface is - * available elsewhere. Use - * {@link org.eclipse.help.HelpSystem#getTocs HelpSystem.getTocs()} - * and {@link org.eclipse.help.HelpSystem#getContext - * HelpSystem.getContext(String)} to obtain help resources. Use - * various display methods of org.eclipse.ui.help.IWorkbenchHelpSystem to display help - * resources. - */ -@Deprecated(forRemoval = true, since = "2023-12") -public interface IHelp { - - /** - * Displays the entire help bookshelf. - *

- * This method is called by the platform to launch the help system UI - *

- * - * @since 2.0 - * @deprecated Use WorkbenchHelp.displayHelp() instead. - */ - @Deprecated - public void displayHelp(); - - /** - * Displays context-sensitive help for the given context. - *

- * (x,y) coordinates specify the location where the context sensitive help - * UI will be presented. These coordinates are screen-relative (ie: (0,0) is - * the top left-most screen corner). The platform is responsible for calling - * this method and supplying the appropriate location. - *

- * - * - * @param context - * the context to display - * @param x - * horizontal position - * @param y - * verifical position - * @since 2.0 - * @deprecated Use WorkbenchHelp.displayContext(context,x,y) instead. - */ - @Deprecated - public void displayContext(IContext context, int x, int y); - - /** - * Displays context-sensitive help for context with the given context id. - *

- * (x,y) coordinates specify the location where the context sensitive help - * UI will be presented. These coordinates are screen-relative (ie: (0,0) is - * the top left-most screen corner). The platform is responsible for calling - * this method and supplying the appropriate location. - *

- * - * @param contextId - * the help context identifier; the parameter needs to have a - * form pluginID.pluginContextId, where pluginID is ID of plug-in - * contributing a context, and pluginContextID is ID of context - * contributed in a plug-in. - * @param x - * horizontal position - * @param y - * verifical position - * @see #getContext(String) - * @since 2.0 - * @deprecated Use - * WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) - * instead. - */ - @Deprecated - public void displayContext(String contextId, int x, int y); - - /** - * Displays help content for the help resource with the given URL. - *

- * This method is called by the platform to launch the help system UI, - * displaying the documentation identified by the href - * parameter. - *

- *

- * The help system makes no guarantee that all the help resources can be - * displayed or how they are displayed. - *

- * - * @param href - * the URL of the help resource. - *

- * Valid href are as described in - * {@link org.eclipse.help.IHelpResource#getHref() IHelpResource.getHref()} - *

- * @since 2.0 - * @deprecated Use WorkbenchHelp.displayHelpResource(href) instead. - */ - @Deprecated - public void displayHelpResource(String href); - - /** - * Displays help content for the help resource. - *

- * This method is called by the platform to launch the help system UI, - * displaying the documentation identified by the helpResource - * parameter. - *

- * The help system makes no guarantee that all the help resources can be - * displayed or how they are displayed. - *

- * - * @param helpResource - * the help resource to display. - * @since 2.0 - * @deprecated Use WorkbenchHelp.displayHelpResource(helpResource.getHref()) - * instead. - */ - @Deprecated - public void displayHelpResource(IHelpResource helpResource); - - /** - * Displays help content for the toc with the given URL. - *

- * This method is called by the platform to launch the help system UI, - * displaying the documentation identified by the toc - * parameter. - *

- *

- * Valid toc are contributed through the toc element of the - * "org.eclipse.help.toc" extension point. - *

- * - * @param toc - * the URL of the toc as specified in the - * "org.eclipse.help.toc" extenstion point - * @deprecated Use WorkbenchHelp.displayHelpResource(toc) instead. - */ - @Deprecated - public void displayHelp(String toc); - - /** - * This method is an extension to the - * displayHelp(String toc) - * method, providing the ability to open the specified help topic. - *

- * selectedTopic should be a valid help topic url contained in - * the specified toc and have the following format: - * /pluginID/path_to_document
- * where - *

- *
- *
pluginID is the unique identifier of the plugin containing - * the help topic,
- *
path_to_document is the help topic path, relative to the - * plugin directory
- *
- * - * @param toc - * the URL of the toc - * @param selectedTopic - * the help topic url. - * @see #displayHelp(java.lang.String) - * @deprecated Use WorkbenchHelp.displayHelpResource(selectedTopic) instead. - */ - @Deprecated - public void displayHelp(String toc, String selectedTopic); - - /** - * Displays context-sensitive help for context with the given context id. - *

- * (x,y) coordinates specify the location where the context sensitive help - * UI will be presented. These coordinates are screen-relative (ie: (0,0) is - * the top left-most screen corner). The platform is responsible for calling - * this method and supplying the appropriate location. - *

- * - * @param contextId - * the help context identifier - * @param x - * horizontal position - * @param y - * verifical position - * @see #getContext(String) - * @deprecated Use - * WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) - * instead. - */ - @Deprecated - public void displayHelp(String contextId, int x, int y); - - /** - * Displays context-sensitive help for the given context. - *

- * (x,y) coordinates specify the location where the context sensitive help - * UI will be presented. These coordinates are screen-relative (ie: (0,0) is - * the top left-most screen corner). The platform is responsible for calling - * this method and supplying the appropriate location. - *

- * - * - * @param context - * the context to display - * @param x - * horizontal position - * @param y - * verifical position - * @deprecated Use WorkbenchHelp.displayContext(context,x,y) instead. - */ - @Deprecated - public void displayHelp(IContext context, int x, int y); - - /** - * Computes and returns context information for the given context id. - * - * @param contextId - * the context id - * @return the context, or null if none - * @deprecated Use HelpSystem.getContext(contextId) instead. - */ - @Deprecated - public IContext getContext(String contextId); - - /** - * Returns the list of all integrated tables of contents available. - * - * @return an array of TOC's - * @since 2.0 - * @deprecated Use HelpSystem.getTocs() instead. - */ - @Deprecated - public IToc[] getTocs(); - - /** - * Returns true if the context-sensitive help window is - * currently being displayed, false if not. - * - * @deprecated Use WorkbenchHelp.isContextHelpDisplayed() instead. - */ - @Deprecated - public boolean isContextHelpDisplayed(); -}