Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
mnlipp committed Oct 9, 2023
1 parent aa47ab4 commit 43fafa2
Showing 1 changed file with 20 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
* instance of a given type should be added to the page. The
* {@link AbstractConlet} checks the type requested, and if
* it matches, invokes {@link #generateInstanceId generateInstanceId}
* and{@link #createNewState createNewState}.
* and {@link #createNewState createNewState}.
* If the conlet has associated state, the information is saved with
* {@link #putInSession putInSession}. Then
* {@link #doRenderConlet doRenderConlet} is invoked, which must
Expand Down Expand Up @@ -153,16 +153,16 @@
* a backing store.
*
* Once state information has been obtained, the method
* invokes as when adding a new conlet by invoking
* continues as when adding a new conlet by invoking
* {@link #doRenderConlet doRenderConlet}.
*
* ## ConletDeleted
*
* ![Web console component deleted handling](ConletDeletedHandling.svg)
*
* When the {@link AbstractConlet} receives a {@link ConletDeleted},
* it updates the information about the shown conlet views. If the
* conlet is no longer used in the browser (no views remain),
* When the {@link AbstractConlet} receives a {@link ConletDeleted}
* event, it updates the information about the shown conlet views. If
* the conlet is no longer used in the browser (no views remain),
* it deletes the state information from the session. In any case, it
* invokes {@link #doConletDeleted doConletDeleted} with the
* state information.
Expand All @@ -174,21 +174,21 @@
* If the web console component views include input elements, actions
* on these elements may result in {@link NotifyConletModel} events from
* the web console page to the web console. When the {@link AbstractConlet}
* receives such events, it retrieves any existing state information.
* It then invokes {@link #doUpdateConletState doUpdateConletState} with the
* retrieved information. The web console component usually responds with
* a {@link NotifyConletView} event. However, it can also
* re-render the complete conlet view.
* receives such events, it retrieves any existing state information.
* It then invokes {@link #doUpdateConletState doUpdateConletState}
* with the retrieved information. The web console component usually
* responds with a {@link NotifyConletView} event. However, it can
* also re-render the complete conlet view.
*
* Support for unsolicited updates
* -------------------------------
*
* The class tracks the relationship between the known
* {@link ConsoleConnection}s and the web console components displayed
* in the console pages. The information is available from
* {@link #conletInfosByConsoleConnection}. It can e.g. be used to send
* events to the web console(s) in response to an event on the server
* side.
* {@link #conletInfosByConsoleConnection conletInfosByConsoleConnection}.
* It can e.g. be used to send events to the web console(s) in response
* to an event on the server side.
*
* @param <S> the type of the conlet's state information
*
Expand Down Expand Up @@ -636,13 +636,13 @@ protected Optional<S> createNewState(
}

/**
* Called by {@link #onRenderConletRequest} when a previously
* created conlet (with associated state) is rendered in a new
* browser session for the first time. The default implementation
* simply invokes {@link #createStateRepresentation} and returns
* its result. Conlets with long-term state should retrieve
* their state from some storage. If state is returned, it is
* put in the browser session by the invoker.
* Called when a previously created conlet (with associated state)
* is rendered in a new browser session for the first time. The
* default implementation simply invokes
* {@link #createStateRepresentation createStateRepresentation}
* and returns its result. Conlets with long-term state should
* retrieve their state from some storage. If state is returned,
* it is put in the browser session by the invoker.
*
* @param event the event
* @param connection the console connection
Expand Down

0 comments on commit 43fafa2

Please sign in to comment.