Implement filter-based table viewer via the new FilterTable class

This moves the viewer-agnostic components of the FilterTree widget into
an AbstractFilteredStructuredViewer base class, which is then used to
implement the FilterTable widget.

The base class has been moved to org.eclipse.jface.text together with
the TextMatcher, to allow it to be used together with both an E3 and E4
workbench.

For the AbstractFilteredStructuredViewer, following methods have been
added to support this abstraction:
- isShowFilterControls()
- isQuickSelectionMode()
- init(int)

For the FilteredTree, following fields and methods have been marked as
for-removal:
- filterToolBar
- clearButtonControl
- updateToolbar(boolean)

To avoid code-duplication as a result of bug 260664, the code of
clearText() has been moved to a separate doClearText() method, so that
the same code can be invoked inside the listeners, without having to
worry about clearText() being overridden by subclasses.

This change adds a dependency from org.eclipse.jface.text to
org.eclipse.ui.workbench.

bundles/org.eclipse.e4.ui.dialogs/META-INF/MANIFEST.MF

@@ -2,13 +2,15 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.e4.ui.dialogs
-Bundle-Version: 1.5.0.qualifier
+Bundle-Version: 1.6.0.qualifier
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin
 Export-Package: org.eclipse.e4.ui.dialogs.filteredtree,
  org.eclipse.e4.ui.dialogs.textbundles;x-internal:=true,
  org.eclipse.e4.ui.internal.dialogs.about;x-internal:=true
+Import-Package: org.eclipse.jface.internal.text,
+ org.eclipse.jface.text
 Require-Bundle: org.eclipse.jface;bundle-version="3.11.0",
  org.eclipse.core.runtime;bundle-version="3.29.0"
 Automatic-Module-Name: org.eclipse.e4.ui.dialogs

bundles/org.eclipse.e4.ui.dialogs/src/org/eclipse/e4/ui/dialogs/filteredtree/FilteredTable.java

