Bug 549929 - Provide getDialogSettings method functionality outside of
AbstractUIPlugin
Remove the deprecation of AbstractUIPlugin.getDialogSettings() and
improve its Java doc to describe what the implementation does, with
links to the details.
Change-Id: I7ec0f2f52fd0e8fa4eb882a3ee40f53b85b0829d
Signed-off-by: Ed Merks <ed.merks@gmail.com>
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/plugin/AbstractUIPlugin.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/plugin/AbstractUIPlugin.java
index 2e45ad1..40761af 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/plugin/AbstractUIPlugin.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/plugin/AbstractUIPlugin.java
@@ -39,6 +39,7 @@
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.BundleListener;
+import org.osgi.framework.FrameworkUtil;
/**
* Abstract base class for plug-ins that integrate with the Eclipse platform UI.
@@ -173,11 +174,24 @@
}
/**
+ * Returns the dialog settings by calling
+ * {@link PlatformUI#getDialogSettingsProvider(Bundle)
+ * PlatformUI.getDialogSettingsProvider}({@link #getBundle()
+ * getBundle()}).{@link IDialogSettingsProvider#getDialogSettings()
+ * getDialogSettings()}.
+ * <p>
+ * For new code, consider using the following idiom directly instead of relying
+ * on a UI plugin class:
+ * </p>
+ *
+ * <pre>
+ * PlatformUI.getDialogSettingsProvider({@link FrameworkUtil#getBundle(Class) FrameworkUtil.getBundle}(My.class)).getDialogSettings()
+ * </pre>
+ *
* @return the dialog settings
- * @deprecated
+ * @see FrameworkUtil#getBundle(Class)
* @see PlatformUI#getDialogSettingsProvider(Bundle)
*/
- @Deprecated
public IDialogSettings getDialogSettings() {
return PlatformUI.getDialogSettingsProvider(getBundle()).getDialogSettings();
}
