IHelp


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.help;
12  /**
13   * Former interface to the help system UI.
14   * 
15   * @deprecated This interface became obsolete in 3.0, along with the extension
16   *             point that it was associated with. The functionality provided by
17   *             this interface is available elsewhere. Use
18   *             {@link org.eclipse.help.HelpSystem#getTocs HelpSystem.getTocs()}
19   *             and
20   *             {@link org.eclipse.help.HelpSystem#getContext HelpSystem.getContext(String)}
21   *             to obtain help resources. Use various display methods of
22   *             {@link org.eclipse.ui.help.WorkbenchHelp WorkbenchHelp}to
23   *             display help resources.
24   */
25  public interface IHelp {
26  
27      /**
28       * Displays the entire help bookshelf.
29       * <p>
30       * This method is called by the platform to launch the help system UI
31       * </p>
32       * 
33       * @since 2.0
34       * @deprecated Use WorkbenchHelp.displayHelp() instead.
35       */
36      public void displayHelp();
37  
38      /**
39       * Displays context-sensitive help for the given context.
40       * <p>
41       * (x,y) coordinates specify the location where the context sensitive help
42       * UI will be presented. These coordinates are screen-relative (ie: (0,0) is
43       * the top left-most screen corner). The platform is responsible for calling
44       * this method and supplying the appropriate location.
45       * </p>
46       * 
47       * 
48       * @param context
49       *            the context to display
50       * @param x
51       *            horizontal position
52       * @param y
53       *            verifical position
54       * @since 2.0
55       * @deprecated Use WorkbenchHelp.displayContext(context,x,y) instead.
56       */
57      public void displayContext(IContext context, int x, int y);
58  
59      /**
60       * Displays context-sensitive help for context with the given context id.
61       * <p>
62       * (x,y) coordinates specify the location where the context sensitive help
63       * UI will be presented. These coordinates are screen-relative (ie: (0,0) is
64       * the top left-most screen corner). The platform is responsible for calling
65       * this method and supplying the appropriate location.
66       * </p>
67       * 
68       * @param contextId
69       *            the help context identifier; the parameter needs to have a
70       *            form pluginID.pluginContextId, where pluginID is ID of plug-in
71       *            contributing a context, and pluginContextID is ID of context
72       *            contributed in a plug-in.
73       * @param x
74       *            horizontal position
75       * @param y
76       *            verifical position
77       * @see #getContext(String)
78       * @since 2.0
79       * @deprecated Use
80       *             WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y)
81       *             instead.
82       */
83      public void displayContext(String   contextId, int x, int y);
84  
85      /**
86       * Displays help content for the help resource with the given URL.
87       * <p>
88       * This method is called by the platform to launch the help system UI,
89       * displaying the documentation identified by the <code>href</code>
90       * parameter.
91       * </p>
92       * <p>
93       * The help system makes no guarantee that all the help resources can be
94       * displayed or how they are displayed.
95       * </p>
96       * 
97       * @param href
98       *            the URL of the help resource.
99       *            <p>
100      *            Valid href are as described in
101      *            {@link  org.eclipse.help.IHelpResource#getHref() IHelpResource.getHref()}
102      *            </p>
103      * @since 2.0
104      * @deprecated Use WorkbenchHelp.displayHelpResource(href) instead.
105      */
106     public void displayHelpResource(String   href);
107 
108     /**
109      * Displays help content for the help resource.
110      * <p>
111      * This method is called by the platform to launch the help system UI,
112      * displaying the documentation identified by the <code>helpResource</code>
113      * parameter.
114      * <p>
115      * The help system makes no guarantee that all the help resources can be
116      * displayed or how they are displayed.
117      * </p>
118      * 
119      * @see IHelp#displayHelpResource(String)
120      * @param helpResource
121      *            the help resource to display.
122      * @since 2.0
123      * @deprecated Use WorkbenchHelp.displayHelpResource(helpResource.getHref())
124      *             instead.
125      */
126     public void displayHelpResource(IHelpResource helpResource);
127 
128     /**
129      * Displays help content for the toc with the given URL.
130      * <p>
131      * This method is called by the platform to launch the help system UI,
132      * displaying the documentation identified by the <code>toc</code>
133      * parameter.
134      * </p>
135      * <p>
136      * Valid toc are contributed through the <code>toc</code> element of the
137      * <code>"org.eclipse.help.toc"</code> extension point.
138      * </p>
139      * 
140      * @param toc
141      *            the URL of the toc as specified in the
142      *            <code>"org.eclipse.help.toc"</code> extenstion point
143      * @deprecated Use WorkbenchHelp.displayHelpResource(toc) instead.
144      */
145     public void displayHelp(String   toc);
146 
147     /**
148      * This method is an extension to the <a
149      * HREF="#displayHelp(java.lang.String)">displayHelp(String toc) </a>
150      * method, providing the ability to open the specified help topic.
151      * <p>
152      * <code>selectedTopic</code> should be a valid help topic url contained
153      * in the specified <code>toc</code> and have the following format:
154      * <em>/pluginID/path_to_document</em><br>
155      * where
156      * <dl>
157      * <dt><em>pluginID</em> is the unique identifier of the plugin
158      * containing the help topic,</dt>
159      * <dt><em>path_to_document</em> is the help topic path, relative to the
160      * plugin directory</dt>
161      * </dl>
162      * </p>
163      * 
164      * @param toc
165      *            the URL of the toc
166      * @param selectedTopic
167      *            the help topic url.
168      * @see #displayHelp(java.lang.String)
169      * @deprecated Use WorkbenchHelp.displayHelpResource(selectedTopic) instead.
170      */
171     public void displayHelp(String   toc, String   selectedTopic);
172 
173     /**
174      * Displays context-sensitive help for context with the given context id.
175      * <p>
176      * (x,y) coordinates specify the location where the context sensitive help
177      * UI will be presented. These coordinates are screen-relative (ie: (0,0) is
178      * the top left-most screen corner). The platform is responsible for calling
179      * this method and supplying the appropriate location.
180      * </p>
181      * 
182      * @param contextId
183      *            the help context identifier
184      * @param x
185      *            horizontal position
186      * @param y
187      *            verifical position
188      * @see #getContext(String)
189      * @deprecated Use
190      *             WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y)
191      *             instead.
192      */
193     public void displayHelp(String   contextId, int x, int y);
194 
195     /**
196      * Displays context-sensitive help for the given context.
197      * <p>
198      * (x,y) coordinates specify the location where the context sensitive help
199      * UI will be presented. These coordinates are screen-relative (ie: (0,0) is
200      * the top left-most screen corner). The platform is responsible for calling
201      * this method and supplying the appropriate location.
202      * </p>
203      * 
204      * 
205      * @param context
206      *            the context to display
207      * @param x
208      *            horizontal position
209      * @param y
210      *            verifical position
211      * @deprecated Use WorkbenchHelp.displayContext(context,x,y) instead.
212      */
213     public void displayHelp(IContext context, int x, int y);
214 
215     /**
216      * Computes and returns context information for the given context id.
217      * 
218      * @param contextId
219      *            the context id
220      * @return the context, or <code>null</code> if none
221      * @deprecated Use HelpSystem.getContext(contextId) instead.
222      */
223     public IContext getContext(String   contextId);
224 
225     /**
226      * Returns the list of all integrated tables of contents available.
227      * 
228      * @return an array of TOC's
229      * @since 2.0
230      * @deprecated Use HelpSystem.getTocs() instead.
231      */
232     public IToc[] getTocs();
233 
234     /**
235      * Returns <code>true</code> if the context-sensitive help window is
236      * currently being displayed, <code>false</code> if not.
237      * 
238      * @deprecated Use WorkbenchHelp.isContextHelpDisplayed() instead.
239      */
240     public boolean isContextHelpDisplayed();
241 }
242
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags