Enhance documentation for UI components

Author: marioserrano09

platform/core/viewers/src/main/java/tools/dynamia/viewers/ViewDescriptorBuilder.java

@@ -7,6 +7,11 @@
 import org.springframework.web.bind.annotation.RestController;
 import tools.dynamia.integration.scheduling.PeriodicTaskExecutor;
 
+/**
+ * REST controller that exposes endpoints for executing periodic tasks defined in the {@link PeriodicTaskExecutor} class. This controller allows you to trigger the execution of morning, midday, afternoon, and evening tasks via HTTP GET requests. Each endpoint corresponds to a specific time of day and will execute the associated tasks when accessed. This can be useful for testing or manually triggering scheduled tasks without waiting for their scheduled execution time.
+ *
+ * @author Mario A. Serrano Leones
+ */
 @RestController
 @RequestMapping("/schedule/execute-tasks")
 @Tag(name = "DynamiaPeriodicTasks")

platform/core/web/src/main/java/tools/dynamia/web/controllers/PeriodicTaskExecutorRestController.java

@@ -5,6 +5,11 @@
 import tools.dynamia.navigation.Page;
 import tools.dynamia.web.navigation.CrudRestNavigationCustomizer;
 
+/**
+ * Default implementation of the {@link CrudRestNavigationCustomizer} interface that provides a basic customization for CRUD REST API endpoints. This implementation simply returns the actual endpoint without any modifications, allowing for a straightforward mapping of CRUD operations to their respective endpoints based on the page's virtual path. Developers can extend this class and override the `customEndpoint` method to implement specific customizations for their application's REST API routes as needed.
+ *
+ * @author Mario A. Serrano Leones
+ */
 @Provider
 public class DefaultCrudRestNavigationCustomizer implements CrudRestNavigationCustomizer {
 

platform/core/web/src/main/java/tools/dynamia/web/navigation/DefaultCrudRestNavigationCustomizer.java

@@ -15,7 +15,21 @@
 import java.lang.reflect.Method;
 import java.util.List;
 
-
+/**
+ * Configuration class that dynamically registers page navigation routes based on the pages defined in the application's modules.
+ *
+ * <p>This class listens for the application context to be fully initialized and then iterates through all modules and their associated pages to create dynamic routes for page navigation. Each page's virtual path is used to construct a unique URI, which is then mapped to the {@link PageNavigationController#route} method.</p>
+ *
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * @Configuration
+ * public class MyAppPageNavigationConfig extends PageNavigationConfiguration {
+ *     // Additional configuration or overrides can be added here if needed
+ * }
+ * }</pre>
+ *
+ * @author Mario A. Serrano Leones
+ */
 public class PageNavigationConfiguration {
 
     public static final String PAGE_URI = "/page/";

platform/core/web/src/main/java/tools/dynamia/web/navigation/PageNavigationConfiguration.java

@@ -34,6 +34,11 @@
 
 import static tools.dynamia.navigation.NavigationElement.PATH_SEPARATOR;
 
+/**
+ * Controller responsible for handling page navigation requests in the web application. It maps incoming HTTP requests to specific page paths and manages the navigation flow based on the requested URL structure. The controller supports various URL patterns to accommodate different levels of page hierarchy, allowing for flexible navigation within the application. It also handles access restrictions and integrates with page navigation interceptors to provide additional functionality during the navigation process.
+ *
+ * @author Mario A. Serrano Leones
+ */
 @Controller("pageNavigationController")
 @RequestMapping("/page")
 public class PageNavigationController {

platform/core/web/src/main/java/tools/dynamia/web/navigation/PageNavigationController.java

@@ -17,7 +17,21 @@
 import java.lang.reflect.Method;
 import java.util.List;
 
-
+/**
+ * Configuration class that dynamically registers REST API routes for CRUD operations based on the pages defined in the application's modules.
+ *
+ * <p>This class listens for the application context to be fully initialized and then iterates through all modules and their associated pages to create dynamic REST API routes for CRUD operations. Each page's virtual path is used to construct unique URIs for the standard CRUD operations (Create, Read, Update, Delete), which are then mapped to the corresponding methods in the {@link RestNavigationController}.</p>
+ *
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * @Configuration
+ * public class MyAppRestApiNavigationConfig extends RestApiNavigationConfiguration {
+ *     // Additional configuration or overrides can be added here if needed
+ * }
+ * }</pre>
+ *
+ * @author Mario A. Serrano Leones
+ */
 public class RestApiNavigationConfiguration {
 
 

platform/core/web/src/main/java/tools/dynamia/web/navigation/RestApiNavigationConfiguration.java

@@ -52,6 +52,11 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Controller responsible for handling RESTful API requests related to CRUD operations on entities defined in the application. It provides endpoints for reading, creating, updating, and deleting entities based on the paths defined in the application's navigation structure. The controller utilizes the CrudService to perform database operations and returns JSON responses with the appropriate data and metadata for each request. It also handles pagination and query parameters for listing entities, as well as access restrictions based on the navigation configuration.
+ *
+ * @author Mario A. Serrano Leones
+ */
 @RestController("restNavigationController")
 @Order(1000)
 public class RestNavigationController extends AbstractLoggable {

platform/core/web/src/main/java/tools/dynamia/web/navigation/RestNavigationController.java

@@ -19,40 +19,71 @@
 import tools.dynamia.commons.Callback;
 import tools.dynamia.commons.PropertyChangeSupport;
 
-
+/**
+ * Base class for forms in the UI layer. This class provides common functionality for handling form actions such as submit, cancel, and close.
+ * It also supports property change notifications to allow UI components to react to changes in form state.
+ *
+ * <p>Subclasses can override the submit(), cancel(), and close() methods to implement specific behavior for these actions.</p>
+ *
+ * @author Mario A. Serrano Leones
+ */
 public class Form extends PropertyChangeSupport {
 
     private Callback onSubmitCallback;
     private Callback onCancelCallback;
     private Callback onCloseCallback;
 
-
+    /**
+     * Trigger the submit action. This method checks if an onSubmitCallback is registered and executes it if present.
+     * Subclasses can override this method to provide additional behavior on form submission.
+     */
     protected void submit() {
         if (onSubmitCallback != null) {
             onSubmitCallback.doSomething();
         }
     }
 
+    /**
+     * Trigger the cancel action. This method checks if an onCancelCallback is registered and executes it if present.
+     * Subclasses can override this method to provide additional behavior on form cancellation.
+     */
     protected void cancel() {
         if (onCancelCallback != null) {
             onCancelCallback.doSomething();
         }
     }
 
+    /**
+     * Trigger the close action. This method checks if an onCloseCallback is registered and executes it if present.
+     * Subclasses can override this method to provide additional behavior on form closure.
+     */
     public void close() {
         if (onCloseCallback != null) {
             onCloseCallback.doSomething();
         }
     }
 
+    /**
+     * Setters for action callbacks. These methods allow external code to register callbacks that will be executed when the corresponding form actions are triggered.
+     */
     public void onCancel(Callback onCancelCallback) {
         this.onCancelCallback = onCancelCallback;
     }
 
+    /**
+     * Set the callback to be executed when the form is submitted. This allows external code to define custom behavior for form submission.
+     *
+     * @param onSubmitCallback The callback to execute on form submission.
+     */
     public void onSubmit(Callback onSubmitCallback) {
         this.onSubmitCallback = onSubmitCallback;
     }
 
+    /**
+     * Set the callback to be executed when the form is closed. This allows external code to define custom behavior for form closure.
+     *
+     * @param callback The callback to execute on form closure.
+     */
     public void onClose(Callback callback) {
         this.onCloseCallback = callback;
     }

platform/ui/ui-shared/src/main/java/tools/dynamia/ui/Form.java

@@ -17,6 +17,10 @@
 package tools.dynamia.ui;
 
 /**
+ * Enumeration representing different types of messages that can be displayed in the UI.
+ * This enum can be used to categorize messages based on their severity or purpose, such as normal informational messages,
+ * warnings, errors, critical issues, or special notifications.
+ *
  * @author Mario A. Serrano Leones
  */
 public enum MessageType {

platform/ui/ui-shared/src/main/java/tools/dynamia/ui/MessageType.java

@@ -4,11 +4,33 @@
 
 import java.util.List;
 
+/**
+ * Central utility class for UI-related operations in the Dynamia Tools framework.
+ * This class provides static methods for creating and displaying common UI components
+ * such as dialogs, listboxes, comboboxes, and buttons. It serves as a facade over
+ * the underlying {@link UIToolsProvider} implementation, allowing for decoupled
+ * UI component creation and management.
+ *
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * DialogComponent dialog = UITools.showDialog("My Dialog", "This is the content");
+ * ListboxComponent<String> listbox = UITools.listbox(List.of("Option 1", "Option 2"));
+ * ButtonComponent button = UITools.button("Click Me", () -> System.out.println("Button clicked"));
+ * }</pre>
+ *
+ * @author Mario A. Serrano Leones
+ */
 public class UITools {
 
     private static UIToolsProvider currentProvider;
 
 
+    /**
+     * Get the current UIToolsProvider instance.
+     *
+     * @return the current provider
+     * @throws IllegalStateException if no provider is found
+     */
     private static UIToolsProvider getProvider() {
         if (currentProvider == null) {
             currentProvider = Containers.get().findObject(UIToolsProvider.class);
@@ -19,6 +41,12 @@ private static UIToolsProvider getProvider() {
         return currentProvider;
     }
 
+    /**
+     * Set the current UIToolsProvider instance. This method can be used to override the default provider
+     * found in the container, allowing for custom implementations or testing purposes.
+     *
+     * @param currentProvider the new provider to set
+     */
     public static void setCurrentProvider(UIToolsProvider currentProvider) {
         UITools.currentProvider = currentProvider;
     }