- * 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.
- *
"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
- *
- * (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, ornull 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();
-}