Re: RFR: 8267858: Document that title property in WebEngine gets updated asynchronously

2021-06-04 Thread Johan Vos
On Thu, 27 May 2021 17:25:27 GMT, Arun Joseph  wrote:

> The title property is not guaranteed to be updated right after the page is 
> loaded, but gets updated asynchronously.

Marked as reviewed by jvos (Reviewer).

-

PR: https://git.openjdk.java.net/jfx/pull/522


Re: RFR: 8267858: Document that title property in WebEngine gets updated asynchronously

2021-06-04 Thread Kevin Rushforth
On Thu, 27 May 2021 17:25:27 GMT, Arun Joseph  wrote:

> The title property is not guaranteed to be updated right after the page is 
> loaded, but gets updated asynchronously.

Looks good.

-

Marked as reviewed by kcr (Lead).

PR: https://git.openjdk.java.net/jfx/pull/522


Re: RFR: 8267858: Document that title property in WebEngine gets updated asynchronously

2021-06-04 Thread Arun Joseph
On Thu, 3 Jun 2021 23:53:48 GMT, Kevin Rushforth  wrote:

>> modules/javafx.web/src/main/java/javafx/scene/web/WebEngine.java line 441:
>> 
>>> 439: 
>>> 440: /*
>>> 441:  * The page title. This gets updated asynchronously.
>> 
>> Is there any more information or guarantee when the update is expected to be 
>> complete, or is it truly asynchronous? I we know that this will happen 
>> between the current pulse and the next one, that might be helpful to 
>> developers (although I agree waiting for the titleProperty to be changed is 
>> the better approach).
>> If there is no link beween the webkit thread that gets the title and the 
>> quantum renderer, it is really asynchronous and in that case tricks like 
>> waiting for a few pulses won't help either -- but it would be good to 
>> mention that so that developers don't create workarounds that might work in 
>> some cases and fail in others.
>
> I had exactly the same thought about the need to document it more clearly. 
> Maybe something like:
> 
> "This property will be updated asynchronously some time after the page is 
> loaded. Applications should not rely on any particular timing, but should 
> listen for changes to this property, or bind to it, to know when it has been 
> updated."
> 
> Btw, you modified an ordinary comment, not a javadoc comment. The newly added 
> sentence needs to go on the javadoc comment, which is on the `titleProperty` 
> method a few lines down from here. Be sure to run `gradle javadoc` and look 
> at the generated docs.

I've modified the right javadoc comment now.

-

PR: https://git.openjdk.java.net/jfx/pull/522


Re: RFR: 8267858: Document that title property in WebEngine gets updated asynchronously

2021-06-04 Thread Johan Vos
On Thu, 27 May 2021 17:25:27 GMT, Arun Joseph  wrote:

> The title property is not guaranteed to be updated right after the page is 
> loaded, but gets updated asynchronously.

modules/javafx.web/src/main/java/javafx/scene/web/WebEngine.java line 441:

> 439: 
> 440: /*
> 441:  * The page title. This gets updated asynchronously.

Is there any more information or guarantee when the update is expected to be 
complete, or is it truly asynchronous? I we know that this will happen between 
the current pulse and the next one, that might be helpful to developers 
(although I agree waiting for the titleProperty to be changed is the better 
approach).
If there is no link beween the webkit thread that gets the title and the 
quantum renderer, it is really asynchronous and in that case tricks like 
waiting for a few pulses won't help either -- but it would be good to mention 
that so that developers don't create workarounds that might work in some cases 
and fail in others.

-

PR: https://git.openjdk.java.net/jfx/pull/522


RFR: 8267858: Document that title property in WebEngine gets updated asynchronously

2021-06-04 Thread Arun Joseph
The title property is not guaranteed to be updated right after the page is 
loaded, but gets updated asynchronously.

-

Commit messages:
 - Fix javadoc comment
 - Merge branch 'master' into 8267858
 - 8267858: Document that title property in WebEngine gets updated 
asynchronously

Changes: https://git.openjdk.java.net/jfx/pull/522/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jfx=522=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8267858
  Stats: 5 lines in 1 file changed: 4 ins; 0 del; 1 mod
  Patch: https://git.openjdk.java.net/jfx/pull/522.diff
  Fetch: git fetch https://git.openjdk.java.net/jfx pull/522/head:pull/522

PR: https://git.openjdk.java.net/jfx/pull/522