Navigational Frame Titles

Abrir en ChatGPT

En webforJ, todas las rutas se renderizan dentro de un Frame, que sirve como un contenedor de nivel superior responsable de mostrar el contenido de la ruta actual. A medida que los usuarios navegan entre diferentes rutas, el Título del Frame se actualiza dinámicamente para reflejar la vista activa, ayudando a proporcionar un contexto claro sobre la ubicación actual del usuario dentro de la aplicación.

El título de un frame puede establecerse de forma estática utilizando anotaciones o dinámicamente a través de código en tiempo de ejecución. Este enfoque flexible permite a los desarrolladores definir títulos que se alineen con el propósito de cada vista, al tiempo que se adaptan a escenarios o parámetros específicos según sea necesario.

Título del frame con anotaciones

La forma más sencilla de establecer el título de un frame en la vista es utilizando la anotación @FrameTitle. Esta anotación permite definir un título estático para cualquier componente de ruta, que luego se aplica al frame cuando se renderiza el componente.

Usando la anotación @FrameTitle

La anotación @FrameTitle se aplica a nivel de clase y permite especificar un valor de cadena que representa el título de la página. Cuando el enrutador navega a un componente con esta anotación, el título especificado se establecerá automáticamente para la ventana del navegador.

Aquí hay un ejemplo:

@Route
@FrameTitle("Dashboard")
public class DashboardView extends Composite<Div> {
  public DashboardView() {
     // lógica de vista
  }
}

En este ejemplo:

• La clase DashboardView está anotada con @Route para definir la ruta.
• La anotación @FrameTitle("Dashboard") establece el título del frame como "Dashboard".
• Cuando el usuario navega a /dashboard, el título del frame se actualizará automáticamente al valor especificado.

Este método es útil para rutas que tienen un título estático y no requieren actualizaciones frecuentes basadas en el contexto de la ruta.

@AppTitle y @FrameTitle

Si se establece el título de la app, el título del frame lo incorporará. Por ejemplo, si la app define el título como @AppTitle("webforJ") y el título del frame se establece como @FrameTitle("Dashboard"), el título final de la página será Dashboard - webforJ. Puedes personalizar el formato del título final en la anotación @AppTitle utilizando el atributo format si es necesario.

Títulos de frame dinámicos

En los casos en que el título del frame necesita cambiar dinámicamente según el estado de la app o los parámetros de la ruta, webforJ proporciona una interfaz llamada HasFrameTitle. Esta interfaz permite que los componentes proporcionen un título de frame basado en el contexto de navegación actual y los parámetros de la ruta.

Implementando la interfaz HasFrameTitle

La interfaz HasFrameTitle contiene un único método getFrameTitle(), que se invoca antes de que se actualice el título del frame. Este método proporciona la flexibilidad para generar un título dinámicamente según el contexto de navegación u otros factores dinámicos.

@Route("profile/:id")
public class ProfileView extends Composite<Div> implements HasFrameTitle {

  public ProfileView() {
    getBoundComponent().add(new H1("Página de Perfil"));
  }
  
  @Override
  public String getFrameTitle(NavigationContext context, ParametersBag parameters) {
    // Establecer dinámicamente el título del frame utilizando parámetros de ruta
    String userId = parameters.get("id").orElse("Desconocido");
    return "Perfil - Usuario " + userId;
  }
}

En este ejemplo:

• El componente ProfileView implementa la interfaz HasFrameTitle.
• El método getFrameTitle() genera dinámicamente un título utilizando el parámetro id de la URL.
• Si la ruta es /profile/123, el título se actualizará a "Perfil - Usuario 123".

Combinando anotaciones y títulos dinámicos

Puedes combinar ambos métodos, estáticos y dinámicos. Si un componente de ruta tiene tanto una anotación @FrameTitle como implementa la interfaz HasFrameTitle, el título proporcionado dinámicamente desde getFrameTitle() tendrá prioridad sobre el valor estático de la anotación.