Add entry-tree parameter to collapse children #277

hriday-panchasara · 2025-06-03T17:01:03Z

What it does

tmf: Add auto-expand level in TmfTreeModel

The auto-expand level is supposed to be used for the input of the tree. The value 0 means that there is no auto-expand; 1 means that top-level elements are expanded, but not their children; 2 means that top-level elements are expanded, and their children, but not grand-children; and so on.

The value -1 means that all subtrees should be expanded (default).

Contributes to fix eclipse-cdt-cloud/theia-trace-extension#801

How to test

Run updated unit test.

Follow-ups

Related incubator PR.
eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#196

Review checklist

As an author, I have thoroughly tested my changes and carefully followed the instructions in this template

Signed-off-by: Hriday Panchasara [email protected]
Signed-off-by: Bernd Hufmann [email protected]

bhufmann · 2025-06-03T20:22:59Z

....tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeCompositeDataProvider.java

        boolean isComplete = true;
        List<Entry<M, Object>> entries = new ArrayList<>();
        List<ITableColumnDescriptor> columnDescriptor = null;
+        boolean collapseChildren = false;


This would collapse the children of the root. What about have a expandLevel parameter instead, that indicates to which level the tree should be expanded? If expandLevel is missing or has value of -1 it would mean that all the levels are expanded (as it is the current behaviour). If the expandLevel is set to 1 for example, it will expand to the first nodes under the root. WDYT?

bhufmann

