]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/FilterArea.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.browsing.ui.swt / src / org / simantics / browsing / ui / swt / FilterArea.java
diff --git a/bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/FilterArea.java b/bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/FilterArea.java
new file mode 100644 (file)
index 0000000..2529740
--- /dev/null
@@ -0,0 +1,375 @@
+/*******************************************************************************\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
+import java.util.HashMap;\r
+import java.util.Map;\r
+import java.util.concurrent.TimeUnit;\r
+import java.util.concurrent.atomic.AtomicInteger;\r
+\r
+import org.eclipse.jface.layout.GridDataFactory;\r
+import org.eclipse.jface.layout.GridLayoutFactory;\r
+import org.eclipse.jface.resource.FontDescriptor;\r
+import org.eclipse.jface.resource.ImageDescriptor;\r
+import org.eclipse.jface.resource.JFaceResources;\r
+import org.eclipse.jface.resource.LocalResourceManager;\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.SelectionChangedEvent;\r
+import org.eclipse.swt.SWT;\r
+import org.eclipse.swt.accessibility.ACC;\r
+import org.eclipse.swt.accessibility.AccessibleAdapter;\r
+import org.eclipse.swt.accessibility.AccessibleControlAdapter;\r
+import org.eclipse.swt.accessibility.AccessibleControlEvent;\r
+import org.eclipse.swt.accessibility.AccessibleEvent;\r
+import org.eclipse.swt.events.ModifyEvent;\r
+import org.eclipse.swt.events.ModifyListener;\r
+import org.eclipse.swt.events.MouseAdapter;\r
+import org.eclipse.swt.events.MouseEvent;\r
+import org.eclipse.swt.events.MouseMoveListener;\r
+import org.eclipse.swt.events.MouseTrackListener;\r
+import org.eclipse.swt.events.SelectionAdapter;\r
+import org.eclipse.swt.events.SelectionEvent;\r
+import org.eclipse.swt.graphics.Image;\r
+import org.eclipse.swt.graphics.Point;\r
+import org.eclipse.swt.layout.GridData;\r
+import org.eclipse.swt.widgets.Composite;\r
+import org.eclipse.swt.widgets.Control;\r
+import org.eclipse.swt.widgets.Display;\r
+import org.eclipse.swt.widgets.Label;\r
+import org.eclipse.swt.widgets.Text;\r
+import org.eclipse.ui.ISharedImages;\r
+import org.eclipse.ui.internal.WorkbenchImages;\r
+import org.eclipse.ui.internal.WorkbenchMessages;\r
+import org.simantics.browsing.ui.GraphExplorer;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.common.processors.FilterSelectionRequestQueryProcessor;\r
+import org.simantics.browsing.ui.common.views.IFilterArea;\r
+import org.simantics.browsing.ui.common.views.IFilterAreaProvider;\r
+import org.simantics.browsing.ui.common.views.IFocusable;\r
+import org.simantics.db.layer0.SelectionHints;\r
+import org.simantics.utils.threads.SWTThread;\r
+import org.simantics.utils.threads.ThreadUtils;\r
+import org.simantics.utils.ui.ISelectionUtils;\r
+\r
+@SuppressWarnings("restriction")\r
+public class FilterArea extends Composite implements IFocusable, IFilterArea, IFilterAreaProvider {\r
+\r
+    protected static final Integer                 FILTER_DELAY = 500;\r
+\r
+    private final LocalResourceManager             resourceManager;\r
+\r
+    protected GraphExplorer                        explorer;\r
+\r
+    protected FilterSelectionRequestQueryProcessor queryProcessor;\r
+\r
+    private Text                                   filterText;\r
+    private NodeContext                                                           currentContext;\r
+\r
+    /**\r
+     * The control representing the clear button for the filter text entry. This\r
+     * value may be <code>null</code> if no such button exists, or if the\r
+     * controls have not yet been created.\r
+     */\r
+    protected Control                              clearButtonControl;\r
+\r
+    /**\r
+     * Construct the filter area UI component.\r
+     * \r
+     * @param explorer\r
+     * @param queryProcessor\r
+     * @param parent\r
+     * @param style\r
+     */\r
+    public FilterArea(final GraphExplorer explorer, final FilterSelectionRequestQueryProcessor queryProcessor, Composite parent, int style) {\r
+        super(parent, style | SWT.BORDER);\r
+\r
+        this.explorer = explorer;\r
+        this.queryProcessor = queryProcessor;\r
+\r
+        resourceManager = new LocalResourceManager(JFaceResources.getResources(parent.getDisplay()), this);\r
+\r
+        GridDataFactory.fillDefaults().grab(true, false).span(2, 1).applyTo(this);\r
+        GridLayoutFactory.fillDefaults().margins(0, 0).spacing(0, 0).numColumns(2).equalWidth(false).applyTo(this);\r
+\r
+        createFilterText(this);\r
+        createFilterCancelIcon(this);\r
+\r
+        this.setBackground(filterText.getBackground());\r
+\r
+        addTextModifyListener();\r
+        addExplorerSelectionListener();\r
+    }\r
+\r
+    private void createFilterText(FilterArea filterArea) {\r
+        //filterText = new Text(this, SWT.SINGLE | SWT.FLAT | SWT.SEARCH | SWT.ICON_CANCEL);\r
+        filterText = new Text(this, SWT.SINGLE | SWT.ICON_CANCEL);\r
+        GridDataFactory.fillDefaults().grab(true, false).applyTo(filterText);\r
+\r
+        filterText.setFont(resourceManager.createFont(FontDescriptor.createFrom(filterText.getFont()).increaseHeight(-1)));\r
+\r
+        // if we're using a field with built in cancel we need to listen for\r
+        // default selection changes (which tell us the cancel button has been\r
+        // pressed)\r
+        if ((filterText.getStyle() & SWT.ICON_CANCEL) != 0) {\r
+            filterText.addSelectionListener(new SelectionAdapter() {\r
+                @Override\r
+                public void widgetDefaultSelected(SelectionEvent e) {\r
+                    if (e.detail == SWT.ICON_CANCEL)\r
+                        clearText();\r
+                }\r
+            });\r
+        }\r
+\r
+        GridData gridData = new GridData(SWT.FILL, SWT.CENTER, true, true);\r
+\r
+        // if the text widget supported cancel then it will have it's own\r
+        // integrated button. We can take all of the space.\r
+        if ((filterText.getStyle() & SWT.ICON_CANCEL) != 0)\r
+            gridData.horizontalSpan = 2;\r
+        filterText.setLayoutData(gridData);\r
+    }\r
+\r
+    private void createFilterCancelIcon(Composite parent) {\r
+        // only create the button if the text widget doesn't support one\r
+        // natively\r
+        if ((filterText.getStyle() & SWT.ICON_CANCEL) == 0) {\r
+            final Image inactiveImage = WorkbenchImages.getImage(ISharedImages.IMG_ETOOL_CLEAR_DISABLED);\r
+            final Image activeImage = WorkbenchImages.getImage(ISharedImages.IMG_ETOOL_CLEAR);\r
+            final Image pressedImage = (Image) resourceManager.get( ImageDescriptor.createWithFlags( ImageDescriptor.createFromImage( activeImage ), SWT.IMAGE_GRAY ) );\r
+\r
+            final Label clearButton= new Label(parent, SWT.NONE);\r
+            clearButton.setLayoutData(new GridData(SWT.BEGINNING, SWT.CENTER, false, false));\r
+            clearButton.setImage(inactiveImage);\r
+            clearButton.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_LIST_BACKGROUND));\r
+            clearButton.setToolTipText(WorkbenchMessages.FilteredTree_ClearToolTip);\r
+            clearButton.addMouseListener(new MouseAdapter() {\r
+                private MouseMoveListener fMoveListener;\r
+\r
+                @Override\r
+                public void mouseDown(MouseEvent e) {\r
+                    clearButton.setImage(pressedImage);\r
+                    fMoveListener= new MouseMoveListener() {\r
+                        private boolean fMouseInButton= true;\r
+\r
+                        @Override\r
+                        public void mouseMove(MouseEvent e) {\r
+                            boolean mouseInButton= isMouseInButton(e);\r
+                            if (mouseInButton != fMouseInButton) {\r
+                                fMouseInButton= mouseInButton;\r
+                                clearButton.setImage(mouseInButton ? pressedImage : inactiveImage);\r
+                            }\r
+                        }\r
+                    };\r
+                    clearButton.addMouseMoveListener(fMoveListener);\r
+                }\r
+\r
+                @Override\r
+                public void mouseUp(MouseEvent e) {\r
+                    if (fMoveListener != null) {\r
+                        clearButton.removeMouseMoveListener(fMoveListener);\r
+                        fMoveListener= null;\r
+                        boolean mouseInButton= isMouseInButton(e);\r
+                        clearButton.setImage(mouseInButton ? activeImage : inactiveImage);\r
+                        if (mouseInButton) {\r
+                            clearText();\r
+                            filterText.setFocus();\r
+                        }\r
+                    }\r
+                }\r
+\r
+                private boolean isMouseInButton(MouseEvent e) {\r
+                    Point buttonSize = clearButton.getSize();\r
+                    return 0 <= e.x && e.x < buttonSize.x && 0 <= e.y && e.y < buttonSize.y;\r
+                }\r
+            });\r
+            clearButton.addMouseTrackListener(new MouseTrackListener() {\r
+                @Override\r
+                public void mouseEnter(MouseEvent e) {\r
+                    clearButton.setImage(activeImage);\r
+                }\r
+\r
+                @Override\r
+                public void mouseExit(MouseEvent e) {\r
+                    clearButton.setImage(inactiveImage);\r
+                }\r
+\r
+                @Override\r
+                public void mouseHover(MouseEvent e) {\r
+                }\r
+            });\r
+            clearButton.getAccessible().addAccessibleListener(\r
+                    new AccessibleAdapter() {\r
+                        @Override\r
+                        public void getName(AccessibleEvent e) {\r
+                            e.result= WorkbenchMessages.FilteredTree_AccessibleListenerClearButton;\r
+                        }\r
+                    });\r
+            clearButton.getAccessible().addAccessibleControlListener(\r
+                    new AccessibleControlAdapter() {\r
+                        @Override\r
+                        public void getRole(AccessibleControlEvent e) {\r
+                            e.detail= ACC.ROLE_PUSHBUTTON;\r
+                        }\r
+                    });\r
+            this.clearButtonControl = clearButton;\r
+        }\r
+    }\r
+\r
+    /**\r
+     * Clears the text in the filter text widget.\r
+     */\r
+    protected void clearText() {\r
+        //System.out.println("clearText");\r
+        filterText.setText(""); //$NON-NLS-1$\r
+        // TODO: HACK: this can be used to access filter for root context\r
+        explorer.select(null);\r
+        //textChanged();\r
+    }\r
+\r
+    protected void addTextModifyListener() {\r
+        filterText.addModifyListener(new ModifyListener() {\r
+\r
+            Map<NodeContext, AtomicInteger> modCount = new HashMap<NodeContext, AtomicInteger>();\r
+\r
+            @Override\r
+            public void modifyText(ModifyEvent e) {\r
+\r
+                final NodeContext context = getFilteredNode();\r
+                if (context == null)\r
+                    return;\r
+\r
+                final String filter = filterText.getText();\r
+                //System.out.println("Scheduling setFilter(" + context + ", " + filter + ")");\r
+\r
+                AtomicInteger i = modCount.get(context);\r
+                if (i == null)\r
+                    modCount.put(context, new AtomicInteger());\r
+                final AtomicInteger counter = modCount.get(context);\r
+                final int count = counter.incrementAndGet();\r
+\r
+                ThreadUtils.getNonBlockingWorkExecutor().schedule(new Runnable() {\r
+                    @Override\r
+                    public void run() {\r
+                        int newCount = counter.get();\r
+                        if (newCount != count)\r
+                            return;\r
+                        //System.out.println("schedule setFilter(" + context + ", " + filter + ")");\r
+                        modCount.remove(context);\r
+                        if (isDisposed())\r
+                            return;\r
+                        ThreadUtils.asyncExec(SWTThread.getThreadAccess(getDisplay()), new Runnable() {\r
+                            @Override\r
+                            public void run() {\r
+                                if (isDisposed())\r
+                                    return;\r
+                                //System.out.println("queryProcessor.setFilter(" + context + ", " + filter + ")");\r
+                                queryProcessor.setFilter(context, filter.isEmpty() ? null : filter);\r
+                            }\r
+                        });\r
+                    }\r
+                }, FILTER_DELAY, TimeUnit.MILLISECONDS);\r
+            }\r
+        });\r
+    }\r
+\r
+    protected void addExplorerSelectionListener() {\r
+        IPostSelectionProvider selectionProvider = (IPostSelectionProvider)explorer.getAdapter(IPostSelectionProvider.class);\r
+        selectionProvider.addSelectionChangedListener(new ISelectionChangedListener() {\r
+            @Override\r
+            public void selectionChanged(SelectionChangedEvent event) {\r
+\r
+                ISelection selection = event.getSelection();\r
+                NodeContext context = ISelectionUtils.getSinglePossibleKey(selection, SelectionHints.KEY_MAIN, NodeContext.class);\r
+                if(context == null) {\r
+                    context = ISelectionUtils.filterSingleSelection(selection, NodeContext.class);\r
+                }\r
+\r
+                if (context == null) {\r
+                    context = explorer.getRoot();\r
+                }\r
+\r
+                assert (context != null);\r
+\r
+                String filter = queryProcessor.getFilter(context);\r
+\r
+                if (filter == null)\r
+                    filter = "";\r
+\r
+                //filterText.setData(null);\r
+                //System.out.println("selection changed, new filter: " + filter + " for context " + context + ", currentContext=" + currentContext);\r
+                currentContext = context;\r
+                filterText.setText(filter);\r
+                //filterText.setData("context", context);\r
+            }\r
+        });\r
+    }\r
+\r
+    protected NodeContext getFilteredNode() {\r
+        if(currentContext != null) return currentContext;\r
+        else return explorer.getRoot();\r
+//     return currentContext;\r
+//     NodeContext context = (NodeContext)filterText.getData("context");\r
+//     if (context == null)\r
+//             context = explorer.getRoot();\r
+//        return context;\r
+\r
+    }\r
+\r
+    @Override\r
+    public void focus() {\r
+        if (filterText.isDisposed())\r
+            return;\r
+        Display d = filterText.getDisplay();\r
+        if (d.getThread() == Thread.currentThread()) {\r
+            doSetFocus();\r
+        } else {\r
+            d.asyncExec(new Runnable() {\r
+                @Override\r
+                public void run() {\r
+                    if (filterText.isDisposed())\r
+                        return;\r
+                    doSetFocus();\r
+                }\r
+            });\r
+        }\r
+    }\r
+\r
+    @Override\r
+    public void dispose() {\r
+       \r
+        if (isDisposed())\r
+            return;\r
+        \r
+        resourceManager.dispose();\r
+        explorer = null;\r
+        queryProcessor = null;\r
+        filterText = null;\r
+        currentContext = null;\r
+        clearButtonControl = null;\r
+        \r
+        super.dispose();\r
+        \r
+    }\r
+\r
+    protected void doSetFocus() {\r
+        filterText.selectAll();\r
+        filterText.setFocus();\r
+    }\r
+\r
+    @Override\r
+    public IFilterArea getFilterArea() {\r
+        return this;\r
+    }\r
+\r
+}\r