From aa1f12422455fd3f2d2cde52e985ef1bf5e3abe5 Mon Sep 17 00:00:00 2001 From: Eclipse Scout Technical User <69901525+EclipseScoutTechUser@users.noreply.github.com> Date: Mon, 12 Feb 2024 18:38:16 +0100 Subject: [PATCH] Update Scout antora docs --- .../24.1/migration/migration-guide.html | 125 +++++++++++++++--- .../24.1/releasenotes/release-notes.html | 17 ++- search-index.js | 2 +- 3 files changed, 124 insertions(+), 20 deletions(-) diff --git a/scout-docs/24.1/migration/migration-guide.html b/scout-docs/24.1/migration/migration-guide.html index 7520deea..52046d81 100644 --- a/scout-docs/24.1/migration/migration-guide.html +++ b/scout-docs/24.1/migration/migration-guide.html @@ -509,7 +509,7 @@

HTTP/2 Suppor
-

Build changes

+

Build Changes

    @@ -556,7 +556,7 @@

    javax to jakarta.

-

Migration guide

+

Migration Guide

  • @@ -587,7 +587,7 @@

    Migration

-
JAX-WS services
+
JAX-WS Services

After the upgrade to 24.1, projects that use JAX-WS (Soap) as a provider should check the connection both on DEV and on the deployed system to ensure that everything is working as desired. @@ -624,16 +624,16 @@

JAX-WS se
-
UI Server: Multipart request configuration
+
UI Server: Multipart Request Configuration

As part of the switch to Jakarta EE the third party library dependency to Apache File Upload was eliminated. Scout now relies on plain Jakarta EE API to process HTTP multipart requests. Servlets processing multipart requests using Jakarta EE API requires a multipart-config in their servlet registration.

-
Deployment using web.xml
+
Deployment Using web.xml
-

If you use a web.xml-based deployment (legacy only, see Removal of .war modules), make sure to add a <multipart-config> section to your web.xml where the UiServlet is registered:

+

If you use a web.xml-based deployment (legacy only, see Removal of .war Modules), make sure to add a <multipart-config> section to your web.xml where the UiServlet is registered:

Listing 2. Example multipart-config in web.xml of Scout UI server
@@ -670,7 +670,7 @@
Deployment using Jetty server
-

If you switch to a Jetty-based deployment (see chapter Former JettyServer for development can be used in a productive environment for details) a default multipart configuration providing the ability +

If you switch to a Jetty-based deployment (see chapter Former JettyServer for Development Can Be Used in a Productive Environment for details) a default multipart configuration providing the ability to upload multipart requests with unlimited size is used by default (see chapter UIServlet). This corresponds to the same behavior as using the former Apache File Upload based implementation.

@@ -688,7 +688,7 @@
-

Other libraries

+

Other Libraries

  • @@ -712,7 +712,7 @@

    -

    Former JettyServer for development can be used in a productive environment

    +

    Former JettyServer for Development Can Be Used in a Productive Environment

    org.eclipse.scout.dev.jetty.JettyServer was so far only used for development environments. @@ -720,7 +720,7 @@

    Former Je The Scout Application class contains a main-method which may be started directly and itself starts an embedded Jetty server.

    -

    The support for using a web.xml was dropped when using the Scout Application, IServletContributor and IServletFilterContributer are used instead (see web.xml and Removal of .war modules).

    +

    The support for using a web.xml was dropped when using the Scout Application, IServletContributor and IServletFilterContributer are used instead (see web.xml and Removal of .war Modules).

    The following renaming/refactoring is applied.

    @@ -1111,7 +1111,7 @@

    -

    Removal of .war modules

    +

    Removal of .war Modules

    The build of a .war file to be used within an application server (e.g. Tomcat) is deprecated now and might not work anymore in a further release (due to dependencies issues). Thus, it’s highly recommended to either use shell scripts to run your productive environment as a service or built docker images to be used in Kubernetes or a similar setup. @@ -1272,7 +1272,7 @@

    -

    WebappEventListener is still available and might be used for legacy applications running within an application server (see Removal of .war modules), +

    WebappEventListener is still available and might be used for legacy applications running within an application server (see Removal of .war Modules), but it is marked as deprecated and might be removed in a future release.

    @@ -1283,7 +1283,7 @@

    -

    ServletContext not accessible via BEANS.get/.opt anymore

    +

    ServletContext Not Accessible via BEANS.get/.opt Anymore

    ServletContext could be accessed via BEANS.get/.opt so far because it was registered via WebappEventListener. It was only used within ServletContextMimeTypeDetector to ask the servlet context for its mime type mapping. @@ -1324,7 +1324,7 @@

    -

    Add streaming support to hashing (SecurityUtility)

    +

    Add Streaming Support to Hashing (SecurityUtility)

    org.eclipse.scout.rt.platform.security.SecurityUtility supports streaming:

    @@ -1352,7 +1352,7 @@

    -

    IdExternalFormatter removed

    +

    IdExternalFormatter Removed

    The former deprecated class IdExternalFormatter was removed. @@ -1400,7 +1400,7 @@

    -

    Login form: Add support for second-factor (form-based)

    +

    Login Form: Add Support for Second-Factor (Form-Based)

    For the FormBasedAccessController and the corresponding login box a basic second-factor support was added; a new credential verifier return value org.eclipse.scout.rt.platform.security.ICredentialVerifier.AUTH_2FA_REQUIRED was added which will prompt for a second factor token. To verify this token a second-factor verifier ICredentialVerifier needs to be registered.

    @@ -1471,6 +1471,99 @@

    +

    Tree: Improved Auto-Check Behavior When Checking Nodes

    +
    +
    +

    New Behavior Explained

    +
    +

    When the autoCheckChildren property of the Tree or TreeBox widget is set to true (e.g. by overriding +getConfiguredAutoCheckChildNodes()) the automatic check behavior has changed.

    +
    +
    +

    Assuming the following tree structure is given:

    +
    +
    +
    +
    [ ] Node A
