8361366: Allow sorting of member details in lexicographical order

[nizarbenalla]

Please review this patch to add a toggle to order the member details in the table of contents in lexical order. The selected choice is stored and preserved.

Here is a preview of the new toggle.

Toggle.mov

---

Progress

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

Issue

• JDK-8361366: Allow sorting of member details in lexicographical order (Enhancement - P4)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26322

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26322.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back nbenalla! 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]

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

[openjdk]

@nizarbenalla The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (3d315fcd)
• 00: Full (82c6fee3)

[hns]

This looks good, but there's some room for improvement.

My biggest gripe is that it only reorders the members in the table of contents, but not the member details in the page. Thus, when scrolling through the page, the selection in the TOC jumps around randomly. The idea of the scroll-following TOC is that it mirrors the order of page contents, so both TOC and page contents should be reordered IMO.

I think the icon is not very good at hinting at its function. Some variant of A-Z sort icon might work better. There should probably be a different icon for non-lexicographic source order, but I'm not sure what that should be. I can help with creating the icons.

Is there a reason for putting the functionality in a new JavaScript file? I agree script.js is a bit overloaded and unorderly, but I would prefer cleaning up that existing file instead of adding a new one.

[hns]

both TOC and page contents should be reordered IMO

Thinking about it some more, I think it should be enough to reorder member details in the main section, and then rebuild the TOC to let it do its thing.