Attachment 149331 Details for Bug 259048 – Patch v03

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

[patch] Patch v03

ToolbarContribution 03.txt (text/plain), 10.97 KB, created by Prakash Rangaraj

on 2009-10-12 03:11:02 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Prakash Rangaraj

Created: 2009-10-12 03:11:02 EDT

Size: 10.97 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.ui.workbench
>Index: Eclipse UI/org/eclipse/ui/internal/menus/DynamicToolBarContributionItem.java
>===================================================================
>RCS file: Eclipse UI/org/eclipse/ui/internal/menus/DynamicToolBarContributionItem.java
>diff -N Eclipse UI/org/eclipse/ui/internal/menus/DynamicToolBarContributionItem.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ Eclipse UI/org/eclipse/ui/internal/menus/DynamicToolBarContributionItem.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,183 @@
>+/*******************************************************************************
>+ * Copyright (c) 2009 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.menus;
>+
>+import org.eclipse.core.runtime.IConfigurationElement;
>+import org.eclipse.jface.action.IContributionItem;
>+import org.eclipse.jface.action.IContributionManager;
>+import org.eclipse.swt.widgets.Composite;
>+import org.eclipse.swt.widgets.Control;
>+import org.eclipse.swt.widgets.CoolBar;
>+import org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants;
>+import org.eclipse.ui.internal.util.Util;
>+import org.eclipse.ui.menus.IWorkbenchContribution;
>+import org.eclipse.ui.menus.WorkbenchWindowControlContribution;
>+import org.eclipse.ui.services.IServiceLocator;
>+
>+/**
>+ * A contribution item which proxies a dynamic tool contribution.
>+ * <p>
>+ * It currently supports placement in menus.
>+ * </p>
>+ * <p>
>+ * 
>+ * @author Prakash G.R.
>+ * 
>+ * @since 3.6
>+ * 
>+ */
>+public class DynamicToolBarContributionItem extends WorkbenchWindowControlContribution {
>+
>+	private final IConfigurationElement dynamicAddition;
>+	private final IServiceLocator locator;
>+	private boolean alreadyFailed;
>+	private WorkbenchWindowControlContribution loadedDynamicContribution;
>+
>+	/**
>+	 * Creates a DynamicToolBarContributionItem
>+	 * 
>+	 * @param id
>+	 *            - Id of the menu item
>+	 * @param locator
>+	 *            - The Service Locator
>+	 * @param dynamicAddition
>+	 *            - The Configuration Element defined in the plugin.xml
>+	 * 
>+	 */
>+	public DynamicToolBarContributionItem(String id, IServiceLocator locator,
>+			IConfigurationElement dynamicAddition) {
>+		super(id);
>+
>+		this.locator = locator;
>+		this.dynamicAddition = dynamicAddition;
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see org.eclipse.jface.action.ContributionItem#isDynamic()
>+	 */
>+	public boolean isDynamic() {
>+		if (loadedDynamicContribution != null) {
>+			return loadedDynamicContribution.isDynamic();
>+		}
>+		return true;
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see org.eclipse.jface.action.ContributionItem#isDirty()
>+	 */
>+	public boolean isDirty() {
>+		if (loadedDynamicContribution != null) {
>+			return loadedDynamicContribution.isDirty();
>+		}
>+		return super.isDirty();
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see
>+	 * org.eclipse.jface.action.ContributionItem#fill(org.eclipse.swt.widgets
>+	 * .CoolBar, int)
>+	 */
>+	public void fill(CoolBar parent, int index) {
>+		IContributionItem contributionItem = getContributionItem();
>+		if (contributionItem != null)
>+			contributionItem.fill(parent, index);
>+	}
>+
>+	private WorkbenchWindowControlContribution getContributionItem() {
>+		if (loadedDynamicContribution == null && !alreadyFailed)
>+			createContributionItem();
>+		return loadedDynamicContribution;
>+	}
>+
>+	private void createContributionItem() {
>+
>+		loadedDynamicContribution = (WorkbenchWindowControlContribution) Util
>+				.safeLoadExecutableExtension(dynamicAddition,
>+						IWorkbenchRegistryConstants.ATT_CLASS,
>+						WorkbenchWindowControlContribution.class);
>+
>+		if (loadedDynamicContribution == null) {
>+			alreadyFailed = true;
>+			return;
>+		}
>+
>+		loadedDynamicContribution.setId(getId());
>+		loadedDynamicContribution.setParent(getParent());
>+		if (loadedDynamicContribution instanceof IWorkbenchContribution) {
>+			((IWorkbenchContribution) loadedDynamicContribution)
>+					.initialize(locator);
>+		}
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see org.eclipse.jface.action.ContributionItem#dispose()
>+	 */
>+	public void dispose() {
>+		if (loadedDynamicContribution != null) {
>+			loadedDynamicContribution.dispose();
>+			loadedDynamicContribution = null;
>+		}
>+		super.dispose();
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see org.eclipse.jface.action.ContributionItem#update()
>+	 */
>+	public void update() {
>+		if (loadedDynamicContribution != null) {
>+			loadedDynamicContribution.update();
>+		}
>+	}
>+
>+	public void update(String id) {
>+		if (loadedDynamicContribution != null) {
>+			loadedDynamicContribution.update(id);
>+		}
>+	}
>+
>+	/*
>+	 * (non-Javadoc)
>+	 * 
>+	 * @see
>+	 * org.eclipse.jface.action.ContributionItem#setParent(org.eclipse.jface
>+	 * .action.IContributionManager)
>+	 */
>+	public void setParent(IContributionManager parent) {
>+		super.setParent(parent);
>+		if (loadedDynamicContribution != null) {
>+			loadedDynamicContribution.setParent(parent);
>+		}
>+	}
>+
>+	/* 
>+	 * (non-Javadoc)
>+	 * @see org.eclipse.jface.action.ControlContribution#createControl(org.eclipse.swt.widgets.Composite)
>+	 */
>+	public Control createControl(Composite parent) {
>+		
>+		WorkbenchWindowControlContribution contributionItem = getContributionItem();
>+		if (contributionItem != null)
>+			return contributionItem.delegateCreateControl(parent);
>+		return null;
>+	}
>+
>+}
>Index: Eclipse UI/org/eclipse/ui/internal/menus/MenuAdditionCacheEntry.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/menus/MenuAdditionCacheEntry.java,v
>retrieving revision 1.53
>diff -u -r1.53 MenuAdditionCacheEntry.java
>--- Eclipse UI/org/eclipse/ui/internal/menus/MenuAdditionCacheEntry.java	24 Nov 2008 18:43:07 -0000	1.53
>+++ Eclipse UI/org/eclipse/ui/internal/menus/MenuAdditionCacheEntry.java	12 Oct 2009 07:13:19 -0000
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2006, 2008 IBM Corporation and others.
>+ * Copyright (c) 2006, 2009 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
>@@ -14,10 +14,8 @@
> 
> import java.util.ArrayList;
> import java.util.HashMap;
>-import java.util.HashSet;
> import java.util.List;
> import java.util.Map;
>-import java.util.Set;
> 
> import org.eclipse.core.expressions.Expression;
> import org.eclipse.core.expressions.ExpressionConverter;
>@@ -37,13 +35,10 @@
> import org.eclipse.ui.internal.provisional.presentations.IActionBarPresentationFactory;
> import org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants;
> import org.eclipse.ui.internal.services.IWorkbenchLocationService;
>-import org.eclipse.ui.internal.util.Util;
> import org.eclipse.ui.menus.CommandContributionItem;
> import org.eclipse.ui.menus.CommandContributionItemParameter;
> import org.eclipse.ui.menus.IContributionRoot;
> import org.eclipse.ui.menus.IMenuService;
>-import org.eclipse.ui.menus.IWorkbenchContribution;
>-import org.eclipse.ui.menus.WorkbenchWindowControlContribution;
> import org.eclipse.ui.plugin.AbstractUIPlugin;
> import org.eclipse.ui.services.IServiceLocator;
> 
>@@ -53,16 +48,6 @@
>  */
> public class MenuAdditionCacheEntry extends AbstractMenuAdditionCacheEntry {
> 	
>-	// Caches
>-	
>-	/**
>-	 * If an {@link IConfigurationElement} is in the Set then we have already
>-	 * tried (and failed) to load the associated ExecutableExtension.
>-	 * 
>-	 * This is used to prevent multiple retries which would spam the Log.
>-	 */
>-	Set failedLoads = new HashSet();
>-
> 	/**
> 	 * Maps an IConfigurationElement to its parsed Expression
> 	 */
>@@ -284,33 +269,13 @@
> 	private IContributionItem createControlAdditionContribution(
> 			final IServiceLocator locator,
> 			final IConfigurationElement widgetAddition) {
>-		if (!inToolbar()) {
>-			return null;
>-		}
>-		// If we've already tried (and failed) to load the
>-		// executable extension then skip this addirion.
>-		if (failedLoads.contains(widgetAddition))
>-			return null;
> 
>-		// Attempt to load the addition's EE (creates a new instance)
>-		final WorkbenchWindowControlContribution loadedWidget = (WorkbenchWindowControlContribution) Util
>-				.safeLoadExecutableExtension(widgetAddition,
>-						IWorkbenchRegistryConstants.ATT_CLASS,
>-						WorkbenchWindowControlContribution.class);
>-
>-		// Cache failures
>-		if (loadedWidget == null) {
>-			failedLoads.add(widgetAddition);
>-			return null;
>-		}
>-
>-		// explicitly set the id
>-		loadedWidget.setId(getId(widgetAddition));
>-		if (loadedWidget instanceof IWorkbenchContribution) {
>-			((IWorkbenchContribution)loadedWidget).initialize(locator);
>+		if (inToolbar()) {
>+			return new DynamicToolBarContributionItem(getId(widgetAddition), locator, widgetAddition);
> 		}
>-
>-		return loadedWidget;
>+		
>+		return null;
>+		
> 	}
> 
> 	private IContributionItem createCommandAdditionContribution(
>Index: Eclipse UI/org/eclipse/ui/menus/WorkbenchWindowControlContribution.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/menus/WorkbenchWindowControlContribution.java,v
>retrieving revision 1.1
>diff -u -r1.1 WorkbenchWindowControlContribution.java
>--- Eclipse UI/org/eclipse/ui/menus/WorkbenchWindowControlContribution.java	2 Feb 2007 20:35:55 -0000	1.1
>+++ Eclipse UI/org/eclipse/ui/menus/WorkbenchWindowControlContribution.java	12 Oct 2009 07:13:19 -0000
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2007 IBM Corporation and others.
>+ * Copyright (c) 2007 - 2009 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
>@@ -13,6 +13,8 @@
> 
> import org.eclipse.jface.action.ControlContribution;
> import org.eclipse.swt.SWT;
>+import org.eclipse.swt.widgets.Composite;
>+import org.eclipse.swt.widgets.Control;
> import org.eclipse.ui.IWorkbenchWindow;
> import org.eclipse.ui.internal.menus.InternalControlContribution;
> 
>@@ -82,4 +84,21 @@
> 		
> 		return SWT.HORIZONTAL;
> 	}
>+
>+	/**
>+	 * Important: This method is *NOT* to be used/extended by clients. This is
>+	 * for the internal use inside Workbench
>+	 * 
>+	 * @param parent
>+	 *            the parent composite
>+	 * @return newly created Control
>+	 * @since 3.6
>+	 * 
>+	 * @noreference This method is not intended to be referenced by clients.
>+	 * @nooverride This method is not intended to be re-implemented or extended
>+	 *             by clients.
>+	 */
>+	public Control delegateCreateControl(Composite parent) {
>+		return createControl(parent);
>+	}
> }

Actions: View | Diff

Attachments on bug 259048: 120711 | 120917 | 129616 | 149331