Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.swt / src / org / simantics / browsing / ui / swt / TabbedPageSelectionProvider.java

diff --git a/bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/TabbedPageSelectionProvider.java b/bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/TabbedPageSelectionProvider.java
new file mode 100644 (file)
index 0000000..f5da312
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/TabbedPageSelectionProvider.java
@@ -0,0 +1,181 @@
+/*******************************************************************************\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.browsing.ui.swt;\r
+\r
+/*******************************************************************************\r
+ * Copyright (c) 2000, 2007 IBM Corporation and others.\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
+ *     IBM Corporation - initial API and implementation\r
+ *******************************************************************************/\r
+\r
+import org.eclipse.core.runtime.Assert;\r
+import org.eclipse.core.runtime.ListenerList;\r
+import org.eclipse.core.runtime.SafeRunner;\r
+import org.eclipse.jface.util.SafeRunnable;\r
+import org.eclipse.jface.viewers.IPostSelectionProvider;\r
+import org.eclipse.jface.viewers.ISelection;\r
+import org.eclipse.jface.viewers.ISelectionChangedListener;\r
+import org.eclipse.jface.viewers.ISelectionProvider;\r
+import org.eclipse.jface.viewers.SelectionChangedEvent;\r
+import org.eclipse.jface.viewers.StructuredSelection;\r
+import org.eclipse.ui.IEditorPart;\r
+\r
+/**\r
+ * Manages the current selection in a multi-page editor by tracking the active\r
+ * nested editor within the multi-page editor. When the selection changes,\r
+ * notifications are sent to all registered listeners.\r
+ * <p>\r
+ * This class may be instantiated; it is not intended to be subclassed.\r
+ * The base implementation of <code>MultiPageEditor.init</code> creates\r
+ * an instance of this class.\r
+ * </p>\r
+ */\r
+public class TabbedPageSelectionProvider implements IPostSelectionProvider {\r
+\r
+    /**\r
+     * Registered selection changed listeners (element type:\r
+     * <code>ISelectionChangedListener</code>).\r
+     */\r
+    private final ListenerList listeners = new ListenerList();\r
+\r
+    /**\r
+     * Registered post selection changed listeners.\r
+     */\r
+    private final ListenerList postListeners = new ListenerList();\r
+\r
+    /**\r
+     * The multi-page editor.\r
+     */\r
+    private final TabbedPropertyPage multiPageEditor;\r
+\r
+    /**\r
+     * Creates a selection provider for the given multi-page editor.\r
+     *\r
+     * @param multiPageEditor the multi-page editor\r
+     */\r
+    public TabbedPageSelectionProvider(TabbedPropertyPage multiPageEditor) {\r
+        Assert.isNotNull(multiPageEditor);\r
+        this.multiPageEditor = multiPageEditor;\r
+    }\r
+\r
+    /* (non-Javadoc)\r
+     * Method declared on <code>ISelectionProvider</code>.\r
+     */\r
+    public void addSelectionChangedListener(ISelectionChangedListener listener) {\r
+        listeners.add(listener);\r
+    }\r
+\r
+    /**\r
+     * Adds a listener for post selection changes in this multi page selection provider.\r
+     *\r
+     * @param listener a selection changed listener\r
+     * @since 3.2\r
+     */\r
+    public void addPostSelectionChangedListener(ISelectionChangedListener listener) {\r
+        postListeners.add(listener);\r
+    }\r
+\r
+    /**\r
+     * Notifies all registered selection changed listeners that the editor's\r
+     * selection has changed. Only listeners registered at the time this method is\r
+     * called are notified.\r
+     *\r
+     * @param event the selection changed event\r
+     */\r
+    public void fireSelectionChanged(final SelectionChangedEvent event) {\r
+        Object[] listeners = this.listeners.getListeners();\r
+        fireEventChange(event, listeners);\r
+    }\r
+\r
+    /**\r
+     * Notifies all post selection changed listeners that the editor's\r
+     * selection has changed.\r
+     * \r
+     * @param event the event to propogate.\r
+     * @since 3.2\r
+     */\r
+    public void firePostSelectionChanged(final SelectionChangedEvent event) {\r
+        Object[] listeners = postListeners.getListeners();\r
+        fireEventChange(event, listeners);\r
+    }\r
+\r
+    private void fireEventChange(final SelectionChangedEvent event, Object[] listeners) {\r
+        for (int i = 0; i < listeners.length; ++i) {\r
+            final ISelectionChangedListener l = (ISelectionChangedListener) listeners[i];\r
+            SafeRunner.run(new SafeRunnable() {\r
+                public void run() {\r
+                    l.selectionChanged(event);\r
+                }\r
+            });\r
+        }\r
+    }\r
+\r
+    /**\r
+     * Returns the multi-page editor.\r
+     * @return the multi-page editor.\r
+     */\r
+    public TabbedPropertyPage getMultiPageEditor() {\r
+        return multiPageEditor;\r
+    }\r
+\r
+    /* (non-Javadoc)\r
+     * Method declared on <code>ISelectionProvider</code>.\r
+     */\r
+    public ISelection getSelection() {\r
+        IEditorPart activeEditor = multiPageEditor.getActiveEditor();\r
+        if (activeEditor != null) {\r
+            ISelectionProvider selectionProvider = activeEditor.getSite()\r
+            .getSelectionProvider();\r
+            if (selectionProvider != null) {\r
+                return selectionProvider.getSelection();\r
+            }\r
+        }\r
+        return StructuredSelection.EMPTY;\r
+    }\r
+\r
+    /* (non-JavaDoc)\r
+     * Method declaed on <code>ISelectionProvider</code>.\r
+     */\r
+    public void removeSelectionChangedListener(\r
+            ISelectionChangedListener listener) {\r
+        listeners.remove(listener);\r
+    }\r
+\r
+    /**\r
+     * Removes a listener for post selection changes in this multi page selection provider.\r
+     *\r
+     * @param listener a selection changed listener\r
+     * @since 3.2\r
+     */\r
+    public void removePostSelectionChangedListener(ISelectionChangedListener listener) {\r
+        postListeners.remove(listener);\r
+    }\r
+\r
+    /* (non-Javadoc)\r
+     * Method declared on <code>ISelectionProvider</code>.\r
+     */\r
+    public void setSelection(ISelection selection) {\r
+        IEditorPart activeEditor = multiPageEditor.getActiveEditor();\r
+        if (activeEditor != null) {\r
+            ISelectionProvider selectionProvider = activeEditor.getSite()\r
+            .getSelectionProvider();\r
+            if (selectionProvider != null) {\r
+                selectionProvider.setSelection(selection);\r
+            }\r
+        }\r
+    }\r
+}\r