Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 379602

Summary:	section API feedback
Product:	[ECD] Orion	Reporter:	Susan McCourt <susan>
Component:	Client	Assignee:	Szymon Brandys <Szymon.Brandys>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3
Version:	0.5
Target Milestone:	0.5 M2
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description Susan McCourt

2012-05-15 15:31:31 EDT

I have converted all the navigator and search "auxpane sections" to use the section class now.  Overall it was very simple and makes the code more legible.  Just a few things that tripped me up:

- it should be easy to opt out of progress.  I was surprised when all of my section headings showed up with '...' permanently showing, and I hadn't asked for any progress reporting at all.  My solution was to create a monitor and always say monitor.done() after generating my content.  Works okay, but is this the best way?  Maybe an option is to not support progress at all?  

- I got tripped up by what options.explorer meant, when I don't use an explorer to parent the sections.  It turns out this is only used for the command handler.  I think options.handler is a better name.  I also changed the logic so that the handler is not required if a command service is not specified.

I didn't want to make any of these changes without talking about it...

Comment 1 Szymon Brandys

2012-05-16 03:56:58 EDT

- I think I will remove options.explorer and will just expose the id of the actionsNode. The caller of this API would have to register and render actions by himself using actionsNode from the section.

- For progress, I think we should just show progress indicators when the caller explicitly asks for a monitor using createProgressMonitor. If not, there should be no progress indication in the section header.

Comment 2 Szymon Brandys

2012-05-16 05:32:21 EDT

(In reply to comment #1)
> - I think I will remove options.explorer and will just expose the id of the
> actionsNode. The caller of this API would have to register and render actions by
> himself using actionsNode from the section.
> 
> - For progress, I think we should just show progress indicators when the caller
> explicitly asks for a monitor using createProgressMonitor. If not, there should
> be no progress indication in the section header.

Fixed with 88057334207ed30cf649cb5babb93584c14cddac.