Package io.jmix.flowui.view

Annotation Interface DialogMode

@Documented @Retention(RUNTIME) @Target(TYPE) @Inherited public @interface DialogMode
Specifies parameters of DialogWindow.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    closeOnEsc
    Specifies whether the dialog should close when the "Escape" key is pressed.
    boolean
    closeOnOutsideClick
    Specifies whether the dialog should close when a click is detected outside of it.
    boolean
    draggable
    Specifies whether the dialog window can be dragged by the user.
    String
    height
    Specifies the height of the dialog window.
    boolean
    keepInViewport
    Specifies whether the dialog is prevented from moving outside the viewport bounds or not.
    String
    left
    Returns the left position of the overlay.
    String
    maxHeight
    Specifies the maximum height of the dialog window.
    String
    maxWidth
    Specifies the maximum width of the dialog window.
    String
    minHeight
    Specifies the minimum height of the dialog window.
    String
    minWidth
    Specifies the minimum width of the dialog window.
    boolean
    modal
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use modality() instead.
    DialogModalityMode
    modality
    Specifies the modality mode for the dialog window.
    boolean
    resizable
    Specifies whether the dialog window can be resized by the user.
    String
    top
    Returns the top position of the overlay.
    String
    width
    Specifies the width of the dialog window.

  • Element Details

    • width

      String width
      Specifies the width of the dialog window. The value can be defined as a valid CSS width (e.g., "400px", "50%", "auto"). If not specified, it defaults to an empty string which implies no specific width is set.
      Returns:
      the specified width of the dialog window
      Default:
      ""

    • maxWidth

      String maxWidth
      Specifies the maximum width of the dialog window. The value can be defined as a valid CSS width (e.g., "600px", "70%", "none"). If not specified, it defaults to an empty string, which implies no specific maximum width is set.
      Returns:
      the maximum width of the dialog window
      Default:
      ""

    • minWidth

      String minWidth
      Specifies the minimum width of the dialog window. The value can be defined as a valid CSS width (e.g., "300px", "40%", "auto"). If not specified, it defaults to an empty string, which implies no specific minimum width is set.
      Returns:
      the minimum width of the dialog window
      Default:
      ""

    • height

      String height
      Specifies the height of the dialog window. The value can be defined as a valid CSS height (e.g., "200px", "50%", "auto"). If not specified, it defaults to an empty string, which implies no specific height is set.
      Returns:
      the specified height of the dialog window
      Default:
      ""

    • maxHeight

      String maxHeight
      Specifies the maximum height of the dialog window. The value can be defined as a valid CSS height (e.g., "400px", "60%", "none"). If not specified, it defaults to an empty string, which implies no specific maximum height is set.
      Returns:
      the maximum height of the dialog window
      Default:
      ""

    • minHeight

      String minHeight
      Specifies the minimum height of the dialog window. The value can be defined as a valid CSS height (e.g., "100px", "30%", "auto"). If not specified, it defaults to an empty string, which implies no specific minimum height is set.
      Returns:
      the minimum height of the dialog window
      Default:
      ""

    • left

      String left
      Returns the left position of the overlay.
      Returns:
      the left position of the overlay
      Default:
      ""

    • top

      String top
      Returns the top position of the overlay.
      Returns:
      the top position of the overlay
      Default:
      ""

    • modal

      @Deprecated(since="3.0", forRemoval=true) boolean modal
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use modality() instead.
      Specifies whether the dialog window should be modal. When set to true, the dialog will disable interaction with elements outside of the dialog while it is open.
      Returns:
      true if the dialog is modal, otherwise false
      Default:
      true

    • modality

      DialogModalityMode modality
      Specifies the modality mode for the dialog window. Determines how the dialog interacts with other windows in the application.
      Returns:
      the modality mode for the dialog
      Default:
      DEFAULT

    • draggable

      boolean draggable
      Specifies whether the dialog window can be dragged by the user.
      Returns:
      true if the dialog is draggable, otherwise false
      Default:
      true

    • resizable

      boolean resizable
      Specifies whether the dialog window can be resized by the user.
      Returns:
      true if the dialog is resizable, otherwise false
      Default:
      false

    • closeOnOutsideClick

      boolean closeOnOutsideClick
      Specifies whether the dialog should close when a click is detected outside of it.
      Returns:
      true if the dialog should close on outside click, otherwise false
      Default:
      false

    • closeOnEsc

      boolean closeOnEsc
      Specifies whether the dialog should close when the "Escape" key is pressed.
      Returns:
      true if the dialog should close on pressing the "Escape" key, otherwise false
      Default:
      false

    • keepInViewport

      boolean keepInViewport
      Specifies whether the dialog is prevented from moving outside the viewport bounds or not. When enabled, all four edges of the dialog will remain visible, for example when dragging the dialog or when the viewport is resized. Note that the dialog will also adjust any programmatically configured size and position so that it stays within the viewport.
      Returns:
      true to prevent the dialog from moving outside the viewport bounds, false otherwise
      Default:
      false