Table: add TableOrganizer and ShowInvisibleColumnsForm for Scout JS #980

bschwarzent · 2024-04-12T15:07:48Z

No description provided.

- Use scout.assertParameter() instead of custom Error - Use 'page' as parameter name instead of 'node' - Adjust return type from 'Form | Table' to 'OutlineContent' - Extract method

- Table/Tree implements Filterable - TableRow/TreeNode implements FilterElement - LazyNodeFilter implements Filter

- dates.formatTimestamp(): format a date in a fixed timestamp format - numbers.randomInt(): generate a random integer

The initial location has no explicit route, but this is not an error. Because the URL is not only used for routing (e.g. we can have query params), we cannot reliably determine when to emit a warning. To avoid unnecessary log entries, the log level of the warning was reduced to info.

objects.checkFunctionOverrides() was used in the pre-ES6 era to check in the F12 developer console if the signature of "overwritten" methods in the prototype chain matches. This utility no longer works correctly and is no longer needed (we now rely on ES6/TS classes and IDE support).

- When a tree node is selected, ensureExpansionVisible() is called to make sure the expanded children of this node are within the viewport. - This method should only consider nodes that are actually visible, i.e. not filtered (e.g. by lazy expansion). - If a node has no children, at least the node itself should be scrolled inside the viewport. - Because the outline tree has no horizontal scrollbar, no scrolling should be performed in that direction (even when the tree nodes are pushed out of the visible area). 336993

The TableHeaderMenu consults the table whether a column can be added, removed or modified. In the case of Scout Classic, this depends on some static properties computed by the UI server (e.g. "columnAddable"). In Scout JS, these properties are now ignored. Instead, the decision is delegated to a TableOrganizer instance, which is created for every table. The organizer handles the 'columnOrganizeAction' menu which is triggered by the buttons in the table header menu. The basic implementation can change the 'visible' flag of existing columns. In the future, it will be possible to create new columns via a separate TableCustomizer (not yet implemented). 369108

mvilliger · 2024-04-23T09:53:00Z

...main/java/org/eclipse/scout/rt/client/ui/basic/table/organizer/ShowInvisibleColumnsForm.java

