Package io.jmix.flowui.kit.component.sidedialog

Class JmixSideDialogOverlay

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.dialog.Dialog
io.jmix.flowui.kit.component.sidedialog.JmixSideDialogOverlay
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.dialog.DialogVariant>, Serializable
@Tag("jmix-side-dialog") @JsModule("./src/side-dialog/jmix-side-dialog.js") public class JmixSideDialogOverlay extends com.vaadin.flow.component.dialog.Dialog
The extension of the Dialog component that functions as a drawer panel. It has a popping-out animation of the dialog and enables configuring the dialog position.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.dialog.Dialog

    com.vaadin.flow.component.dialog.Dialog.DialogCloseActionEvent, com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent, com.vaadin.flow.component.dialog.Dialog.DialogFooter, com.vaadin.flow.component.dialog.Dialog.DialogHeader, com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent, com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixSideDialogOverlay()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHeight()
     
    String
    getMaxHeight()
     
    String
    getMaxWidth()
     
    String
    getMinHeight()
     
    String
    getMinWidth()
     
    SideDialogPosition
    getSideDialogPosition()
     
    String
    getWidth()
     
    boolean
    isFullscreenOnSmallDevices()
     
    protected void
    onNodeAttach()
     
    void
    setFullscreenOnSmallDevices(boolean fullscreenOnSmallDevice)
    Sets whether the dialog should be displayed in fullscreen mode on small devices.
    void
    setHeight(String value)
     
    void
    setHeightFull()
    Sets the height of the dialog when vertical position is configured (SideDialogPosition.TOP, SideDialogPosition.BOTTOM).
    void
    setMaxHeight(String value)
     
    void
    setMaxWidth(String value)
     
    void
    setMinHeight(String value)
     
    void
    setMinWidth(String value)
     
    void
    setSideDialogPosition(SideDialogPosition position)
    Sets the dialog position.
    void
    setWidth(String value)
     
    void
    setWidthFull()
    Sets the full width of the dialog when horizontal position is configured (SideDialogPosition.LEFT, SideDialogPosition.RIGHT, SideDialogPosition.INLINE_START or SideDialogPosition.INLINE_END).

    Methods inherited from class com.vaadin.flow.component.dialog.Dialog

    add, addAttachListener, addComponentAtIndex, addDetachListener, addDialogCloseActionListener, addDraggedListener, addOpenedChangeListener, addResizeListener, close, getAriaLabel, getClassNames, getFooter, getHeader, getHeaderTitle, getLeft, getOverlayRole, getStyle, getTop, isCloseOnEsc, isCloseOnOutsideClick, isDraggable, isModal, isOpened, isResizable, onAttach, open, setAriaLabel, setClassName, setCloseOnEsc, setCloseOnOutsideClick, setDraggable, setHeaderTitle, setLeft, setModal, setOpened, setOverlayRole, setResizable, setTop, setVisible

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add, add, addComponentAsFirst, remove, remove, removeAll

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeightUnit, getWidthUnit, setHeight, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, hasClassName, removeClassName, removeClassNames, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants

  • Constructor Details

    • JmixSideDialogOverlay

      public JmixSideDialogOverlay()

  • Method Details

    • getWidth

      @Nullable public String getWidth()
      Specified by:
      getWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      getWidth in class com.vaadin.flow.component.dialog.Dialog

    • setWidth

      public void setWidth(@Nullable String value)
      Specified by:
      setWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      setWidth in class com.vaadin.flow.component.dialog.Dialog

    • getMinWidth

      @Nullable public String getMinWidth()
      Specified by:
      getMinWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      getMinWidth in class com.vaadin.flow.component.dialog.Dialog

    • setMinWidth

      public void setMinWidth(@Nullable String value)
      Specified by:
      setMinWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      setMinWidth in class com.vaadin.flow.component.dialog.Dialog

    • getMaxWidth

      @Nullable public String getMaxWidth()
      Specified by:
      getMaxWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      getMaxWidth in class com.vaadin.flow.component.dialog.Dialog

    • setMaxWidth

      public void setMaxWidth(@Nullable String value)
      Specified by:
      setMaxWidth in interface com.vaadin.flow.component.HasSize
      Overrides:
      setMaxWidth in class com.vaadin.flow.component.dialog.Dialog

    • getHeight

      @Nullable public String getHeight()
      Specified by:
      getHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      getHeight in class com.vaadin.flow.component.dialog.Dialog

    • setHeight

      public void setHeight(@Nullable String value)
      Specified by:
      setHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      setHeight in class com.vaadin.flow.component.dialog.Dialog

    • getMinHeight

      @Nullable public String getMinHeight()
      Specified by:
      getMinHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      getMinHeight in class com.vaadin.flow.component.dialog.Dialog

    • setMinHeight

      public void setMinHeight(@Nullable String value)
      Specified by:
      setMinHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      setMinHeight in class com.vaadin.flow.component.dialog.Dialog

    • getMaxHeight

      @Nullable public String getMaxHeight()
      Specified by:
      getMaxHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      getMaxHeight in class com.vaadin.flow.component.dialog.Dialog

    • setMaxHeight

      public void setMaxHeight(@Nullable String value)
      Specified by:
      setMaxHeight in interface com.vaadin.flow.component.HasSize
      Overrides:
      setMaxHeight in class com.vaadin.flow.component.dialog.Dialog

    • setWidthFull

      public void setWidthFull()
      Sets the full width of the dialog when horizontal position is configured (SideDialogPosition.LEFT, SideDialogPosition.RIGHT, SideDialogPosition.INLINE_START or SideDialogPosition.INLINE_END).

    • setHeightFull

      public void setHeightFull()
      Sets the height of the dialog when vertical position is configured (SideDialogPosition.TOP, SideDialogPosition.BOTTOM).

    • getSideDialogPosition

      public SideDialogPosition getSideDialogPosition()
      Returns:
      the dialog position

    • setSideDialogPosition

      public void setSideDialogPosition(SideDialogPosition position)
      Sets the dialog position. The default value is SideDialogPosition.RIGHT.
      Parameters:
      position - the dialog position

    • isFullscreenOnSmallDevices

      public boolean isFullscreenOnSmallDevices()
      Returns:
      true if the dialog should be displayed in fullscreen mode on small devices

    • setFullscreenOnSmallDevices

      public void setFullscreenOnSmallDevices(boolean fullscreenOnSmallDevice)
      Sets whether the dialog should be displayed in fullscreen mode on small devices.

      The default value is true.

      Parameters:
      fullscreenOnSmallDevice - fullscreen option

    • onNodeAttach

      protected void onNodeAttach()