tmf.ui: make AbstractSelectTreeViewer2 injectable; add AbstractSelectTreeViewer3 and MultiTreePatternFilter2 for column-aware filtering

Signed-off-by: Hong Anh <[email protected]>

Author: ShadowK2494

tmf/org.eclipse.tracecompass.tmf.ui/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-Vendor: %Bundle-Vendor
-Bundle-Version: 9.1.2.qualifier
+Bundle-Version: 9.2.0
 Bundle-Localization: plugin
 Bundle-SymbolicName: org.eclipse.tracecompass.tmf.ui;singleton:=true
 Bundle-Activator: org.eclipse.tracecompass.internal.tmf.ui.Activator
@@ -30,7 +30,9 @@ Require-Bundle: org.eclipse.core.expressions,
  org.eclipse.tracecompass.tmf.filter.parser,
  org.eclipse.e4.ui.css.swt.theme,
  org.eclipse.ui.themes,
- org.eclipse.jdt.annotation;bundle-version="[2.0.0,3.0.0)";resolution:=optional
+ org.eclipse.jdt.annotation;bundle-version="[2.0.0,3.0.0)";resolution:=optional,
+ org.eclipse.equinox.p2.ui;bundle-version="2.8.500",
+ org.eclipse.ui.browser;bundle-version="3.8.300"
 Export-Package: org.eclipse.tracecompass.internal.provisional.tmf.ui.model;x-internal:=true,
  org.eclipse.tracecompass.internal.provisional.tmf.ui.viewers.xychart;x-internal:=true,
  org.eclipse.tracecompass.internal.provisional.tmf.ui.widgets;x-friends:="org.eclipse.tracecompass.analysis.timing.ui",
@@ -151,5 +153,5 @@ Import-Package: com.google.common.annotations,
  org.apache.commons.io,
  org.eclipse.emf.common.util,
  org.eclipse.emf.ecore,
- org.eclipse.tracecompass.traceeventlogger
+ org.eclipse.tracecompass.traceeventlogger;resolution:=optional
 Automatic-Module-Name: org.eclipse.tracecompass.tmf.ui

tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/tree/AbstractSelectTreeViewer2.java

@@ -220,7 +220,7 @@ public String getColumnText(Object element, int columnIndex) {
      * @param legendColumnIndex
      *            index of the legend column (-1 if none)
      */
-    private AbstractSelectTreeViewer2(Composite parent, TriStateFilteredCheckboxTree checkboxTree,
+    protected AbstractSelectTreeViewer2(Composite parent, TriStateFilteredCheckboxTree checkboxTree,
             int legendIndex, String id) {
         super(parent, checkboxTree.getViewer());
 

tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/tree/AbstractSelectTreeViewer3.java

@@ -0,0 +1,49 @@
+/*******************************************************************************
+ * Copyright (c) 2017, 2025 Ericsson, Draeger Auriga
+ *
+ * All rights reserved. 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
+ *******************************************************************************/
+
+package org.eclipse.tracecompass.tmf.ui.viewers.tree;
+
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.tracecompass.tmf.core.model.tree.ITmfTreeDataProvider;
+import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.dialogs.SpecificColumnPatternFilter;
+import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.dialogs.TriStateFilteredCheckboxTree;
+
+/**
+ * An abstract tree viewer that supports selection with filtering capabilities.
+ *
+ * This viewer extends
+ *     {@link AbstractSelectTreeViewer2}
+ * to allow filtering based on a specific column index.
+ *
+ * @author Hong Anh
+ * @since 9.2
+ */
+public abstract class AbstractSelectTreeViewer3 extends AbstractSelectTreeViewer2 {
+    /**
+     * Constructor
+     *
+     * @param parent
+     *            Parent composite
+     * @param legendIndex
+     *            index of the legend column (-1 if none)
+     * @param id
+     *            {@link ITmfTreeDataProvider} ID
+     * @param indexColumnFilter
+     *            the index of the column to apply the filter on
+     */
+    public AbstractSelectTreeViewer3(Composite parent, int legendIndex, String id, int indexColumnFilter) {
+        // Initialize the tree viewer with a filtered checkbox tree and column-based filtering
+        super(parent, new TriStateFilteredCheckboxTree(parent,
+                SWT.MULTI | SWT.H_SCROLL | SWT.FULL_SELECTION,
+                new SpecificColumnPatternFilter(indexColumnFilter), true, false), legendIndex, id);
+    }
+}

tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/dialogs/MultiTreePatternFilter.java

@@ -74,8 +74,8 @@ protected boolean isLeafMatch(Viewer viewer, Object element) {
 
         // Ensure the tree element and its parent(s) match the filter text
         for (Predicate<String> p : fPredicates) {
-            // Retrieve tree element text and make verification. Text is at column 0
-            String labelText = labelProvider.getColumnText(node, 0);
+            // Get the text of the element in the specified column and verify against the predicate
+            String labelText = labelProvider.getColumnText(node, this.getIndexColumnFilter());
             if (labelText == null || !p.test(labelText)) {
                 return false;
             }
@@ -85,4 +85,13 @@ protected boolean isLeafMatch(Viewer viewer, Object element) {
         }
         return true;
     }
+
+    /**
+     * Returns the index of the column used for filtering.
+     * @return the column index (default is 0)
+     * @since 9.2
+     */
+    protected int getIndexColumnFilter() {
+        return 0;
+    }
 }

tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/dialogs/SpecificColumnPatternFilter.java

@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Ericsson
+ *
+ * All rights reserved. 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
+ *******************************************************************************/
+
+package org.eclipse.tracecompass.tmf.ui.widgets.timegraph.dialogs;
+
+
+/**
+ * A filter that extends {@link MultiTreePatternFilter} to allow filtering
+ * based on a specific column index.
+ *
+ * This implementation enables users to apply multiple patterns (separated by '/')
+ * while specifying which column of the tree should be used for matching.
+ *
+ * @author Hong Anh
+ * @since 9.2
+ */
+
+public class SpecificColumnPatternFilter extends MultiTreePatternFilter {
+    private int index = 0;
+
+    /**
+     * Creates a new filter with the specified column index.
+     * @param indexColumnFilter the index of the column to apply the filter on
+     */
+
+    public SpecificColumnPatternFilter(int indexColumnFilter) {
+        this.index = indexColumnFilter;
+    }
+
+    /**
+     * Returns the index of the column used for filtering.
+     * @return the column index specified during construction
+     */
+    @Override
+    protected int getIndexColumnFilter() {
+        return this.index;
+    }
+}