Attachment #35319 for bug #92601

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

View | Details | Raw Unified | Return to bug 92601
Collapse All | Expand All




import java.util.Iterator;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.preference.PreferenceManager;
import org.eclipse.jface.viewers.ISelection;

 * type.
 */
public class PropertyDialog extends FilteredPreferenceDialog {
	private ISelection selection;

	// The id of the last page that was selected
	private static String lastPropertyId = null;

	/**
	 * Create a new property dialog.
	 * 
	 * @param shell
	 *            the parent shell
	 * @param propertyPageId
	 *            the property page id
	 * @param element
	 *            the adaptable element
	 * @return the property dialog
	 */
	public static PropertyDialog createDialogOn(Shell shell,
			final String propertyPageId, Object element) {

		PropertyPageManager pageManager = new PropertyPageManager();
		String title = "";//$NON-NLS-1$

		if (element == null)
			return null;
		// load pages for the selection

				.iterator();
		String name = getName(element);
		if (!pages.hasNext()) {
			MessageDialog.openInformation(shell,
					WorkbenchMessages.PropertyDialog_messageTitle, NLS.bind(
							WorkbenchMessages.PropertyDialog_noPropertyMessage,
							name));
							NLS.bind(WorkbenchMessages.PropertyDialog_noPropertyMessage,  name)); 
			return null;
		}
		title = NLS
				.bind(WorkbenchMessages.PropertyDialog_propertyMessage, name);
		PropertyDialog propertyDialog = new PropertyDialog(shell, pageManager,
				new StructuredSelection(element));


				IWorkbenchHelpContextIds.PROPERTY_DIALOG);

		return propertyDialog;

	}

	/**
	 * Returns the name of the given element.
	 * 
	 * @param element
	 *            the element
	 * @return the name of the element
	 */
	private static String getName(Object element) {
		IWorkbenchAdapter adapter = null;
		if (element instanceof IAdaptable) {
			adapter = (IWorkbenchAdapter) ((IAdaptable) element)
					.getAdapter(IWorkbenchAdapter.class);
		} else {
			adapter = (IWorkbenchAdapter) Platform.getAdapterManager()
					.getAdapter(element, IWorkbenchAdapter.class);
		}
		if (adapter != null)
			return adapter.getLabel(element);
		return "";//$NON-NLS-1$
	}
	
    /**
     * Create an instance of the receiver.
     * @param parentShell
     * @param mng
     * @param selection
     */
    public PropertyDialog(Shell parentShell, PreferenceManager mng,
            ISelection selection) {
        super(parentShell, mng);
        setSelection(selection);
    }

    /**
     * Returns selection in the "Properties" action context.
     * 
     * @return the selection
     */
    public ISelection getSelection() {
        return selection;
    }

    /**
     * Sets the selection that will be used to determine target object.
     * 
     * @param newSelection the new selection
     */
    public void setSelection(ISelection newSelection) {
        selection = newSelection;
    }

    /**
     * Get the name of the selected item preference
     */
    protected String getSelectedNodePreference() {
        return lastPropertyId;
    }

    /**
     * Get the name of the selected item preference
     */
    protected void setSelectedNodePreference(String pageId) {
        lastPropertyId = pageId;
    }
    

	/**
	 * Create an instance of the receiver.
	 * 
	 * @param parentShell
	 * @param mng
	 * @param selection
	 */
	public PropertyDialog(Shell parentShell, PreferenceManager mng,
			ISelection selection) {
		super(parentShell, mng);
		setSelection(selection);
	}

	/**
	 * Returns selection in the "Properties" action context.
	 * 
	 * @return the selection
	 */
	public ISelection getSelection() {
		return selection;
	}

	/**
	 * Sets the selection that will be used to determine target object.
	 * 
	 * @param newSelection
	 *            the new selection
	 */
	public void setSelection(ISelection newSelection) {
		selection = newSelection;
	}

	/**
	 * Get the name of the selected item preference
	 */
	protected String getSelectedNodePreference() {
		return lastPropertyId;
	}

	/**
	 * Get the name of the selected item preference
	 */
	protected void setSelectedNodePreference(String pageId) {
		lastPropertyId = pageId;
	}

}




 *******************************************************************************/
package org.eclipse.ui.internal.dialogs;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.ui.internal.IObjectContributor;