Thanks for the contribution. I have some comments. Please add a test case to TmfTreeModelTest (see method testTmfTreeModelConstructor2.

bhufmann · 2025-06-05T13:03:47Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+     * would mean that all the levels are expanded (default behaviour). If the expandLevel is set to 1 for
+     * example, it will expand to the first nodes under the root.
+     */
+    private int fExpandLevel = -1;


There should be a constant available for -1 and used in the both classes.

Add this to this class:

/** * Expand level to indicate that all tree levels are expanded. (default) * @since 9.6 */ public static final int ALL_LEVELS = -1;

Also, rename variable to fAutoExpandLevel

bhufmann · 2025-06-05T13:20:31Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+     * Indicates which level of the tree should be expanded. If expandLevel is missing or has value of -1 it
+     * would mean that all the levels are expanded (default behaviour). If the expandLevel is set to 1 for
+     * example, it will expand to the first nodes under the root.
+     */


Change the comment to:

/** * Indicates which level of the tree should be expanded. */

The more detail information

bhufmann · 2025-06-05T13:21:40Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    /**
+     * @return
+     */
+    public int getExpandLevel() {


rename getAutoExpandLevel

bhufmann · 2025-06-05T13:21:58Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    /**
+     * @param expandLevel
+     */
+    public void setExpandLevel(int expandLevel) {


rename setAutoExpandLevel

bhufmann · 2025-06-05T13:24:19Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    }
+
+    /**
+     * @param expandLevel


change java doc

/** * Sets the auto-expand level to be used for the input of the tree. The * value 0 means that there is no auto-expand; 1 means that top-level * elements are expanded, but not their children; 2 means that top-level * elements are expanded, and their children, but not grand-children; and so * on. * <p> * The value {@link #ALL_LEVELS} means that all subtrees should be expanded. * </p> * @since 9.6 */

bhufmann · 2025-06-05T13:25:36Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

    }

+    /**
+     * @return


change java doc

/** * Returns the auto-expand level. * * @return non-negative level, or <code>ALL_LEVELS</code> if all levels of * the tree are expanded automatically * @see #setAutoExpandLevel * @since 9.6

bhufmann · 2025-06-05T13:26:18Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

        private List<ITableColumnDescriptor> fColumnDescriptors = new ArrayList<>();
        private List<T> fEntries;
        private @Nullable String fScope;
+        private int fExpandLevel = -1;


Use constant

bhufmann · 2025-06-05T13:26:38Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+         *
+         * @param expandLevel
+         *            expand level of the tree model
+         * @return this {@link Builder} object


add @since 9.6

bhufmann · 2025-06-05T13:26:58Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+         *            expand level of the tree model
+         * @return this {@link Builder} object
+         */
+        public Builder<T> setExpandLevel(int expandLevel) {


rename to setAutoExpandLevel

bhufmann · 2025-06-05T13:27:36Z

....tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeCompositeDataProvider.java

        boolean isComplete = true;
        List<Entry<M, Object>> entries = new ArrayList<>();
        List<ITableColumnDescriptor> columnDescriptor = null;
+        int expandLevel = -1;


use constant ALL_LEVEL (see comment below for TmfTreeModel)

bhufmann · 2025-06-09T17:00:45Z

I'm going to update this PR with my suggestions to help with this contribution.

bhufmann

In noticed that the PR is based on an old commit and not on the latest in master. I'll rebase and squash the commits after approval. Since I'm continuing with this PR I'll force push the updated version then.

bhufmann · 2025-06-09T17:46:02Z

....tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeCompositeDataProvider.java

        boolean isComplete = true;
        List<Entry<M, Object>> entries = new ArrayList<>();
        List<ITableColumnDescriptor> columnDescriptor = null;
+        int expandLevel = -1;


bhufmann · 2025-06-09T17:46:10Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+     * Indicates which level of the tree should be expanded. If expandLevel is missing or has value of -1 it
+     * would mean that all the levels are expanded (default behaviour). If the expandLevel is set to 1 for
+     * example, it will expand to the first nodes under the root.
+     */


bhufmann · 2025-06-09T17:46:18Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+     * would mean that all the levels are expanded (default behaviour). If the expandLevel is set to 1 for
+     * example, it will expand to the first nodes under the root.
+     */
+    private int fExpandLevel = -1;


bhufmann · 2025-06-09T17:46:26Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

    }

+    /**
+     * @return


bhufmann · 2025-06-09T17:46:34Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    /**
+     * @return
+     */
+    public int getExpandLevel() {


bhufmann · 2025-06-09T17:46:43Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    }
+
+    /**
+     * @param expandLevel


bhufmann · 2025-06-09T17:46:48Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+    /**
+     * @param expandLevel
+     */
+    public void setExpandLevel(int expandLevel) {


bhufmann · 2025-06-09T17:46:54Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

        private List<ITableColumnDescriptor> fColumnDescriptors = new ArrayList<>();
        private List<T> fEntries;
        private @Nullable String fScope;
+        private int fExpandLevel = -1;


bhufmann · 2025-06-09T17:47:02Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+         *
+         * @param expandLevel
+         *            expand level of the tree model
+         * @return this {@link Builder} object


bhufmann · 2025-06-09T17:47:07Z

...pse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

+         *            expand level of the tree model
+         * @return this {@link Builder} object
+         */
+        public Builder<T> setExpandLevel(int expandLevel) {


Signed-off-by: Bernd Hufmann <[email protected]>

The auto-expand level is supposed to be used for the input of the tree. The value 0 means that there is no auto-expand; 1 means that top-level elements are expanded, but not their children; 2 means that top-level elements are expanded, and their children, but not grand-children; and so on. The value -1 means that all subtrees should be expanded (default). [Added] Add auto-expand level in TmfTreeModel Signed-off-by: Hriday Panchasara [email protected] Signed-off-by: Bernd Hufmann <[email protected]>

bhufmann reviewed Jun 3, 2025

View reviewed changes

bhufmann self-assigned this Jun 5, 2025

bhufmann requested changes Jun 5, 2025

View reviewed changes

bhufmann reviewed Jun 9, 2025

View reviewed changes

PatrickTasse previously approved these changes Jun 9, 2025

View reviewed changes

bhufmann and others added 2 commits June 9, 2025 15:32

tmf.test: Remove redundant null annotations

550c801

Signed-off-by: Bernd Hufmann <[email protected]>

bhufmann dismissed PatrickTasse’s stale review via 9f48c7b June 9, 2025 20:31

bhufmann force-pushed the collpase-entry-tree branch from 03300f2 to 9f48c7b Compare June 9, 2025 20:31

PatrickTasse approved these changes Jun 9, 2025

View reviewed changes

bhufmann approved these changes Jun 10, 2025

View reviewed changes

bhufmann merged commit 837c7da into eclipse-tracecompass:master Jun 10, 2025
4 checks passed

williamsyang-work mentioned this pull request Jun 11, 2025

Add autoExpandLevel flag to EntryModel eclipse-cdt-cloud/tsp-typescript-client#130

Merged

Add entry-tree parameter to collapse children #277

Add entry-tree parameter to collapse children #277

Uh oh!

Conversation

hriday-panchasara commented Jun 3, 2025 • edited by bhufmann Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What it does

How to test

Follow-ups

Review checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhufmann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhufmann Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhufmann commented Jun 9, 2025

Uh oh!

bhufmann left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hriday-panchasara commented Jun 3, 2025 •

edited by bhufmann

Loading

bhufmann Jun 5, 2025 •

edited

Loading

bhufmann left a comment •

edited

Loading