JFX25+: class org.fxmisc.richtext.TextFlowExt overrides final method javafx.scene.text.TextFlow.getUnderlineShape(II)[Ljavafx/scene/shape/PathElement;

[credmond]

Hi -- as per title, it seems TextFlow introduced a new method with a signature clash of a method in TextFlowExt.

openjdk/jfx@04c5e40

Both these may need a rename:

getUnderlineShape(int from, int to)
getCaretShape(int charIdx, boolean isLeading)

So as of now RichTextFX cannot be used with JFX25+ ....

[Symeon94]

Hello,

I see there is a closed ticket about removing getUnderlineShape: #1283
I'm not aware about the second one (I have not tried myself though).

I'm looking at JavaFX changes and I see this commit replaced the method caretShape by getCaretShape and the method underlineShape by getUnderLineShape clashing with the one in RichTextFX.

    /**
     * ...
     * @deprecated replaced by {@link #getCaretShape(int, boolean)}
     */

    @Deprecated(since="25")
    public PathElement[] caretShape(int charIndex, boolean leading) {

    /**
     * ...
     * @deprecated replaced by {@link #getUnderlineShape(int, int)}
     */
    @Deprecated(since="25")
    public final PathElement[] underlineShape(int start, int end) {

It seems that both methods are package-private in a package-private class. So I would expect nobody exterior to the library would use that name. It should be safe to change it.

[Symeon94]

Some point which is less clear to me, is that they mention to use the other new method but it has a slightly different content. It happens that getCaretShape in RichTextFX only does a call to the original caretShape. I guess at one point we'll have to change that but maybe not for this one (same comment applies to getUnderlineShape).

For getUnderlineShape, the replacement method should be good enough (the one from the previous PR mentionned in my response).

[Symeon94]

Created a proposed fix. We'll have to wait for approval from a maintainer of the library.

[Jugen]

@credmond thanks for raising the issue, and
@Symeon94 thanks for the PR addressing the deprecated methods.

[credmond]

@Jugen: can we release a new version for this fix (or a SNAPSHOT, last one is from May...)

Also, noticed the docs say "For JavaFX 25+ use version 0.11.6 or higher. Previous versions of RichTextFX won't work due to a method clash."... but there is no 0.11.6 yet...

[Jugen]

@credmond A new snapshot has been published.
Java 25 will be released in 3 weeks, if I'm not mistaken, so I'll publish 0.11.6 around then .....

[credmond]

Great, thanks!

[credmond]

@Jugen: no new snapshot has been published, or if it is, it's not anywhere on oss.sonatype.org.

Did something go wrong?

[Jugen]

@credmond Point taken, so I've released v0.11.6 as requested :-)

[credmond]

@credmond Point taken, so I've released v0.11.6 as requested :-)

Thanks Jugen!! I understand it's a tad risky to release too, as the JFX folks could easily change/undo things before official release -- so I see the sense in waiting for an official release too. No perfect answer.... :)

Thanks again!