@@ -0,0 +1,236 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Patrick Ziegler and others.
+ *
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Patrick Ziegler - initial API and implementation
+ ******************************************************************************/
+package org.eclipse.e4.ui.dialogs.filteredtree;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.e4.ui.dialogs.textbundles.E4DialogMessages;
+import org.eclipse.jface.internal.text.TextMatcher;
+import org.eclipse.jface.text.AbstractFilteredStructuredViewer;
+import org.eclipse.jface.viewers.ILabelProvider;
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.TableViewer;
+import org.eclipse.jface.viewers.Viewer;
+import org.eclipse.jface.viewers.ViewerFilter;
+import org.eclipse.osgi.util.NLS;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.accessibility.AccessibleAdapter;
+import org.eclipse.swt.accessibility.AccessibleEvent;
+import org.eclipse.swt.events.KeyAdapter;
+import org.eclipse.swt.events.KeyEvent;
+import org.eclipse.swt.layout.GridData;
+import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Table;
+import org.eclipse.swt.widgets.TableItem;
+
+/**
+ * A simple control that provides a text widget and a table viewer. The contents
+ * of the text widget are used to drive a TextMatcher that is on the viewer.
+ *
+ * @since 1.6
+ */
+public class FilteredTable extends AbstractFilteredStructuredViewer {
+
+	/**
+	 * Default time for refresh job delay in ms
+	 */
+	private static final long DEFAULT_REFRESH_TIME = 200;
+
+	private TableViewer tableViewer;
+	private TextMatcher matcher;
+
+	public FilteredTable(Composite parent, int style) {
+		this(parent, style, DEFAULT_REFRESH_TIME);
+	}
+
+	public FilteredTable(Composite parent, int style, long refreshTime) {
+		super(parent, style, refreshTime);
+		init(style);
+	}
+
+	@Override
+	protected void createControl(Composite parent, int treeStyle) {
+		super.createControl(parent, treeStyle);
+
+		Composite tableComposite = new Composite(this, SWT.NONE);
+		GridLayout treeCompositeLayout = new GridLayout();
+		treeCompositeLayout.marginHeight = 0;
+		treeCompositeLayout.marginWidth = 0;
+		tableComposite.setLayout(treeCompositeLayout);
+		GridData data = new GridData(SWT.FILL, SWT.FILL, true, true);
+		tableComposite.setLayoutData(data);
+		createTableControl(tableComposite, treeStyle);
+	}
+
+	@Override
+	protected void createFilterText(Composite parent) {
+		super.createFilterText(parent);
+		getFilterControl().getAccessible().addAccessibleListener(new AccessibleAdapter() {
+			@Override
+			public void getName(AccessibleEvent e) {
+				String filterTextString = getFilterControl().getText();
+				if (filterTextString.isEmpty() || filterTextString.equals(getInitialText())) {
+					e.result = getInitialText();
+				} else {
+					e.result = NLS.bind(E4DialogMessages.FilteredTree_AccessibleListenerFiltered,
+							new String[] { filterTextString, String.valueOf(getFilteredItemsCount()) });
+				}
+			}
+
+			/**
+			 * Return the number of filtered items
+			 *
+			 * @return int
+			 */
+			private int getFilteredItemsCount() {
+				return getViewer().getTable().getItemCount();
+			}
+		});
+
+		getFilterControl().addKeyListener(new KeyAdapter() {
+			@Override
+			public void keyPressed(KeyEvent e) {
+				// on a CR we want to transfer focus to the list
+				boolean hasItems = getViewer().getTable().getItemCount() > 0;
+				if (hasItems && e.keyCode == SWT.ARROW_DOWN) {
+					getViewer().getTable().setFocus();
+					return;
+				}
+			}
+		});
+
+		// enter key set focus to table
+		getFilterControl().addTraverseListener(e -> {
+			if (e.detail == SWT.TRAVERSE_RETURN) {
+				e.doit = false;
+				if (getViewer().getTable().getItemCount() != 0) {
+					// if the initial filter text hasn't changed, do not try
+					// to match
+					boolean hasFocus = getViewer().getTable().setFocus();
+					boolean textChanged = !getInitialText().equals(getFilterControl().getText().trim());
+					if (hasFocus && textChanged && getFilterControl().getText().trim().length() > 0) {
+						Table table = getViewer().getTable();
+						TableItem item;
+						if (table.getSelectionCount() > 0) {
+							item = getFirstMatchingItem(table.getSelection());
+						} else {
+							item = getFirstMatchingItem(table.getItems());
+						}
+						if (item != null) {
+							table.setSelection(new TableItem[] { item });
+							ISelection sel = getViewer().getSelection();
+							getViewer().setSelection(sel, true);
+						}
+					}
+				}
+			}
+		});
+	}
+
+	/**
+	 * Return the first item in the tree that matches the filter pattern.
+	 *
+	 * @return the first matching TreeItem
+	 */
+	private TableItem getFirstMatchingItem(TableItem[] items) {
+		for (TableItem item : items) {
+			if (matcher == null) {
+				return item;
+			}
+
+			ILabelProvider labelProvider = (ILabelProvider) getViewer().getLabelProvider();
+			if (matcher.match(labelProvider.getText(item.getData()))) {
+				return item;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Creates and set up the table and table viewer. This method calls
+	 * {@link #doCreateTableViewer(Composite, int)} to create the table viewer.
+	 * Subclasses should override {@link #doCreateTableViewer(Composite, int)}
+	 * instead of overriding this method.
+	 *
+	 * @param parent parent <code>Composite</code>
+	 * @param style  SWT style bits used to create the table
+	 * @return the table
+	 */
+	protected Table createTableControl(Composite parent, int style) {
+		tableViewer = doCreateTableViewer(parent, style);
+		tableViewer.getControl().setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
+		tableViewer.addFilter(new ViewerFilter() {
+			@Override
+			public boolean select(Viewer viewer, Object parentElement, Object element) {
+				if (matcher == null) {
+					return true;
+				}
+				ILabelProvider labelProvider = (ILabelProvider) tableViewer.getLabelProvider();
+				return matcher.match(labelProvider.getText(element));
+			}
+		});
+		return tableViewer.getTable();
+	}
+
+	/**
+	 * Creates the table viewer. Subclasses may override.
+	 *
+	 * @param parent the parent composite
+	 * @param style  SWT style bits used to create the table viewer
+	 * @return the table viewer
+	 */
+	protected TableViewer doCreateTableViewer(Composite parent, int style) {
+		return new TableViewer(parent, style);
+	}
+
+	@Override
+	public TableViewer getViewer() {
+		return tableViewer;
+	}
+
+	@Override
+	protected BasicUIJob doCreateRefreshJob() {
+		return new BasicUIJob("Refresh Filter", getDisplay()) {//$NON-NLS-1$
+			@Override
+			public IStatus runInUIThread(IProgressMonitor monitor) {
+				if (getViewer().getControl().isDisposed()) {
+					return Status.CANCEL_STATUS;
+				}
+
+				String text = getFilterString();
+				if (text == null) {
+					return Status.OK_STATUS;
+				}
+
+				boolean initial = getInitialText() != null && getInitialText().equals(text);
+				if (initial) {
+					matcher = null;
+				} else if (text != null) {
+					matcher = new TextMatcher(text + '*', true, false);
+				}
+
+				tableViewer.refresh(true);
+
+				return Status.OK_STATUS;
+			}
+		};
+	}
+
+	@Override
+	protected boolean isShowFilterControls() {
+		return true;
+	}
+}