Bug 133869 - [PresentationAPI] StackPresentation is horribly unclear
Summary: [PresentationAPI] StackPresentation is horribly unclear
Status: RESOLVED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.1.2   Edit
Hardware: PC Windows XP
: P3 trivial (vote)
Target Milestone: 4.4 M7   Edit
Assignee: Paul Webster CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2006-03-29 11:06 EST by Rob Grzywinski CLA
Modified: 2014-05-02 04:48 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Rob Grzywinski CLA 2006-03-29 11:06:42 EST
StackPresentation is horribly unclear in that it never explicitly states that a "The presentation doesn't actually parent the widget created by the presentable part. Instead, the part's control and toolbar are parented by the workbench window." (to quote the just-found-by-me EclipseCon presentation).

Just adding some small notes on addPart(), removePart(), selectPart(), the class itself, IPresentablePart.getControl() (whose Javadoc ONLY makes sense when you're in the inner circle on this little secret), etc would be nice.

You don't have to give away the farm here.  Just some small breadcrumbs would prevent people from pulling out their hair.

Thanks!
Comment 1 Michael Van Meekeren CLA 2006-03-29 12:17:22 EST
I take it you are asking for clarification on the javadoc for StackPresentation.  Is there anything else wrt presentations that could be useful.  We have nothing to hide but honestly this stuff is pretty hard to figure out right now and input from people trying to use it is very helpful.

Comment 2 Rob Grzywinski CLA 2006-03-29 12:29:40 EST
Yes, the "small notes" that I referred to should have been "javadoc".  (And I obviously should have put a ":)" after my last statement :))

Heck, if you can point at the EclipseCon presentation in StackPresentation's class javadoc (http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ui.examples.presentation/) that would be helpful.

Once one understands that the parts' controls are never actually added to the controls that you create (and you have to do manual layout and all of that) then everything else goes smoothly.  Overall I've pretty happy with the API (well, after some bread crumbs are added to the Javadocs).

The only things that I haven't immediately found at this point all revolve around colors.  How does one:

  1.  Change the color of the sashes between views / editors
  2.  Change the application menu bar color
  3.  Change any remaining application background color (anything that's not #1 and #2).

If these things are or are not done through the presentation APIs then you might just note that in the APIs (and give some hints as to where to go next if the case of "are not done").

Thanks!
Comment 3 Lars Vogel CLA 2014-05-02 04:48:11 EDT
The PresentationAPI has been deprecated with the Eclipse 4.x release and it has been replaced with the CSS engine. I therefore close this bugs as WONTFIX. In case your bug report is still valid for the Eclipse 4.4 release, please open a new bug report for it.