@@ -100,7 +89,7 @@ protected int getConfiguredGridColumnCount() {
    @Override
    protected void execInitField() {
      super.execInitField();
-      setStatusVisible(false);
+      //setStatusVisible(false);


Is this no longer required? Then remove the line? Otherwise remove comment?

mvilliger · 2024-04-23T10:03:05Z

eclipse-scout-core/src/table/TableModel.ts

@@ -268,4 +268,5 @@ export interface TableModel extends WidgetModel {
   */
  textFilterEnabled?: boolean;
  defaultMenuTypes?: string[];
+  tableOrganizer?: ObjectOrModel<TableOrganizer>;


if a tableOrganizer model is passed as part of this TableModel, is it actually used when creating the instance?
Either it should have an effect or here only a TableOrganizier can be passed and no model?

mvilliger · 2024-04-23T11:45:03Z

eclipse-scout-core/src/table/TableAdapter.ts

+    objects.replacePrototypeFunction(Table, '_createTableOrganizer', function(this: Table & { _createTableOrganizerOrig }) {
+      if (this.modelAdapter) {
+        // nop in classic mode
+        return;


maybe return null here instead of undefined? But actually makes no difference

mvilliger · 2024-04-23T11:52:03Z

eclipse-scout-core/src/table/ShowInvisibleColumnsFormModel.ts

+              columns: [
+                {
+                  id: 'KeyColumn',
+                  objectType: Column,


Specify the generic here (Column)? WidgetMap can handle generics now.

mvilliger · 2024-04-23T11:53:14Z

eclipse-scout-core/src/table/ShowInvisibleColumnsForm.ts

+    this.insertAfterColumn = null;
+  }
+
+  protected override _jsonModel(): WidgetModel {


return type could be a FormModel

mvilliger · 2024-04-23T12:15:54Z

eclipse-scout-core/src/table/ShowInvisibleColumnsForm.ts

+    if (this.table.tableOrganizer) {
+      return this.table.tableOrganizer.getAddableColumns(this.insertAfterColumn);
+    }
+    return this.table.displayableColumns()


Can this case actually happen? This Form is only called from the Organizer, right? Then it must be present? Or not?

The table organizer is null in classic mode (method _createTableOrganizer is replaced in TableAdapter)

mvilliger · 2024-04-23T12:17:38Z

eclipse-scout-core/src/table/ShowInvisibleColumnsForm.ts

+    this.widget('ColumnsTable').insertRows(rows);
+  }
+
+  protected _getAddableColumns(): Column[] {


The list of available columns is computed by the tableOrganizer. Maybe instead of get them here, the organizer could pass it in the model for this form when creating it?

mvilliger · 2024-04-23T12:22:15Z

eclipse-scout-core/src/table/ShowInvisibleColumnsForm.ts

+      return {
+        cells: [
+          scout.create(Cell, {value: column}),
+          this._getColumnTitle(column)


In Scout Classic if the tooltip is used as column title, it is displayed using italic font. Do we want this here as well? Or not?

mvilliger · 2024-04-23T12:30:01Z

eclipse-scout-core/src/table/TableOrganizer.ts

+   * Returns true if the given column can be modified.
+   */
+  isColumnModifiable(column: Column): boolean {
+    if (this.table.isCustomizable()) {


directly return this.table.isCustomizable()

mvilliger · 2024-04-23T12:33:18Z

eclipse-scout-core/src/table/TableOrganizer.ts

+  protected _removeColumn(column: Column) {
+    column.setVisible(false);
+
+    // TODO bsh [js-table] Should we keep the sorting? In Java, it stays intact (only visible in the organize menu).


maybe keep it the same as in java? Or is this expected by the user if a column is removed that the rows change in order?

mvilliger · 2024-04-23T13:00:30Z

Table grouping seems not to work correctly. E.g. when grouping by column A and removing column B, the whole grouping seems to be removed. This seems not to be correct?
Furthermore if grouping for multiple columns is configured and one of these is removed, the whole grouping is removed as well?

mvilliger · 2024-04-24T06:52:00Z

Another issue:

Add an aggregation for a number column (e.g. avg).
Remove this number column -> the aggregation row is removed correctly
Add the aggregation column again -> aggregation row is not shown, but if the column header is clicked it still shows as active

bschwarzent self-assigned this Apr 12, 2024

bschwarzent force-pushed the features/bschwarzent/24.2/369108_show_invisible_columns_1 branch from 9916294 to 4283ad2 Compare April 18, 2024 14:31

bschwarzent added 8 commits April 19, 2024 17:48

DesktopBench: cleanup code

4ef1b0f

- Use scout.assertParameter() instead of custom Error - Use 'page' as parameter name instead of 'node' - Adjust return type from 'Form | Table' to 'OutlineContent' - Extract method

NavigateButton: add jsdoc

7889804

Add TS interfaces to improve IDE support

08bf484

- Table/Tree implements Filterable - TableRow/TreeNode implements FilterElement - LazyNodeFilter implements Filter

Add utility functions

e7c47c4

- dates.formatTimestamp(): format a date in a fixed timestamp format - numbers.randomInt(): generate a random integer

bschwarzent force-pushed the features/bschwarzent/24.2/369108_show_invisible_columns_1 branch from 4283ad2 to 5897e34 Compare April 19, 2024 15:52

bschwarzent requested a review from mvilliger April 19, 2024 16:47

mvilliger reviewed Apr 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Table: add TableOrganizer and ShowInvisibleColumnsForm for Scout JS #980

Table: add TableOrganizer and ShowInvisibleColumnsForm for Scout JS #980

bschwarzent commented Apr 12, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

bschwarzent Apr 30, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger Apr 23, 2024

mvilliger commented Apr 23, 2024 •

edited

mvilliger commented Apr 24, 2024

Table: add TableOrganizer and ShowInvisibleColumnsForm for Scout JS #980

Are you sure you want to change the base?

Table: add TableOrganizer and ShowInvisibleColumnsForm for Scout JS #980

Conversation

bschwarzent commented Apr 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mvilliger commented Apr 23, 2024 • edited

mvilliger commented Apr 24, 2024

mvilliger commented Apr 23, 2024 •

edited