Community
Participate
Working Groups
In user and isv doc respectively
Created attachment 69680 [details] Proposition of isv doc Simon, Tod could you look at this and give me a feedback if it has a good structure. Moreover i want to add next chapter advanced using of search dialog and describe all features.
I'll tidy up the grammar for you when you are done. It does read like a Polish guy wrote it <grin>. The use of "the" is one of the hard things to get right in English. Some comments org.eclipse.platform.doc.isv\guide\dialog_FilteredItemsSelectionDialog_ex To illustrate how to create new search dialog based on FilteredItemsSelectionDialog we present all steps needed to do it. - this is redundant Check the spelling errors - there are quite a few. lines like org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter, org.eclipse.core.runtime.IProgressMonitor) are just confusing - don't bother with the path prefixes there is a missing screenshot Advanced using a Search Dialog is empty org.eclipse.platform.doc.isv\guide\dialogs_FilteredItemsSelectionDialog.htm should link to the first page the features that were a refactoring of the old idloag (like the menu) don't need to be mentioned - that is just confusing.
Created attachment 70340 [details] Poposition of doc 002
Created attachment 70341 [details] Image 1
Created attachment 70342 [details] Image 2
Created attachment 70343 [details] Image 3
Created attachment 70344 [details] Image 4
Created attachment 70384 [details] Proposition of doc 003
These screenshots do not follow our doc guidelines (wrong resolution and custom theme). Tomek has been following them and can help you get set up. See http://wiki.eclipse.org/index.php/Eclipse_Doc_Style_Guide under graphics.
The example should not refer to import org.eclipse.ui.internal.WorkbenchPlugin as it is internal. If you test this example you get an NPE. I am also not getting the contents filled in. Your example shows no constructors so I am not sure if you are doing anything else there. !ENTRY org.eclipse.ui 4 0 2007-06-07 14:31:44.750 !MESSAGE Unhandled event loop exception !STACK 0 java.lang.NullPointerException at org.eclipse.ui.dialogs.FilteredItemsSelectionDialog$ContentProvider.saveHistory(FilteredItemsSelectionDialog.java:2712) at org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.storeDialog(FilteredItemsSelectionDialog.java:390) at org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.close(FilteredItemsSelectionDialog.java:376) at org.eclipse.jface.dialogs.Dialog.cancelPressed(Dialog.java:480) at org.eclipse.jface.dialogs.Dialog.buttonPressed(Dialog.java:466) at org.eclipse.jface.dialogs.Dialog$2.widgetSelected(Dialog.java:616) at org.eclipse.swt.widgets.TypedListener.handleEvent(TypedListener.java:227) at org.eclipse.swt.widgets.EventTable.sendEvent(EventTable.java:66) at org.eclipse.swt.widgets.Widget.sendEvent(Widget.java:938) at org.eclipse.swt.widgets.Display.runDeferredEvents(Display.java:3682) at org.eclipse.swt.widgets.Display.readAndDispatch(Display.java:3293) at org.eclipse.jface.window.Window.runEventLoop(Window.java:820) at org.eclipse.jface.window.Window.open(Window.java:796) at filtereddialogtest.popup.actions.NewAction.run(NewAction.java:34) at org.eclipse.ui.internal.PluginAction.runWithEvent(PluginAction.java:256) at org.eclipse.jface.action.ActionContributionItem.handleWidgetSelection(ActionContributionItem.java:545) at org.eclipse.jface.action.ActionContributionItem.access$2(ActionContributionItem.java:490) at org.eclipse.jface.action.ActionContributionItem$5.handleEvent(ActionContributionItem.java:402) at org.eclipse.swt.widgets.EventTable.sendEvent(EventTable.java:66) at org.eclipse.swt.widgets.Widget.sendEvent(Widget.java:938) at org.eclipse.swt.widgets.Display.runDeferredEvents(Display.java:3682) at org.eclipse.swt.widgets.Display.readAndDispatch(Display.java:3293) at org.eclipse.ui.internal.Workbench.runEventLoop(Workbench.java:2389) at org.eclipse.ui.internal.Workbench.runUI(Workbench.java:2353) at org.eclipse.ui.internal.Workbench.access$4(Workbench.java:2219) at org.eclipse.ui.internal.Workbench$4.run(Workbench.java:466) at org.eclipse.core.databinding.observable.Realm.runWithDefault(Realm.java:289) at org.eclipse.ui.internal.Workbench.createAndRunWorkbench(Workbench.java:461) at org.eclipse.ui.PlatformUI.createAndRunWorkbench(PlatformUI.java:149) at org.eclipse.ui.internal.ide.application.IDEApplication.start(IDEApplication.java:106) at org.eclipse.equinox.internal.app.EclipseAppHandle.run(EclipseAppHandle.java:153) at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.runApplication(EclipseAppLauncher.java:106) at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.start(EclipseAppLauncher.java:76) at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:363) at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:176) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:585) at org.eclipse.equinox.launcher.Main.invokeFramework(Main.java:504) at org.eclipse.equinox.launcher.Main.basicRun(Main.java:443) at org.eclipse.equinox.launcher.Main.run(Main.java:1169) at org.eclipse.equinox.launcher.Main.main(Main.java:1144)
Created attachment 70550 [details] My example Here is my example to help you see what the differences might be.
Fixed a CHKPII issue in dialogs_FilteredItemsSelectionDialog_example_advanced.htm (&& instead of &&) >20070607. (Thanks, Markus)
BTW: you can use Alt+PrtSc to take a screenshot of just the topmost dialog/window.
Created attachment 70612 [details] Tod's example with my implementation of FilteredResourcesSelectionDialogExample I got NPE the same when i commented setSelectionHistory in constructor. It's problem with missing null check on selectionHistory. I reported the bug 191611 and I attached fix patch.
Created attachment 70614 [details] Two small changes in example doc
Created attachment 70671 [details] Image 1
Created attachment 70672 [details] Image 2
Created attachment 70673 [details] Image 3
Created attachment 70674 [details] Image 4
Some more issues setSelectionHistory(new ResourceSelectionHistory()); needs to be mentioned in the doc Resources is misspelled DIALOG_SETTINGS is not defined in the doc
ResourceSelectionHistory is also a private class defined within your example and mentioned nowhere in the doc
The example also does not populate when you just run the basic example. This documentation will be pulled from the table of contents until it is fixed.
Created attachment 70710 [details] Update patch 005
This patch does not apply against HEAD. Please update
Created attachment 70713 [details] Patch refreshed to head
This patch still had the selection history NPE of 191611. You need to add a selectionHistory implementation in your basic example
Created attachment 70717 [details] Update patch 006 I attached part about implementation of SelectionHistory but if we applied my patch from 191611 this part will be unnecessay.
Created attachment 70840 [details] Example as it stands now This example still does not populate as the image shows. Here is my code following your example so you can see what got missed Some more notes 1) We need to mention the setup for this example (I got it wrong when I tried it) It needs to be a plug-in project that has an Activator contributes to the UI otherwise your code will not compile (runtime dependency) and none of the required methods will get generated. I would even suggest you get them to generate the Hello World Command example and then modify it. Walking them through the options in the new class dialog would also be useful. 2) The constructors would be better as public FilteredResourcesSelectionDialogExample(Shell shell, boolean multi) { super(shell, multi); setTitle("Filtered Resources Selection Dialog Example"); setSelectionHistory(new ResourceSelectionHistory()); } public FilteredResourcesSelectionDialogExample(Shell shell) { this(shell, false); }
Created attachment 70858 [details] Update patch 007 I updated patch as Tod suggested.
This still doesn't solve the problem of the list not getting populated initially. Do you know why we get an empty dialog with this example?
Created attachment 70888 [details] Update patch 008
Created attachment 70894 [details] Updated patch 009
Patch released for build >20070611. I have also restored the topic entries. Please verify the doc before we close this.
Created attachment 70986 [details] Patch fixes some typos I created all examples from scratch and I found only some typos fixed in patch. Except for it i don't have any prroblems.
Created attachment 70992 [details] Patch fixes some typos 002 All from previous patch and i added missed "s" in topics_Guide.xml.
Final patch released to HEAD