Skip to content

Commit 03329df

Browse files
committed
docs: document sharing and retention of display components
A component shows the value of one timer at a time, and the timer keeps a reference to it until the display is removed.
1 parent ab17c74 commit 03329df

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎src/main/java/com/flowingcode/vaadin/addons/simpletimer/SimpleTimer.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,10 @@ public DetachPolicy getDetachPolicy() {
359359
* moved in and out of view, for instance inside tabs, attach the timer somewhere it stays
360360
* attached and add only the display to the tab.
361361
*
362+
* <p>A component shows the value of one timer at a time: if it is added as a display to two
363+
* timers, they overwrite each other's value. The timer keeps a reference to the component until
364+
* the display is removed with the returned handle.
365+
*
362366
* @param display the component in which to show the value
363367
* @return a handle that can be used for removing the display
364368
*/

0 commit comments

Comments
 (0)