Bug 839 - displayHelp API should take a single help context (1GC2M9M)
Summary: displayHelp API should take a single help context (1GC2M9M)
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 2.0   Edit
Hardware: All Windows NT
: P3 normal (vote)
Target Milestone: 2.0 M3   Edit
Assignee: Konrad Kolosowski CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-10-10 21:48 EDT by Randy Giffen CLA
Modified: 2002-02-12 17:42 EST (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Randy Giffen CLA 2001-10-10 21:48:45 EDT 
A help api which takes an array of help contexts rather than a single 
context adds a degree of complication.

A help context includes a description and any number of related 
links. When passed more than one context for which help should be 
shown, the help support system currently uses the additional contexts to 
supplement its related links list. It does not show the additional descriptions.

Since a help context can be either an id or an IContext, clients can compose their
own IContext consisting of nested related links if they want to.

Thus an api taking a single context is simpler without sacrificing functionality.

NOTES:

DB (5/1/2001 4:48:34 PM)
This is a good idea. We'll need to discuss this for the next release. At this point is a bit too late to make API changes.

ARCH (7/11/01 12:25:44 PM)
	Defer
Comment 1 DJ Houghton CLA 2001-10-24 06:26:37 EDT 
PRODUCT VERSION:
0.043
Comment 2 Konrad Kolosowski CLA 2002-02-12 17:42:45 EST 
The org.eclipse.help.displayHelp(String contextId, int x, int y) and 
org.eclipse.help.displayHelp(IContext context, int x, int y) have been added 
several drivers ago.  The existing methods accepting array of context(id)s have 
been marked deprecated for some time and will be removed shortly.