| /******************************************************************************* |
| * Copyright (c) 2000, 2005 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 |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.ui.internal.dialogs; |
| |
| import java.text.Collator; |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.Comparator; |
| import java.util.Hashtable; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.eclipse.core.runtime.IConfigurationElement; |
| import org.eclipse.core.runtime.IExtension; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker; |
| import org.eclipse.ui.internal.IWorkbenchConstants; |
| import org.eclipse.ui.internal.ObjectContributorManager; |
| import org.eclipse.ui.internal.WorkbenchPlugin; |
| import org.eclipse.ui.internal.registry.PropertyPagesRegistryReader; |
| |
| /** |
| * Extends generic object contributor manager by loading property page |
| * contributors from the registry. |
| */ |
| |
| public class PropertyPageContributorManager extends ObjectContributorManager { |
| private static PropertyPageContributorManager sharedInstance = null; |
| |
| private class CategorizedPageNode { |
| RegistryPageContributor contributor; |
| |
| CategorizedPageNode parent; |
| |
| String qualifiedName; |
| |
| CategorizedPageNode(RegistryPageContributor page) { |
| contributor = page; |
| } |
| |
| void setParent(CategorizedPageNode node) { |
| parent = node; |
| } |
| |
| String getQualifiedName() { |
| |
| if (qualifiedName == null) { |
| if (parent == null) { |
| qualifiedName = contributor.getPageName(); |
| } else { |
| StringBuffer nameBuffer = new StringBuffer(); |
| nameBuffer.append(parent.getQualifiedName()); |
| nameBuffer |
| .append(WorkbenchPlugin.PREFERENCE_PAGE_CATEGORY_SEPARATOR); |
| nameBuffer.append(contributor.getPageName()); |
| qualifiedName = nameBuffer.toString(); |
| } |
| } |
| return qualifiedName; |
| |
| } |
| } |
| |
| private static final Comparator comparer = new Comparator() { |
| private Collator collator = Collator.getInstance(); |
| |
| public int compare(Object arg0, Object arg1) { |
| // Make sure the workbench info page is always at the top. |
| CategorizedPageNode c1 = (CategorizedPageNode) arg0; |
| CategorizedPageNode c2 = (CategorizedPageNode) arg1; |
| if (IWorkbenchConstants.WORKBENCH_PROPERTIES_PAGE_INFO.equals(c1 |
| .contributor.getPageId())) { |
| // c1 is the info page |
| if (IWorkbenchConstants.WORKBENCH_PROPERTIES_PAGE_INFO |
| .equals(c2.contributor.getPageId())) { |
| // both are the info page so c2 is not greater |
| return 0; |
| } |
| // c2 is any other page so it must be greater |
| return -1; |
| } |
| if (IWorkbenchConstants.WORKBENCH_PROPERTIES_PAGE_INFO.equals(c2 |
| .contributor.getPageId())) { |
| // c1 is any other page so it is greater |
| return 1; |
| } |
| // The other pages are sorted in alphabetical order |
| String s1 = c1.getQualifiedName(); |
| String s2 = c2.getQualifiedName(); |
| return collator.compare(s1, s2); |
| } |
| }; |
| |
| /** |
| * The constructor. |
| */ |
| public PropertyPageContributorManager() { |
| super(); |
| // load contributions on startup so that getContributors() returns the |
| // proper content |
| loadContributors(); |
| } |
| |
| /** |
| * Given the object class, this method will find all the registered matching |
| * 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); |
| |
| if (result == null || result.size() == 0) { |
| return false; |
| } |
| |
| // Sort the results |
| List sortedResult = buildNodeList(result); |
| Collections.sort(sortedResult, comparer); |
| |
| Iterator resultIterator = sortedResult.iterator(); |
| |
| // Allow each contributor to add its page to the manager. |
| boolean actualContributions = false; |
| while(resultIterator.hasNext()) { |
| for (int i = 0; i < sortedResult.size(); i++) { |
| CategorizedPageNode next = (CategorizedPageNode) resultIterator.next(); |
| IPropertyPageContributor ppcont = next.contributor; |
| if (!ppcont.isApplicableTo(object)) { |
| continue; |
| } |
| if (ppcont.contributePropertyPages(manager, object)) { |
| actualContributions = true; |
| } |
| } |
| } |
| return actualContributions; |
| } |
| |
| /** |
| * Build the list of nodes to be sorted. |
| * @param nodes |
| * @return List of CategorizedPageNode |
| */ |
| private List buildNodeList(List nodes) { |
| Hashtable mapping = new Hashtable(); |
| |
| Iterator nodesIterator = nodes.iterator(); |
| while(nodesIterator.hasNext()){ |
| RegistryPageContributor page = (RegistryPageContributor) nodesIterator.next(); |
| mapping.put(page.getPageId(),new CategorizedPageNode(page)); |
| } |
| |
| Iterator values = mapping.values().iterator(); |
| List returnValue = new ArrayList(); |
| while(values.hasNext()){ |
| CategorizedPageNode next = (CategorizedPageNode) values.next(); |
| returnValue.add(next); |
| if(next.contributor.getCategory() == null) { |
| continue; |
| } |
| Object parent = mapping.get(next.contributor.getCategory()); |
| if(parent != null) { |
| next.setParent((CategorizedPageNode) parent); |
| } |
| } |
| return returnValue; |
| } |
| |
| /** |
| * 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) { |
| sharedInstance = new PropertyPageContributorManager(); |
| } |
| return sharedInstance; |
| } |
| |
| /** |
| * Loads property page contributors from the registry. |
| */ |
| private void loadContributors() { |
| PropertyPagesRegistryReader reader = new PropertyPagesRegistryReader( |
| this); |
| reader.registerPropertyPages(Platform.getExtensionRegistry()); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.core.runtime.dynamicHelpers.IExtensionChangeHandler#addExtension(org.eclipse.core.runtime.dynamicHelpers.IExtensionTracker, org.eclipse.core.runtime.IExtension) |
| */ |
| public void addExtension(IExtensionTracker tracker, IExtension extension) { |
| IConfigurationElement[] addedElements = extension.getConfigurationElements(); |
| for (int i = 0; i < addedElements.length; i++) { |
| PropertyPagesRegistryReader reader = new PropertyPagesRegistryReader(this); |
| reader.readElement(addedElements[i]); |
| } |
| } |
| } |