Package io.jmix.flowui.view

Class ViewControllerUtils

java.lang.Object
io.jmix.flowui.view.ViewControllerUtils
public final class ViewControllerUtils extends Object

  • Method Details

    • getPageTitle

      public static String getPageTitle(@Nullable com.vaadin.flow.component.Component component)

    • findAnnotation

      public static <A extends Annotation> Optional<A> findAnnotation(com.vaadin.flow.component.Component component, Class<A> annotationClass)

    • findAnnotation

      public static <A extends Annotation> Optional<A> findAnnotation(Class<? extends com.vaadin.flow.component.Component> componentClass, Class<A> annotationClass)

    • getPackage

      public static String getPackage(Class<?> controllerClass)

    • getViewData

      public static ViewData getViewData(View<?> view)

    • setViewData

      public static void setViewData(View<?> view, ViewData viewData)

    • getViewActions

      public static ViewActions getViewActions(View<?> view)

    • setViewActions

      public static void setViewActions(View<?> view, ViewActions viewActions)

    • getViewFacets

      public static ViewFacets getViewFacets(View<?> view)

    • getViewFacet

      @Nullable public static <T extends Facet> T getViewFacet(View<?> view, Class<T> facetClass)

    • setViewFacets

      public static void setViewFacets(View<?> view, ViewFacets viewFacets)

    • fireEvent

      public static void fireEvent(View<?> view, com.vaadin.flow.component.ComponentEvent<?> event)

    • isSaveActionPerformed

      public static boolean isSaveActionPerformed(StandardDetailView<?> detailView)

    • addQueryParametersChangeListener

      public static com.vaadin.flow.shared.Registration addQueryParametersChangeListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.QueryParametersChangeEvent> listener)

    • addRestoreComponentsStateEventListener

      public static com.vaadin.flow.shared.Registration addRestoreComponentsStateEventListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.RestoreComponentsStateEvent> listener)
      Adds View.RestoreComponentsStateEvent listener.
      Parameters:
      listener - the listened to add, not null
      Returns:
      a registration object that can be used for removing the listener

    • addInitEntityEventListener

      public static <T> com.vaadin.flow.shared.Registration addInitEntityEventListener(StandardDetailView<T> view, com.vaadin.flow.component.ComponentEventListener<StandardDetailView.InitEntityEvent<T>> listener)

    • addBeforeShowEventListener

      public static com.vaadin.flow.shared.Registration addBeforeShowEventListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.BeforeShowEvent> listener)

    • addDetachListener

      public static com.vaadin.flow.shared.Registration addDetachListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.DetachEvent> listener)

    • addAfterCloseListener

      public static com.vaadin.flow.shared.Registration addAfterCloseListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.AfterCloseEvent> listener)

    • addValidationEventListener

      public static com.vaadin.flow.shared.Registration addValidationEventListener(StandardDetailView<?> view, com.vaadin.flow.component.ComponentEventListener<StandardDetailView.ValidationEvent> listener)

    • addReadyListener

      public static com.vaadin.flow.shared.Registration addReadyListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.ReadyEvent> listener)

    • addPostReadyListener

      public static com.vaadin.flow.shared.Registration addPostReadyListener(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.PostReadyEvent> listener)

    • addInitEntityEvent

      @Deprecated(since="2.2", forRemoval=true) public static <T> com.vaadin.flow.shared.Registration addInitEntityEvent(StandardDetailView<T> view, com.vaadin.flow.component.ComponentEventListener<StandardDetailView.InitEntityEvent<T>> listener)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addInitEntityEventListener(StandardDetailView, ComponentEventListener) instead

    • addBeforeShowEvent

      @Deprecated(since="2.2", forRemoval=true) public static com.vaadin.flow.shared.Registration addBeforeShowEvent(View<?> view, com.vaadin.flow.component.ComponentEventListener<View.BeforeShowEvent> listener)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addBeforeShowEventListener(View, ComponentEventListener) instead

    • setAfterNavigationHandler

      public static void setAfterNavigationHandler(View<?> view, Runnable operation)

    • setViewCloseDelegate

      public static <T extends com.vaadin.flow.component.Component> void setViewCloseDelegate(View<T> view, Consumer<View<T>> closeDelegate)

    • setPageTitleDelegate

      public static void setPageTitleDelegate(View<?> view, Consumer<String> pageTitleDelegate)

    • isSameView

      public static boolean isSameView(View<?> view, View<?> other)

    • getRouteParamName

      public static String getRouteParamName(StandardDetailView<?> detailView)

    • getApplicationEventListeners

      public static List<org.springframework.context.ApplicationListener<?>> getApplicationEventListeners(View<?> view)
      Returns a list of application event listeners associated with a given View.
      Parameters:
      view - the View for which to retrieve the application event listeners
      Returns:
      a list of application event listeners associated with the specified View

    • setApplicationEventListeners

      public static void setApplicationEventListeners(View<?> view, @Nullable List<org.springframework.context.ApplicationListener<?>> listeners)
      Sets the application event listeners for the specified View.
      Parameters:
      view - the View for which to set the application event listeners
      listeners - a list of application event listeners to be set for the View, or null if no listeners should be associated

    • processBeforeEnterInternal

      public static void processBeforeEnterInternal(View<?> view, com.vaadin.flow.router.BeforeEnterEvent event)

    • configureDialogWindowHeader

      public static void configureDialogWindowHeader(View<?> view, DialogWindowHeader dialogWindowHeader)

    • configureDialogWindowFooter

      public static void configureDialogWindowFooter(View<?> view, DialogWindowFooter dialogWindowFooter)