Bug 181814 - [TabbedProperties] Need API to show Decorations on Tabs of Tabbed Property Views
Summary: [TabbedProperties] Need API to show Decorations on Tabs of Tabbed Property Views
Status: ASSIGNED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.3   Edit
Hardware: PC All
: P3 enhancement with 2 votes (vote)
Target Milestone: ---   Edit
Assignee: Anthony Hunter CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 149052 (view as bug list)
Depends on:
Blocks:
 
Reported: 2007-04-10 14:06 EDT by Ray CLA
Modified: 2019-09-06 16:06 EDT (History)
11 users (show)

See Also:


Attachments
Error and warning icons on tabs and properties view header icon decorated (161.07 KB, image/png)
2007-04-10 15:38 EDT, Andrée Proulx CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Ray CLA 2007-04-10 14:06:51 EDT
Requirement:

We need to show decoration (error/warning) on Tabs of Tabbed Property Views so that users won't have to go through all tabs in a view to find errors.

I copied the following from the original request opened by Edmond (edmond_wang@ca.ibm.com) on another bugzilla:

User Case 1:  Add marker beside tab label

	1. Got Error Marker from Resource ( will be done in our code)
	2. Identify which section would be associated with that error  ( will 
be done in our code)
	3. From section, retrieve the Tab which contain that section (need 
help from 3.3)
	4. Add Error icon besides tab label  (need help from 3.3)

User Case 2:  Remove marker beside tab label

	1. Got  Marker remove event from Resource ( will be done in our code)
	2. Identify which section would be associated with that error  ( will 
be done in our code)
	3. From section, retrieve the Tab which contain that section  (need 
help from 3.3)
	4. Remove Error icon besides tab label  (need help from 3.3)
Comment 1 Andrée Proulx CLA 2007-04-10 15:38:48 EDT
Created attachment 63420 [details]
Error and warning icons on tabs and properties view header icon decorated

An error or warning icon can be displayed on the tab (with the icon reflecting the most severe error encountered on the page.

1. this error/warning icon can be a decorator, meaning an overlay on the existing tab icon.

If displaying multiple icons on the tab is an issue:

2. the error/warning icon can replace the tab icon

3. properties view header title should reflect the mostsevere error encountered in the properties.
Comment 2 Kevin McGuire CLA 2007-04-11 11:53:01 EDT
Susan, right now you can drop a control decoration on top of any SWT control.  What more is required for attaching them to property page tabs?
Comment 3 Susan McCourt CLA 2007-04-11 12:51:24 EDT
I'm not sure ControlDecoration should be used here.  Since there is already a way to add an icon to the tab, and we are simply replacing the icon with an error indicator (as shown in the attachment), then I would suggest using whatever the existing mechanism is.  
Comment 4 Andrée Proulx CLA 2007-04-11 12:55:26 EDT
Susan, yesterday it wasn't clear to me if ControlDecoration could be used here.
If it can be used, I believe it should be a valid option to teams to choose to decorate an existing tab icon, rather then replacing it.

Aside my personal preference to decorate an icon, rather then replacing it with an error or warning icon.
Of course the decoration needs to be large enough to not look like dirt on a screen ;)
Comment 5 Susan McCourt CLA 2007-04-11 13:33:30 EDT
Andree, ControlDecoration's purpose is to paint a decoration adjacent to a control in one of six positions (such as "draw a decoration to the top and left of this control").  There are no promises with respect to overlays or the order of decoration painting if multiple decorations are placed in the same location.  So I don't think it's the tool to use for overlays.

If we are talking about a 3.3 solution, then the simplest thing is to replace the graphic.  
Comment 6 Ray CLA 2007-04-11 15:49:25 EDT
I agree, ControlDecoration is probably not an option here. 
Providing an API to change the image on the Tab would work. JFace's CompositeImageDescriptor can help, an example being Package Explorer in eclipse which uses Composite images to decorate already existing images for TreeItems.
Comment 7 Kevin McGuire CLA 2007-04-11 17:48:40 EDT
Note API change for difficult for 3.3 at this point, it requires entire PMC approval (can happen but needs to be pretty high priority).
Comment 8 Anthony Hunter CLA 2007-07-19 10:54:12 EDT
*** Bug 149052 has been marked as a duplicate of this bug. ***
Comment 9 Anthony Hunter CLA 2007-07-19 10:58:07 EDT
In plan for Eclipse 3.4.

Currently, the API for the tabbed properties view allows the active tab to have an image. The image is static.

A new API is required to toggle the behavior to allow the image to appear on any tab.

Additional API is required to change the image, either to replace with a new image (a decorated image) or to remove it.
Comment 10 Mike Wilson CLA 2008-05-13 12:41:31 EDT
Did anything happen on this?
Comment 11 Anthony Hunter CLA 2008-05-13 13:43:08 EDT
This feature was on an IBM internal list for 3.4. No further follow up occurred since July 2007. 
Comment 12 Rodrigo Peretti CLA 2008-05-13 14:04:58 EDT
It is still something we would like to see happening.
Comment 13 John Arthorne CLA 2008-10-29 15:33:53 EDT
Removing plan keyword for bugs that are not linked to the 3.5 (Galileo) plan.
Comment 14 Anthony Hunter CLA 2008-10-30 09:06:14 EDT
This enhancement is targeted for the 3.5 release, but is not in the rolled up plan for the platform for 3.5 (plan keyword has been removed).

I am guessing that there are too many enhancements from the 17 or so platform components, so the list is cleaned a little to list only major enhancements.
Comment 15 Dani Megert CLA 2009-01-30 03:33:59 EST
Moving target as M4 has shipped.
Comment 16 Boris Bokowski CLA 2009-05-06 14:53:01 EDT
Removing target milestone as M6 has shipped a while ago. Note that we are well past the API freeze for 3.5 - this will have to wait until 3.6 (if still in plan).
Comment 17 Eclipse Webmaster CLA 2019-09-06 16:06:28 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.