Features/pbz/26.1/423389 scout server session module

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ "releases/26.1" ]
+    branches: [ "releases/26.2" ]
   pull_request:
-    branches: [ "releases/26.1" ]
+    branches: [ "releases/26.2" ]
 
 jobs:
   build:

README.md

@@ -8,7 +8,7 @@ This repository contains the source code of the runtime components, the actual f
 
 If you are completely new and wondering what Eclipse Scout is, please visit our [website](https://eclipse.dev/scout/).
 
-To get started with Scout, follow our [Get Started Guide](https://eclipsescout.github.io/scout-docs/26.1/getstarted/getstarted.html).
+To get started with Scout, follow our [Get Started Guide](https://eclipsescout.github.io/scout-docs/26.2/getstarted/getstarted.html).
 
 ## Documentation
 

eclipse-scout-chart/README.md

@@ -3,8 +3,8 @@
 </p>
 
 <p align="center">
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.1-RT-nightly_pipeline%2F"></a>
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.1-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.1-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.1-RT-nightly_pipeline%2F"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/chart" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dm/@eclipse-scout/chart"></a>
   <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank" rel="noopener noreferrer"><img alt="NPM" src="https://img.shields.io/npm/l/@eclipse-scout/chart"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/chart" target="_blank" rel="noopener noreferrer"><img alt="npm (scoped)" src="https://img.shields.io/npm/v/@eclipse-scout/chart"></a>

eclipse-scout-chart/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-scout/chart",
-  "version": "26.1.0-snapshot",
+  "version": "26.2.0-snapshot",
   "description": "Eclipse Scout chart",
   "author": "BSI Business Systems Integration AG",
   "homepage": "https://eclipse.dev/scout/",
@@ -57,7 +57,7 @@
     "version:release": "releng-scripts version:release"
   },
   "devDependencies": {
-    "@eclipse-scout/cli": ">=26.1.0-snapshot <26.1.0",
+    "@eclipse-scout/cli": ">=26.2.0-snapshot <26.2.0",
     "@eclipse-scout/releng": "^26.1.0",
     "jasmine-core": "5.13.0",
     "jasmine-jquery": "2.1.1",
@@ -67,7 +67,7 @@
     "@types/jasmine-jquery": "1.5.37"
   },
   "dependencies": {
-    "@eclipse-scout/core": ">=26.1.0-snapshot <26.1.0",
+    "@eclipse-scout/core": ">=26.2.0-snapshot <26.2.0",
     "jquery": "3.7.1",
     "chart.js": "4.5.1",
     "chartjs-plugin-datalabels": "2.2.0"

eclipse-scout-chart/pom.xml

@@ -16,7 +16,7 @@
   <parent>
     <groupId>org.eclipse.scout.rt</groupId>
     <artifactId>org.eclipse.scout.rt</artifactId>
-    <version>26.1-SNAPSHOT</version>
+    <version>26.2-SNAPSHOT</version>
     <relativePath>../org.eclipse.scout.rt</relativePath>
   </parent>
 

eclipse-scout-cli/README.md

@@ -3,8 +3,8 @@
 </p>
 
 <p align="center">
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/cli" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dm/@eclipse-scout/cli"></a>
   <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank" rel="noopener noreferrer"><img alt="NPM" src="https://img.shields.io/npm/l/@eclipse-scout/cli"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/cli" target="_blank" rel="noopener noreferrer"><img alt="npm (scoped)" src="https://img.shields.io/npm/v/@eclipse-scout/cli"></a>

eclipse-scout-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-scout/cli",
-  "version": "26.1.0-snapshot",
+  "version": "26.2.0-snapshot",
   "description": "CLI for Eclipse Scout",
   "author": "BSI Business Systems Integration AG",
   "homepage": "https://eclipse.dev/scout/",
@@ -53,8 +53,8 @@
     "karma-jasmine": "5.1.0",
     "karma-jasmine-ajax": "0.1.13",
     "@metahub/karma-jasmine-jquery": "4.0.1",
-    "@eclipse-scout/karma-jasmine-scout": ">=26.1.0-snapshot <26.1.0",
-    "@eclipse-scout/tsconfig": ">=26.1.0-snapshot <26.1.0",
+    "@eclipse-scout/karma-jasmine-scout": ">=26.2.0-snapshot <26.2.0",
+    "@eclipse-scout/tsconfig": ">=26.2.0-snapshot <26.2.0",
     "karma-jasmine-html-reporter": "2.1.0",
     "karma-junit-reporter": "2.0.1",
     "karma-webpack": "5.0.1",

eclipse-scout-cli/pom.xml

@@ -16,7 +16,7 @@
   <parent>
     <groupId>org.eclipse.scout.rt</groupId>
     <artifactId>org.eclipse.scout.rt</artifactId>
-    <version>26.1-SNAPSHOT</version>
+    <version>26.2-SNAPSHOT</version>
     <relativePath>../org.eclipse.scout.rt</relativePath>
   </parent>
 

eclipse-scout-core/README.md

@@ -3,8 +3,8 @@
 </p>
 
 <p align="center">
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
-  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.1-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins" src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
+  <a href="https://ci.eclipse.org/scout/job/scout-integration-26.2-RT-nightly_pipeline/" target="_blank" rel="noopener noreferrer"><img alt="Jenkins tests" src="https://img.shields.io/jenkins/tests?jobUrl=https%3A%2F%2Fci.eclipse.org%2Fscout%2Fjob%2Fscout-integration-25.2-RT-nightly_pipeline%2F"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/core" target="_blank" rel="noopener noreferrer"><img alt="npm" src="https://img.shields.io/npm/dm/@eclipse-scout/core"></a>
   <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank" rel="noopener noreferrer"><img alt="NPM" src="https://img.shields.io/npm/l/@eclipse-scout/core"></a>
   <a href="https://www.npmjs.com/package/@eclipse-scout/core" target="_blank" rel="noopener noreferrer"><img alt="npm (scoped)" src="https://img.shields.io/npm/v/@eclipse-scout/core"></a>
@@ -22,7 +22,7 @@ This module contains the web runtime components running in the browser.
 
 If you are completely new and wondering what Eclipse Scout is, please visit our [website](https://eclipse.dev/scout/).
 
-To get started with Scout, follow our [Get Started Guide](https://eclipsescout.github.io/scout-docs/26.1/getstarted/getstarted.html).
+To get started with Scout, follow our [Get Started Guide](https://eclipsescout.github.io/scout-docs/26.2/getstarted/getstarted.html).
 
 ## Documentation
 

eclipse-scout-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-scout/core",
-  "version": "26.1.0-snapshot",
+  "version": "26.2.0-snapshot",
   "description": "Eclipse Scout runtime",
   "author": "BSI Business Systems Integration AG",
   "homepage": "https://eclipse.dev/scout/",
@@ -63,7 +63,7 @@
     "version:release": "releng-scripts version:release"
   },
   "devDependencies": {
-    "@eclipse-scout/cli": ">=26.1.0-snapshot <26.1.0",
+    "@eclipse-scout/cli": ">=26.2.0-snapshot <26.2.0",
     "@eclipse-scout/releng": "^26.1.0",
     "jasmine-core": "5.13.0",
     "jasmine-ajax": "4.0.0",

eclipse-scout-core/pom.xml

@@ -16,7 +16,7 @@
   <parent>
     <groupId>org.eclipse.scout.rt</groupId>
     <artifactId>org.eclipse.scout.rt</artifactId>
-    <version>26.1-SNAPSHOT</version>
+    <version>26.2-SNAPSHOT</version>
     <relativePath>../org.eclipse.scout.rt</relativePath>
   </parent>
 

eclipse-scout-core/src/bookmark/BookmarkDoBuilder.ts

@@ -8,9 +8,8 @@
  * SPDX-License-Identifier: EPL-2.0
  */
 import {
-  arrays, BaseDoEntity, BookmarkDo, BookmarkDoBuilderModel, BookmarkSupport, BookmarkTableRowIdentifierDo, ChartTableControlConfigHelper, Desktop, Form, IBookmarkDefinitionDo, IBookmarkDo, IBookmarkPageDo, IChartTableControlConfigDo,
-  InitModelOf, NodeBookmarkPageDo, objects, ObjectWithType, OutlineBookmarkDefinitionDo, Page, PageBookmarkDefinitionDo, PageWithTable, scout, Session, strings, TableBookmarkPageDo, TableClientUiPreferencesDo, TableUiPreferences,
-  tableUiPreferences
+  arrays, BookmarkDo, BookmarkDoBuilderModel, BookmarkSupport, BookmarkTableRowIdentifierDo, ChartTableControlConfigHelper, Desktop, Form, IBookmarkDefinitionDo, IBookmarkDo, IBookmarkPageDo, IChartTableControlConfigDo, InitModelOf,
+  NodeBookmarkPageDo, ObjectWithType, OutlineBookmarkDefinitionDo, Page, PageBookmarkDefinitionDo, PageWithTable, scout, Session, strings, TableBookmarkPageDo, TableClientUiPreferencesDo, TableUiPreferences, tableUiPreferences
 } from '../index';
 
 export class BookmarkDoBuilder implements ObjectWithType, BookmarkDoBuilderModel {
@@ -36,6 +35,9 @@ export class BookmarkDoBuilder implements ObjectWithType, BookmarkDoBuilderModel
   createTablePreferences: boolean;
   createTableRowSelections: boolean;
 
+  // Map to store texts computed by _tablePageToTableBookmarkPage() for later use in _createBookmarkDescription()
+  protected _searchFilterTexts = new Map<TableBookmarkPageDo, string>();
+
   // --------------------------------------
 
   constructor() {
@@ -163,7 +165,7 @@ export class BookmarkDoBuilder implements ObjectWithType, BookmarkDoBuilderModel
       throw BookmarkDoBuilder.ERROR_MISSING_ROW_BOOKMARK_IDENTIFIER;
     }
 
-    return scout.create(TableBookmarkPageDo, {
+    let bookmarkPage = scout.create(TableBookmarkPageDo, {
       pageParam: page.pageParam,
       displayText: page.getDisplayText(),
       expandedChildRow: expandedChildRowIdentifier,
@@ -173,6 +175,16 @@ export class BookmarkDoBuilder implements ObjectWithType, BookmarkDoBuilderModel
       tablePreferences: tablePreferences,
       chartTableControlConfig: chartTableControlConfig
     });
+
+    // Compute search filter text and put it into a map for later use in _createBookmarkDescription()
+    if (this.createDescription && searchData) {
+      let searchFilterText = await page.getSearchFilterText();
+      if (searchFilterText) {
+        this._searchFilterTexts.set(bookmarkPage, searchFilterText);
+      }
+    }
+
+    return bookmarkPage;
   }
 
   protected _createExpandedTableRowIdentifier(page: PageWithTable, childPage: Page): BookmarkTableRowIdentifierDo {
@@ -275,18 +287,19 @@ export class BookmarkDoBuilder implements ObjectWithType, BookmarkDoBuilderModel
 
     let lines = [];
     pagePath.forEach((bookmarkPage, index) => {
-      let prefix = strings.repeat('  ', index);
+      let indent = '  ';
+      let prefix = strings.repeat(indent, index);
 
       let displayText = bookmarkPage.displayText || this.session.text('Node');
       lines.push(prefix + displayText);
 
-      if (bookmarkPage instanceof TableBookmarkPageDo && bookmarkPage.searchData) {
-        let searchData = bookmarkPage.searchData instanceof BaseDoEntity ? bookmarkPage.searchData.toPojo() : bookmarkPage.searchData;
-        Object.keys(searchData)
-          .filter(key => !strings.startsWith(key, '_'))
-          .filter(key => !objects.isNullOrUndefinedOrEmpty(searchData[key]))
-          .map(key => key + ': ' + JSON.stringify((searchData)[key]))
-          .forEach(searchLine => lines.push(prefix + '  ' + searchLine));
+      if (bookmarkPage instanceof TableBookmarkPageDo) {
+        // Get search filter text added by _tablePageToTableBookmarkPage()
+        let searchFilterText = this._searchFilterTexts.get(bookmarkPage);
+        // Split search filter text into lines and add them to the description (with additional indentation)
+        if (searchFilterText) {
+          lines.push(...searchFilterText.split('\n').map(s => prefix + indent + s));
+        }
       }
     });
     return lines.join('\n');

eclipse-scout-core/src/form/Form.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2025 BSI Business Systems Integration AG
+ * Copyright (c) 2010, 2026 BSI Business Systems Integration AG
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -8,10 +8,10 @@
  * SPDX-License-Identifier: EPL-2.0
  */
 import {
-  AbortKeyStroke, App, aria, AriaLabelledByInsertPosition, arrays, BusyIndicatorOptions, Button, ButtonSystemType, DialogLayout, DisabledStyle, DisplayParent, DisplayViewId, EnumObject, ErrorHandler, Event, EventHandler, FileChooser,
-  FileChooserController, FocusRule, FormController, FormEventMap, FormGrid, FormInvalidEvent, FormLayout, FormLifecycle, FormModel, FormRevealInvalidFieldEvent, GlassPaneRenderer, GroupBox, HtmlComponent, InitModelOf, KeyStroke,
-  KeyStrokeContext, MessageBox, MessageBoxController, MessageBoxes, NotificationBadgeStatus, ObjectOrChildModel, objects, Point, PopupWindow, PropertyChangeEvent, Rectangle, scout, Status, StatusOrModel, strings, tooltips, TreeVisitResult,
-  ValidationResult, webstorage, Widget, WrappedFormField
+  AbortKeyStroke, App, aria, AriaLabelledByInsertPosition, arrays, BusyIndicatorOptions, Button, ButtonSystemType, ChildModelOf, DialogLayout, DisabledStyle, DisplayParent, DisplayViewId, EnumObject, ErrorHandler, Event, EventHandler,
+  FileChooser, FileChooserController, FocusRule, FormController, FormEventMap, FormGrid, FormInvalidEvent, FormLayout, FormLifecycle, FormModel, FormRevealInvalidFieldEvent, GlassPaneRenderer, GroupBox, HtmlComponent, InitModelOf,
+  KeyStroke, KeyStrokeContext, MessageBox, MessageBoxController, MessageBoxes, ModelOf, NotificationBadgeStatus, ObjectOrChildModel, objects, Point, PopupWindow, PropertyChangeEvent, Rectangle, scout, Status, StatusOrModel, strings,
+  tooltips, TreeVisitResult, ValidationResult, webstorage, Widget, WrappedFormField
 } from '../index';
 import $ from 'jquery';
 
@@ -321,13 +321,40 @@ export class Form extends Widget implements FormModel, DisplayParent {
   }
 
   protected _createLifecycle(): FormLifecycle {
-    return scout.create(FormLifecycle, {
-      widget: this,
+    // already created
+    if (this.lifecycle instanceof FormLifecycle) {
+      return this.lifecycle;
+    }
+
+    const defaultModel: ModelOf<FormLifecycle> = {
       askIfNeedSave: this.askIfNeedSave,
+      askIfNeedSaveText: this.askIfNeedSaveText,
       emptyMandatoryElementsText: this.emptyMandatoryElementsText,
       invalidElementsErrorText: this.invalidElementsErrorText,
-      invalidElementsWarningText: this.invalidElementsWarningText,
-      askIfNeedSaveText: this.askIfNeedSaveText
+      invalidElementsWarningText: this.invalidElementsWarningText
+    };
+
+    // object type
+    if (typeof this.lifecycle === 'string' || typeof this.lifecycle === 'function') {
+      return scout.create(this.lifecycle, {
+        ...defaultModel,
+        widget: this
+      });
+    }
+
+    // child model
+    if (objects.isPojo(this.lifecycle)) {
+      return scout.create({
+        objectType: FormLifecycle,
+        ...defaultModel,
+        ...this.lifecycle as ChildModelOf<FormLifecycle>,
+        widget: this
+      }) as FormLifecycle;
+    }
+
+    return scout.create(FormLifecycle, {
+      ...defaultModel,
+      widget: this
     });
   }
 

eclipse-scout-core/src/form/FormModel.ts

@@ -1,13 +1,13 @@
 /*
- * Copyright (c) 2010, 2024 BSI Business Systems Integration AG
+ * Copyright (c) 2010, 2026 BSI Business Systems Integration AG
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-import {DisplayHint, DisplayParent, DisplayParentModel, DisplayViewId, Form, FormValidator, GroupBox, ObjectOrChildModel, StatusOrModel, Widget, WidgetModel} from '../index';
+import {ChildModelOf, DisplayHint, DisplayParent, DisplayParentModel, DisplayViewId, Form, FormLifecycle, FormValidator, GroupBox, ObjectOrChildModel, ObjectType, StatusOrModel, Widget, WidgetModel} from '../index';
 
 export interface FormModel extends WidgetModel, DisplayParentModel {
   /**
@@ -230,4 +230,8 @@ export interface FormModel extends WidgetModel, DisplayParentModel {
    * By default, the list is empty.
    */
   validators?: FormValidator[];
+  /**
+   * Defines the {@link FormLifecycle} for this form.
+   */
+  lifecycle?: ObjectType<FormLifecycle> | ChildModelOf<FormLifecycle>;
 }

eclipse-scout-core/src/status/NotificationBadgeStatus.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2024 BSI Business Systems Integration AG
+ * Copyright (c) 2010, 2026 BSI Business Systems Integration AG
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -19,19 +19,4 @@ export class NotificationBadgeStatus extends Status {
   override cssClass(): string {
     return strings.join(' ', Status.cssClassForSeverity(this.severity), 'notification-badge');
   }
-
-  /**
-   * @returns {NotificationBadgeStatus} a clone of this Status instance.
-   */
-  override clone(): Status {
-    let modelClone = $.extend({}, this);
-    return new NotificationBadgeStatus(modelClone);
-  }
-
-  override equals(o: any): boolean {
-    if (!(o instanceof NotificationBadgeStatus)) {
-      return false;
-    }
-    return super.equals(o);
-  }
 }