+  [ ] Child node 1
+  [ ] Child node 2
+
+
+Legend:
+[ ] -> Node unchecked
+[-] -> Node partly-checked
+[*] -> Node checked
    +
    +
    +
    +

    Example 1

    +
    +

    When checking or unchecking 'Node A' all its children are checked/unchecked too.

    +
    +
    +
    +
    [*] Node A
+  [*] Child node 1    <- Automatically checked
+  [*] Child node 2    <- Automatically checked
    +
    +
    +
    +
    +

    Example 2

    +
    +

    When some of the child nodes are checked, the parent nodes get partly-checked.

    +
    +
    +
    +
    [-] Node A            <- Partly checked
+  [*] Child node 1
+  [ ] Child node 2
    +
    +
    +
    +

    When 'Child Node 2' gets checked too, the parent node is checked automatically. +Attention: The mechanism of auto-checking the parent is new. It may break the logic in your application.

    +
    +
    +
    +
    [*] Node A            <- Automatically checked
+  [*] Child node 1
+  [*] Child node 2
    +
    +
    +
    +
    +
    +

    API Changes in AbstractTree

    +
    +

    execAutoCheckChildNodes

    +
    +

    Before this change, the auto-check logic was implemented in Java and JavaScript. The +org.eclipse.scout.rt.client.ui.basic.tree.AbstractTree#execAutoCheckChildNodes method implemented the logic +on Java side. This method was removed. The complete auto-check logic is now only on JavaScript side.

    +
    +
    +
    +

    Checking All Nodes

    +
    +

    To check all nodes of a tree in java, it was possible to check the root node while autoCheckChildren was true. +This is no longer supported. The new best practice is to use the +org.eclipse.scout.rt.client.ui.basic.tree.AbstractTree#checkAllNodes method.

    +
    +
    +
    +
    // No longer supported
+tree.setNodeChecked(tree.getRootNode(), true);
+
+// Use this
+tree.checkAllNodes();
    +
    +
    +
    +
    +
    +

    diff --git a/scout-docs/24.1/releasenotes/release-notes.html b/scout-docs/24.1/releasenotes/release-notes.html index bb66bc78..c743ac05 100644 --- a/scout-docs/24.1/releasenotes/release-notes.html +++ b/scout-docs/24.1/releasenotes/release-notes.html @@ -477,7 +477,7 @@

    Accessibility

    -

    Login form: Add support for second-factor (form-based)

    +

    Login Form: Add Support for Second-Factor (Form-Based)

    For the form-based login box a basic second-factor support was added. @@ -486,14 +486,14 @@

    -

    Scout App as embedded Jetty Server to run in a productive environment

    +

    Scout App as Embedded Jetty Server to Run in a Productive Environment

    The former org.eclipse.scout.dev.jetty.JettyServer (now Application) was so far only used for development environments. With this release it was improved so that it can be used in a productive environment too. The Scout Application class (org.eclipse.scout.rt.app.Application) contains a main-method which may be started directly and itself starts an embedded Jetty server. Therefore, an application server isn’t required anymore. -See the migration guide for further information.

    +See the migration guide for further information.

    @@ -507,6 +507,17 @@

    +

    Tree: Improved Auto-Check Behavior When Checking Nodes

    +
    +
    +

    When enabling AutoCheckChildNodes for a Tree or TreeBox widget, the behavior of automatic node checking has changed. +The new behavior improves the consistence and represents better the real world requirements. For more details, consider +reading the corresponding chapter in the +migration guide.

    +
    +
    +