8359020: TabObservableList.reorder changes content of filtered list

[Maran23]

Fixes that the TabObservableList creates wrong permutation change events. As they are wrong, listeners that rely on the change events like FilteredList will get confused and do the wrong things.

I was wondering why the TabPaneSkin was not affected, as it installs a listener on the tabs.
Turns out this is because the code path is not triggered when the tabs are reordered by dragging as can be seen here:

jfx/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TabPaneSkin.java

Lines 606 to 609 in 697a534

	while (c.next()) {
	if (c.wasPermutated()) {
	if (dragState != DragState.REORDER) {
	TabPane tabPane = getSkinnable();

So this issue is rather rare and limited to listeners installed by the developer (and interested in permutation events).
Or using a FilteredList with the tabs, which will install such a listener as well.

---

• I confirm that I make this contribution in accordance with the OpenJDK Interim AI Policy.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issue

• JDK-8359020: TabObservableList.reorder changes content of filtered list (Bug - P4)

Reviewers

• Andy Goryachev (@andy-goryachev-oracle - Reviewer)
• Michael Strauß (@mstr2 - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jfx.git pull/2164/head:pull/2164
$ git checkout pull/2164

Update a local copy of the PR:
$ git checkout pull/2164
$ git pull https://git.openjdk.org/jfx.git pull/2164/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 2164

View PR using the GUI difftool:
$ git pr show -t 2164

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/2164.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back mhanl! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@Maran23 This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8359020: TabObservableList.reorder changes content of filtered list

Reviewed-by: angorya, mstrauss

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 11 new commits pushed to the master branch:

• 114e69e: 8379561: Remove UNICODE related code from GLib
• 8d917ae: 8384806: ComboBox converter does not properly update contained null values
• b690b3c: 8382883: JavaFX on Linux crashed after some time when ES2Context.makeCurrent() was called
• ... and 8 more: https://git.openjdk.org/jfx/compare/697a534bf494d82bf8e0ecacfebaba003dcc6c7a...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[openjdk]

The total number of required reviews for this PR has been set to 2 based on the presence of this label: rfr. This can be overridden with the /reviewers command.

[mlbridge]

Webrevs

• 00: Full (7a7bd12a)

[andy-goryachev-oracle]

I feel the code might have been simpler, but it does fix the issue, which is ok with me. The new test fails in master and passes with the fix. Also tested with the updated monkey tester
https://github.com/andy-goryachev-oracle/MonkeyTest

(stdout shows the original tab list + filtered one)

[andy-goryachev-oracle]

@Ziad-Mid could you be the second reviewer please?

[Maran23]

/integrate

[openjdk]

Going to push as commit d1bb3e3.
Since your change was applied there have been 12 commits pushed to the master branch:

• 186a3d5: 8195614: FilteredList throws ArrayIndexOutOfBoundsException if created with 1 element
• 114e69e: 8379561: Remove UNICODE related code from GLib
• 8d917ae: 8384806: ComboBox converter does not properly update contained null values
• ... and 9 more: https://git.openjdk.org/jfx/compare/697a534bf494d82bf8e0ecacfebaba003dcc6c7a...master

Your commit was automatically rebased without conflicts.

[openjdk]

@Maran23 Pushed as commit d1bb3e3.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.