Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.utils.ui / src / org / simantics / utils / ui / jface / CompoundContributionItem.java

diff --git a/bundles/org.simantics.utils.ui/src/org/simantics/utils/ui/jface/CompoundContributionItem.java b/bundles/org.simantics.utils.ui/src/org/simantics/utils/ui/jface/CompoundContributionItem.java
new file mode 100644 (file)
index 0000000..6e47695
--- /dev/null
+++ b/bundles/org.simantics.utils.ui/src/org/simantics/utils/ui/jface/CompoundContributionItem.java
@@ -0,0 +1,182 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.utils.ui.jface;
+
+import org.eclipse.jface.action.ContributionItem;
+import org.eclipse.jface.action.IContributionItem;
+import org.eclipse.jface.action.IContributionManager;
+import org.eclipse.jface.action.IMenuListener;
+import org.eclipse.jface.action.IMenuManager;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.CoolBar;
+import org.eclipse.swt.widgets.Menu;
+import org.eclipse.swt.widgets.MenuItem;
+import org.eclipse.swt.widgets.ToolBar;
+
+/**
+ * Modified version of org.eclipse.ui.actions.CompoundContributionItem
+ * This implementation adds ToolBar and CoolBar support.
+ * 
+ * @author Marko Luukkainen <marko.luukkainen@vtt.fi>
+ * 
+ */
+public abstract class CompoundContributionItem extends ContributionItem {
+
+    private boolean dirty = true;
+
+    private IMenuListener menuListener = new IMenuListener() {
+        public void menuAboutToShow(IMenuManager manager) {
+            manager.markDirty();
+            dirty = true;
+        }
+    };
+    
+    private IContributionItem[] oldItems;
+    
+    /**
+     * Creates a compound contribution item with a <code>null</code> id.
+     */
+    protected CompoundContributionItem() {
+        super();
+    }
+
+    /**
+     * Creates a compound contribution item with the given (optional) id.
+     *
+     * @param id the contribution item identifier, or <code>null</code>
+     */
+    protected CompoundContributionItem(String id) {
+        super(id);
+    }
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.action.ContributionItem#fill(org.eclipse.swt.widgets.Menu, int)
+     */
+    public void fill(Menu menu, int index) {
+        if (index == -1) {
+                       index = menu.getItemCount();
+               }
+        if (!dirty && menu.getParentItem() != null) {
+            // insert a dummy item so that the parent item is not disabled
+            new MenuItem(menu, SWT.NONE, index);
+            return;
+        }
+        
+        IContributionItem[] items = getContributionItemsToFill();
+        for (int i = 0; i < items.length; i++) {
+            IContributionItem item = items[i];
+            int oldItemCount = menu.getItemCount();
+            if (item.isVisible()) {
+                item.fill(menu, index);
+            }
+            int newItemCount = menu.getItemCount();
+            int numAdded = newItemCount - oldItemCount;
+            index += numAdded;
+        }
+        dirty = false;
+    }
+    
+    @Override
+    public void fill(CoolBar parent, int index) {
+       if (index == -1) {
+                       index = parent.getItemCount();
+               }
+//     if (!dirty ) {
+//            return;
+//        }
+       IContributionItem[] items = getContributionItemsToFill();
+       for (int i = 0; i < items.length; i++) {
+             IContributionItem item = items[i];
+             int oldItemCount = parent.getItemCount();
+             if (item.isVisible()) {
+                 item.fill(parent, index);
+             }
+             int newItemCount = parent.getItemCount();
+             int numAdded = newItemCount - oldItemCount;
+             index += numAdded;
+         }
+         dirty = false;
+    }
+    
+    @Override
+    public void fill(ToolBar parent, int index) {
+       if (index == -1) {
+                       index = parent.getItemCount();
+               }
+//     if (!dirty ) {
+//            return;
+//        }
+       IContributionItem[] items = getContributionItemsToFill();
+       for (int i = 0; i < items.length; i++) {
+            IContributionItem item = items[i];
+            int oldItemCount = parent.getItemCount();
+            if (item.isVisible()) {
+                item.fill(parent, index);
+            }
+            int newItemCount = parent.getItemCount();
+            int numAdded = newItemCount - oldItemCount;
+            index += numAdded;
+        }
+        dirty = false;
+    }
+    
+    /**
+        * Return a list of contributions items that will replace this item in the
+        * parent manager. The list must contain new contribution items every call
+        * since the old ones will be disposed.
+        * 
+        * @return an array list of items to display. Must not be <code>null</code>.
+        */
+    protected abstract IContributionItem[] getContributionItems();
+    
+    private IContributionItem[] getContributionItemsToFill() {
+        if (oldItems != null) {
+            for (int i = 0; i < oldItems.length; i++) {
+                IContributionItem oldItem = oldItems[i];
+                oldItem.dispose();
+            }
+            oldItems = null;
+        }
+        oldItems = getContributionItems();
+        return oldItems;
+    }
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.action.ContributionItem#isDirty()
+     */
+    public boolean isDirty() {
+        return dirty;
+    }
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.action.ContributionItem#isDynamic()
+     */
+    public boolean isDynamic() {
+        return true;
+    }
+    
+    
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.action.ContributionItem#setParent(org.eclipse.jface.action.IContributionManager)
+     */
+    public void setParent(IContributionManager parent) {
+        if (getParent() instanceof IMenuManager) {
+            IMenuManager menuMgr = (IMenuManager) getParent();
+            menuMgr.removeMenuListener(menuListener);
+        }
+        if (parent instanceof IMenuManager) {
+            IMenuManager menuMgr = (IMenuManager) parent;
+            menuMgr.addMenuListener(menuListener);
+        }
+        super.setParent(parent);
+    }
+}