Bug 90793 - Switch Help view to the new browser support
Summary: Switch Help view to the new browser support
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1 M7   Edit
Assignee: Dejan Glozic CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 94019
Blocks:
  Show dependency tree
 
Reported: 2005-04-08 09:56 EDT by Dejan Glozic CLA
Modified: 2005-05-08 02:23 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Dejan Glozic CLA 2005-04-08 09:56:47 EDT
When 'Open' is executed, the choice in the preferences should be between 
showing documents in place or opening them separately.

When opening separately, help documents should be shown in the help window as 
today. Normal documents should be shown in the browser support's current 
browser.

When in a dialog, normal should be either shown in place (default), or as 
external browser in the browser support (no internal).
Comment 1 Dejan Glozic CLA 2005-05-06 18:49:54 EDT
Michael, Tim, I know it is a bit late but I have a use case in Help where I 
need to know if the browser support can show documents 'in place' i.e. using 
internal browser widget. If true, I would ask the editor to show the document 
in place, otherwise I would go to Help and ask to show the document in a 
separate help window.

The use case here is that I don't want to use external browser support for 
help documents because users would loose the context. In the workbench window, 
it makes sense to show the document only because the context (search results, 
All Topics, Related Topics etc.) is also visible next to it.

In order to do this, I need to be able to ask IWorkbenchBrowserSupport if 
internal browser is possible without actually creating one. 

There is no real work involved to do this for the several reasons:

1) The fallback implementation in the workbench would return 'false' all the 
time
2) The 'reference' implementation that Tim is providing already has this 
method on WebBrowserUtil class.
3) We can add the method to AbstractWorkbenchBrowserSupport that is meant to 
be extended without breaking anybody because we can provide the default
implementation (return false).

Here is the proposed method for IWorkbenchBrowserSupport:

/**
 * Tests whether web browser as an SWT widget can be created in this
 * workbench instance. If this method returns <code>false</code>,
 * browser styles <code>AS_EDITOR</code> and <code>AS_VIEW</code>
 * will be ignored and external browser will always be created.
 *
 * @return <code>true</code> if internal web browser can be created on
 * this platform, <code>false</code> otherwise.
 */
 boolean isInternalWebBrowserAvailable();
Comment 2 Dejan Glozic CLA 2005-05-06 18:55:38 EDT
Opened a separate defect for the API request (bug 94019).
Comment 3 Dejan Glozic CLA 2005-05-07 22:22:48 EDT
API released. I will take it from here.
Comment 4 Dejan Glozic CLA 2005-05-08 02:23:28 EDT
Done.