/**

    /**
     * Implement this method to add instances of PropertyPage class to the
     * property page manager.
     * @param manager the contributor manager onto which to contribute the
     * property pages.
     * @param object the type for which pages should be contributed. 
     * @return true if pages were added, false if not.
     */

    public boolean contributePropertyPages(PropertyPageManager manager,
            Object object);
}




        adaptable = Boolean.valueOf(pageElement.getAttribute(PropertyPagesRegistryReader.ATT_ADAPTABLE)).booleanValue();
    }

	 /* (non-Javadoc)
     * @see org.eclipse.ui.internal.dialogs.IPropertyPageContributor#contributePropertyPages(org.eclipse.ui.internal.dialogs.PropertyPageManager, java.lang.Object)
     * the configuration element.
     */
    public boolean contributePropertyPages(PropertyPageManager mng,
            Object element) {
        PropertyPageNode node = new PropertyPageNode(this, element);
        
        if(getCategory() == null){

     * @return the property page
     * @throws CoreException thrown if there is a problem creating the apge
     */
    public IWorkbenchPropertyPage createPage(Object element)
            throws CoreException {
        IWorkbenchPropertyPage ppage = null;
        ppage = (IWorkbenchPropertyPage) WorkbenchPlugin.createExtension(

           }
        }
        
        if(adapted instanceof IAdaptable)
        	ppage.setElement((IAdaptable) adapted);
        else
        	ppage.setElement(new AdaptableForwarder(adapted));

        return ppage;
    }

        if (iconName == null)
            return null;
        return AbstractUIPlugin.imageDescriptorFromPlugin(pageElement
                .getNamespaceIdentifier(), iconName);
    }

    /**




import java.util.Iterator;
import java.util.List;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.Platform;

	 * contributors and sequentially invoke them to contribute to the property
	 * page manager. Matching algorithm will also check subclasses and
	 * implemented interfaces.
	 * @param manager
	 * @param object
	 * @return true if contribution took place, false otherwise.
	 */
	public boolean contribute(PropertyPageManager manager, Object object) {

		List result = getContributors(object);


	/**
	 * Ideally, shared instance should not be used and manager should be located
	 * in the workbench class.
	 * @return PropertyPageContributorManager
	 */
	public static PropertyPageContributorManager getManager() {
		if (sharedInstance == null)

	}

	/**
	 * Returns true if contributors exist in the manager for this object.
	 */
	public boolean hasContributorsFor(Object object) {
		return super.hasContributorsFor(object);
	}

	/**
	 * Loads property page contributors from the registry.
	 */
	private void loadContributors() {




package org.eclipse.ui.internal.dialogs;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;


    private Image icon;

    private Object element;

    /**
     * Create a new instance of the receiver.

     * @param element
     */
    public PropertyPageNode(RegistryPageContributor contributor,
            Object element) {
        super(contributor.getPageId(), contributor.getConfigurationElement());
        this.contributor = contributor;
        this.element = element;




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at

 *******************************************************************************/
package org.eclipse.ui.dialogs;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.preference.PreferenceDialog;
import org.eclipse.jface.util.Assert;
import org.eclipse.jface.viewers.ISelectionProvider;

	 * @return boolean
	 */
	private boolean hasPropertyPagesFor(Object object) {
		return PropertyPageContributorManager.getManager().hasContributorsFor(object);
		return manager.hasContributorsFor(object);
	}

	/**

	 */
	public PreferenceDialog createDialog() {

		Object element = getStructuredSelection().getFirstElement();
		if (element == null)
			return null;
		return PropertyDialog

Lines 1-5 Link Here

(-)Eclipse UI/org/eclipse/ui/IWorkbenchPropertyPage.java (-1 / +9 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2004 IBM Corporation and others.	2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 12-17 Link Here
12		12
13	import org.eclipse.core.runtime.IAdaptable;	13	import org.eclipse.core.runtime.IAdaptable;
14	import org.eclipse.jface.preference.IPreferencePage;	14	import org.eclipse.jface.preference.IPreferencePage;
		15	import org.eclipse.ui.dialogs.PropertyDialogAction;
15		16
16	/**	17	/**
17	* Interface for workbench property pages. Property pages generally show up in	18	* Interface for workbench property pages. Property pages generally show up in
Lines 43-48 Link Here
43	* Sets the object that owns the properties shown in this page.	44	* Sets the object that owns the properties shown in this page.
44	* The page is expected to store this object and provide it if	45	* The page is expected to store this object and provide it if
45	* <code>getElement</code> is called.	46	* <code>getElement</code> is called.
		47	* <p> As of Eclipse 3.2 the org.eclipse.ui.propertyPages extension
		48	* point now supports non IAdaptable inputs. An input
		49	* that is not an IAdaptable will be wrapped in an
		50	* IAdaptable by the workbench before it is forwarded
		51	* to this method.
		52	* </p>
		53	* @see PropertyDialogAction
46	*	54	*
47	* @param element the object that owns the properties shown in this page	55	* @param element the object that owns the properties shown in this page
48	*/	56	*/




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.dialogs;

import org.eclipse.core.runtime.IAdaptable;

/**
 * Class that wraps an object and forwards adapter calls if possible, otherwise
 * returns the object. This is used to maintain API compatibility with methods that
 * need an IAdaptable but when the operation supports a broader type.
 * 
 * @since 3.2
 */
public class AdaptableForwarder implements IAdaptable {

	private Object element;
	
	/**
	 * Create a new instance of the receiver.
	 * @param element
	 */
	public AdaptableForwarder(Object element) {
		this.element = element;
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
	 */
	public Object getAdapter(Class adapter) {
		if(adapter.isInstance(element)) {
			return element;
		}
		if(element instanceof IAdaptable) {
			return ((IAdaptable)element).getAdapter(adapter);
		}
		return null;
	}
}

Return to bug 92601

Lines 67-78 Link Here

(-)Eclipse UI/org/eclipse/ui/internal/dialogs/RegistryPageContributor.java (-7 / +9 lines)
67	adaptable = Boolean.valueOf(pageElement.getAttribute(PropertyPagesRegistryReader.ATT_ADAPTABLE)).booleanValue();	67	adaptable = Boolean.valueOf(pageElement.getAttribute(PropertyPagesRegistryReader.ATT_ADAPTABLE)).booleanValue();
68	}	68	}
69		69
70	/**	70	/* (non-Javadoc)
71	* Implements the interface by creating property page specified with	71	* @see org.eclipse.ui.internal.dialogs.IPropertyPageContributor#contributePropertyPages(org.eclipse.ui.internal.dialogs.PropertyPageManager, java.lang.Object)
72	* the configuration element.
73	*/	72	*/
74	public boolean contributePropertyPages(PropertyPageManager mng,	73	public boolean contributePropertyPages(PropertyPageManager mng,
75	IAdaptable element) {	74	Object element) {
76	PropertyPageNode node = new PropertyPageNode(this, element);	75	PropertyPageNode node = new PropertyPageNode(this, element);
77		76
78	if(getCategory() == null){	77	if(getCategory() == null){
Lines 92-98 Link Here
92	* @return the property page	91	* @return the property page
93	* @throws CoreException thrown if there is a problem creating the apge	92	* @throws CoreException thrown if there is a problem creating the apge
94	*/	93	*/
95	public IWorkbenchPropertyPage createPage(IAdaptable element)	94	public IWorkbenchPropertyPage createPage(Object element)
96	throws CoreException {	95	throws CoreException {
97	IWorkbenchPropertyPage ppage = null;	96	IWorkbenchPropertyPage ppage = null;
98	ppage = (IWorkbenchPropertyPage) WorkbenchPlugin.createExtension(	97	ppage = (IWorkbenchPropertyPage) WorkbenchPlugin.createExtension(
Lines 111-117 Link Here
111	}	110	}
112	}	111	}
113		112
114	ppage.setElement((IAdaptable)adapted);	113	if(adapted instanceof IAdaptable)
		114	ppage.setElement((IAdaptable) adapted);
		115	else
		116	ppage.setElement(new AdaptableForwarder(adapted));
115		117
116	return ppage;	118	return ppage;
117	}	119	}
Lines 126-132 Link Here
126	if (iconName == null)	128	if (iconName == null)
127	return null;	129	return null;
128	return AbstractUIPlugin.imageDescriptorFromPlugin(pageElement	130	return AbstractUIPlugin.imageDescriptorFromPlugin(pageElement
129	.getNamespace(), iconName);	131	.getNamespaceIdentifier(), iconName);
130	}	132	}
131		133
132	/**	134	/**

Lines 18-24 Link Here

(-)Eclipse UI/org/eclipse/ui/internal/dialogs/PropertyPageContributorManager.java (-10 / +4 lines)
18	import java.util.Iterator;	18	import java.util.Iterator;
19	import java.util.List;	19	import java.util.List;
20		20
21	import org.eclipse.core.runtime.IAdaptable;
22	import org.eclipse.core.runtime.IConfigurationElement;	21	import org.eclipse.core.runtime.IConfigurationElement;
23	import org.eclipse.core.runtime.IExtension;	22	import org.eclipse.core.runtime.IExtension;
24	import org.eclipse.core.runtime.Platform;	23	import org.eclipse.core.runtime.Platform;
Lines 115-124 Link Here
115	* contributors and sequentially invoke them to contribute to the property	114	* contributors and sequentially invoke them to contribute to the property
116	* page manager. Matching algorithm will also check subclasses and	115	* page manager. Matching algorithm will also check subclasses and
117	* implemented interfaces.	116	* implemented interfaces.
118	*	117	* @param manager
		118	* @param object
119	* @return true if contribution took place, false otherwise.	119	* @return true if contribution took place, false otherwise.
120	*/	120	*/
121	public boolean contribute(PropertyPageManager manager, IAdaptable object) {	121	public boolean contribute(PropertyPageManager manager, Object object) {
122		122
123	List result = getContributors(object);	123	List result = getContributors(object);
124		124
Lines 176-181 Link Here
176	/**	176	/**
177	* Ideally, shared instance should not be used and manager should be located	177	* Ideally, shared instance should not be used and manager should be located
178	* in the workbench class.	178	* in the workbench class.
		179	* @return PropertyPageContributorManager
179	*/	180	*/
180	public static PropertyPageContributorManager getManager() {	181	public static PropertyPageContributorManager getManager() {
181	if (sharedInstance == null)	182	if (sharedInstance == null)
Lines 184-196 Link Here
184	}	185	}
185		186
186	/**	187	/**
187	* Returns true if contributors exist in the manager for this object.
188	*/
189	public boolean hasContributorsFor(Object object) {
190	return super.hasContributorsFor(object);
191	}
192
193	/**
194	* Loads property page contributors from the registry.	188	* Loads property page contributors from the registry.
195	*/	189	*/
196	private void loadContributors() {	190	private void loadContributors() {

Lines 10-16 Link Here

(-)Eclipse UI/org/eclipse/ui/internal/dialogs/IPropertyPageContributor.java (-3 / +4 lines)
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.ui.internal.dialogs;	11	package org.eclipse.ui.internal.dialogs;
12		12
13	import org.eclipse.core.runtime.IAdaptable;
14	import org.eclipse.ui.internal.IObjectContributor;	13	import org.eclipse.ui.internal.IObjectContributor;
15		14
16	/**	15	/**
Lines 23-31 Link Here
23	/**	22	/**
24	* Implement this method to add instances of PropertyPage class to the	23	* Implement this method to add instances of PropertyPage class to the
25	* property page manager.	24	* property page manager.
		25	* @param manager the contributor manager onto which to contribute the
		26	* property pages.
		27	* @param object the type for which pages should be contributed.
26	* @return true if pages were added, false if not.	28	* @return true if pages were added, false if not.
27	*/	29	*/
28
29	public boolean contributePropertyPages(PropertyPageManager manager,	30	public boolean contributePropertyPages(PropertyPageManager manager,
30	IAdaptable object);	31	Object object);
31	}	32	}

Lines 1-5 Link Here

(-)Eclipse UI/org/eclipse/ui/dialogs/PropertyDialogAction.java (-5 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2005 IBM Corporation and others.	2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 10-16 Link Here
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.ui.dialogs;	11	package org.eclipse.ui.dialogs;
12		12
13	import org.eclipse.core.runtime.IAdaptable;
14	import org.eclipse.jface.preference.PreferenceDialog;	13	import org.eclipse.jface.preference.PreferenceDialog;
15	import org.eclipse.jface.util.Assert;	14	import org.eclipse.jface.util.Assert;
16	import org.eclipse.jface.viewers.ISelectionProvider;	15	import org.eclipse.jface.viewers.ISelectionProvider;
Lines 101-108 Link Here
101	* @return boolean	100	* @return boolean
102	*/	101	*/
103	private boolean hasPropertyPagesFor(Object object) {	102	private boolean hasPropertyPagesFor(Object object) {
104	PropertyPageContributorManager manager = PropertyPageContributorManager.getManager();	103	return PropertyPageContributorManager.getManager().hasContributorsFor(object);
105	return manager.hasContributorsFor(object);
106	}	104	}
107		105
108	/**	106	/**
Lines 167-173 Link Here
167	*/	165	*/
168	public PreferenceDialog createDialog() {	166	public PreferenceDialog createDialog() {
169		167
170	IAdaptable element = (IAdaptable) getStructuredSelection().getFirstElement();	168	Object element = getStructuredSelection().getFirstElement();
171	if (element == null)	169	if (element == null)
172	return null;	170	return null;
173	return PropertyDialog	171	return PropertyDialog

Added Link Here

(-)Eclipse (+46 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Common Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/cpl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.ui.internal.dialogs;
12
13	import org.eclipse.core.runtime.IAdaptable;
14
15	/**
16	* Class that wraps an object and forwards adapter calls if possible, otherwise
17	* returns the object. This is used to maintain API compatibility with methods that
18	* need an IAdaptable but when the operation supports a broader type.
19	*
20	* @since 3.2
21	*/
22	public class AdaptableForwarder implements IAdaptable {
23
24	private Object element;
25
26	/**
27	* Create a new instance of the receiver.
28	* @param element
29	*/
30	public AdaptableForwarder(Object element) {
31	this.element = element;
32	}
33
34	/* (non-Javadoc)
35	* @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
36	*/
37	public Object getAdapter(Class adapter) {
38	if(adapter.isInstance(element)) {
39	return element;
40	}
41	if(element instanceof IAdaptable) {
42	return ((IAdaptable)element).getAdapter(adapter);
43	}
44	return null;
45	}
46	}