fix #1088 refactor menu component

Author: vegegoku

domino-ui/src/main/java/org/dominokit/domino/ui/config/MenuConfig.java

@@ -17,19 +17,64 @@
 
 import org.dominokit.domino.ui.menu.SingleSelectionMode;
 
+/**
+ * Configuration contract for menu components in Domino UI.
+ *
+ * <p>This interface centralizes menu-related text and behavior defaults used by menu widgets, such
+ * as labels/messages for search results and the default selection mode. Framework users may provide
+ * their own implementation to customize messages (for localization or branding) and behavior while
+ * leveraging the defaults provided here.
+ *
+ * <p>Note: Some returned strings include basic HTML markup (e.g., <b> tags) intended for rendering
+ * in components that accept HTML content. If you override these methods, ensure the formatting is
+ * appropriate for the target component and sanitized if necessary.
+ *
+ * <p>Extends {@link ZIndexConfig} to inherit z-index related configuration that affects menu popup
+ * layering and stacking context.
+ */
 public interface MenuConfig extends ZIndexConfig {
+  /**
+   * Returns the message displayed when no search results match the provided token.
+   *
+   * @param token the user-entered search token that produced no results
+   * @return a user-facing message, potentially containing simple HTML emphasizing the token
+   */
   default String getNoResultMatchMessage(String token) {
     return "No results matched " + " <b>" + token + "</b>";
   }
 
+  /**
+   * Returns the label prefix used when suggesting the creation of a missing item.
+   *
+   * <p>For example, when the user types a value that doesn't exist, the UI may show a suggestion
+   * like "Create <b>token</b>". This method provides the "Create " part, allowing consistent
+   * localization/branding.
+   *
+   * @return the label prefix for the create-missing-item suggestion
+   */
   default String getMissingItemCreateLabel() {
     return "Create ";
   }
 
+  /**
+   * Returns the full message used when suggesting the creation of a missing item.
+   *
+   * @param token the user-entered value that is missing
+   * @return a suggestion message combining {@link #getMissingItemCreateLabel()} and the token,
+   *     often with simple HTML emphasis
+   */
   default String getMissingItemCreateMessage(String token) {
     return getMissingItemCreateLabel() + " <b>" + token + "</b>";
   }
 
+  /**
+   * Returns the default selection mode for menu components.
+   *
+   * <p>The default is {@link SingleSelectionMode#RESELECT} which allows selecting an already
+   * selected item to trigger its action again.
+   *
+   * @return the default {@link SingleSelectionMode}
+   */
   default SingleSelectionMode getDefaultSelectionMode() {
     return SingleSelectionMode.RESELECT;
   }

domino-ui/src/main/java/org/dominokit/domino/ui/data/DataChangedEvent.java

@@ -0,0 +1,152 @@
+/*
+ * Copyright © 2019 Dominokit
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.dominokit.domino.ui.data;
+
+import java.util.List;
+import java.util.Optional;
+import org.dominokit.domino.ui.datatable.plugins.pagination.SortDirection;
+
+/**
+ * The {@code DataChangedEvent} class represents an event that is triggered when data in a data
+ * store changes, such as when records are loaded or sorted.
+ *
+ * @param <T> The type of data representing the records in the data table.
+ */
+public class DataChangedEvent<T> {
+  private final List<T> newData;
+  private final boolean append;
+  private final int totalCount;
+  private final Optional<SortDirection> sortDir;
+  private final Optional<String> sortColumn;
+
+  /**
+   * Constructs a new {@code DataChangedEvent} with the provided data and total count.
+   *
+   * @param newData The list of new data records.
+   * @param totalCount The total count of records.
+   */
+  public DataChangedEvent(List<T> newData, int totalCount) {
+    this.newData = newData;
+    this.totalCount = totalCount;
+    this.append = false;
+    this.sortDir = Optional.empty();
+    this.sortColumn = Optional.empty();
+  }
+
+  /**
+   * Constructs a new {@code DataChangedEvent} with the provided data, total count, sort direction,
+   * and sort column.
+   *
+   * @param newData The list of new data records.
+   * @param totalCount The total count of records.
+   * @param sortDirection The sorting direction.
+   * @param sortColumn The column used for sorting.
+   */
+  public DataChangedEvent(
+      List<T> newData, int totalCount, SortDirection sortDirection, String sortColumn) {
+    this.newData = newData;
+    this.totalCount = totalCount;
+    this.append = false;
+    this.sortDir = Optional.of(sortDirection);
+    this.sortColumn = Optional.of(sortColumn);
+  }
+
+  /**
+   * Constructs a new {@code DataChangedEvent} with the provided data, append flag, and total count.
+   *
+   * @param newData The list of new data records.
+   * @param append {@code true} if the data is being appended to the existing data; {@code false}
+   *     otherwise.
+   * @param totalCount The total count of records.
+   */
+  public DataChangedEvent(List<T> newData, boolean append, int totalCount) {
+    this.newData = newData;
+    this.append = append;
+    this.totalCount = totalCount;
+    this.sortDir = Optional.empty();
+    this.sortColumn = Optional.empty();
+  }
+
+  /**
+   * Constructs a new {@code DataChangedEvent} with the provided data, append flag, total count,
+   * sort direction, and sort column.
+   *
+   * @param newData The list of new data records.
+   * @param append {@code true} if the data is being appended to the existing data; {@code false}
+   *     otherwise.
+   * @param totalCount The total count of records.
+   * @param sortDirection The sorting direction.
+   * @param sortColumn The column used for sorting.
+   */
+  public DataChangedEvent(
+      List<T> newData,
+      boolean append,
+      int totalCount,
+      SortDirection sortDirection,
+      String sortColumn) {
+    this.newData = newData;
+    this.append = append;
+    this.totalCount = totalCount;
+    this.sortDir = Optional.of(sortDirection);
+    this.sortColumn = Optional.of(sortColumn);
+  }
+
+  /**
+   * Gets the list of new data records.
+   *
+   * @return A list of new data records.
+   */
+  public List<T> getNewData() {
+    return newData;
+  }
+
+  /**
+   * Checks if the data is being appended to the existing data.
+   *
+   * @return {@code true} if the data is being appended; {@code false} otherwise.
+   */
+  public boolean isAppend() {
+    return append;
+  }
+
+  /**
+   * Gets the total count of records.
+   *
+   * @return The total count of records.
+   */
+  public int getTotalCount() {
+    return totalCount;
+  }
+
+  /**
+   * Gets the sorting direction, if available.
+   *
+   * @return An {@code Optional} containing the sorting direction, or empty if not available.
+   */
+  public Optional<SortDirection> getSortDir() {
+    return sortDir;
+  }
+
+  /**
+   * Gets the column used for sorting, if available.
+   *
+   * @return An {@code Optional} containing the sort column, or empty if not available.
+   */
+  public Optional<String> getSortColumn() {
+    return sortColumn;
+  }
+}

domino-ui/src/main/java/org/dominokit/domino/ui/data/DataFilter.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright © 2019 Dominokit
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.dominokit.domino.ui.data;
+
+public interface DataFilter<T> {
+  boolean filter(T item);
+}

domino-ui/src/main/java/org/dominokit/domino/ui/data/DataStore.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright © 2019 Dominokit
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.dominokit.domino.ui.data;
+
+import org.dominokit.domino.ui.utils.DominoEventListener;
+
+/**
+ * The {@code DataStore} interface defines a contract for managing and retrieving data for a data
+ * table.
+ *
+ * @param <T> The type of data representing the records in the data table.
+ */
+public interface DataStore<T> extends DominoEventListener {
+
+  /**
+   * Registers a data change listener to be notified when the data in the store changes.
+   *
+   * @param dataChangeListener The data change listener to register.
+   */
+  void onDataChanged(StoreDataChangeListener<T> dataChangeListener);
+
+  /**
+   * Removes a previously registered data change listener.
+   *
+   * @param dataChangeListener The data change listener to remove.
+   */
+  void removeDataChangeListener(StoreDataChangeListener<T> dataChangeListener);
+
+  /** Loads or refreshes the data in the data store. */
+  void load();
+}

domino-ui/src/main/java/org/dominokit/domino/ui/data/FilterMode.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright © 2019 Dominokit
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.dominokit.domino.ui.data;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public interface FilterMode<T> {
+
+  List<T> apply(Collection<T> data, Collection<? extends DataFilter<? super T>> filters);
+
+  static <T> FilterMode<T> denial() {
+    return (data, filters) -> {
+      if (data == null || data.isEmpty()) return new ArrayList<>();
+      if (filters == null || filters.isEmpty()) return new ArrayList<>(data);
+      List<T> out = new ArrayList<>(data.size());
+      outer:
+      for (T item : data) {
+        for (DataFilter<? super T> f : filters) {
+          if (!f.filter(item)) continue outer;
+        }
+        out.add(item);
+      }
+      return out;
+    };
+  }
+
+  static <T> FilterMode<T> acceptance() {
+    return (data, filters) -> {
+      if (data == null || data.isEmpty()) return new ArrayList<>();
+      if (filters == null || filters.isEmpty()) return new ArrayList<>(data);
+      List<T> out = new ArrayList<>();
+      outer:
+      for (T item : data) {
+        for (DataFilter<? super T> f : filters) {
+          if (f.filter(item)) {
+            out.add(item);
+            continue outer;
+          }
+        }
+      }
+      return out;
+    };
+  }
+
+  /** Ignore filters and accept all items */
+  static <T> FilterMode<T> acceptAll() {
+    return (data, filters) -> new ArrayList<>(data);
+  }
+
+  /** Ignore filters and deny all items */
+  static <T> FilterMode<T> denyAll() {
+    return (data, filters) -> new ArrayList<>();
+  }
+}