Package io.jmix.flowui

Interface Dialogs.Draggable<T>

Type Parameters:
T - return type of fluent API methods
All Known Subinterfaces:
Dialogs.BackgroundTaskDialogBuilder<T,V>, Dialogs.InputDialogBuilder, Dialogs.MessageDialogBuilder, Dialogs.OptionDialogBuilder
All Known Implementing Classes:
DialogsImpl.BackgroundTaskDialogBuilderImpl, DialogsImpl.InputDialogBuilderImpl, DialogsImpl.MessageDialogBuilderImpl, DialogsImpl.OptionDialogBuilderImpl
Enclosing interface:
Dialogs
public static interface Dialogs.Draggable<T>
Represents Dialog Builders that can be dragged.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isDraggable()
     
    T
    withDraggable(boolean draggable)
    Sets whether dialog is enabled to be dragged by the user or not.
    T
    withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)
    Adds a listener that is called after user finishes dragging the dialog.

  • Method Details

    • withDraggable

      T withDraggable(boolean draggable)
      Sets whether dialog is enabled to be dragged by the user or not.
      Parameters:
      draggable - true to enable dragging of the dialog, false otherwise
      Returns:
      builder

    • isDraggable

      boolean isDraggable()
      Returns:
      true if dragging is enabled, false otherwise

    • withDraggedListener

      T withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)
      Adds a listener that is called after user finishes dragging the dialog. It is called only if dragging is enabled.

      Note: By default, the component will sync the top/left values after every dragging.

      Parameters:
      listener - the listener to add
      Returns:
      builder
      See Also: