Package io.jmix.ui.component

Interface OptionDialogFacet

All Superinterfaces:
ActionsAwareDialogFacet<OptionDialogFacet>, Facet, HasSubParts
All Known Implementing Classes:
OptionDialogFacetImpl
@StudioFacet(xmlElement="optionDialog", caption="OptionDialog", description="Prepares and shows option dialogs", defaultProperty="message", category="Facets", icon="io/jmix/ui/icon/facet/dialog.svg", documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/facets/option-dialog-facet.html") public interface OptionDialogFacet extends Facet, ActionsAwareDialogFacet<OptionDialogFacet>, HasSubParts
Prepares and shows option dialogs.

  • Method Details

    • setCaption

      @StudioProperty(type=LOCALIZED_STRING) void setCaption(@Nullable String caption)
      Sets dialog caption.
      Parameters:
      caption - caption

    • getCaption

      @Nullable String getCaption()
      Returns:
      dialog caption

    • setMessage

      @StudioProperty(type=LOCALIZED_STRING) void setMessage(@Nullable String message)
      Sets dialog message.
      Parameters:
      message - message

    • getMessage

      @Nullable String getMessage()
      Returns:
      dialog message

    • setContentMode

      @StudioProperty(type=ENUMERATION, defaultValue="TEXT") void setContentMode(ContentMode contentMode)
      Sets dialog message content mode.
      Parameters:
      contentMode - content mode

    • getContentMode

      ContentMode getContentMode()
      Returns:
      dialog message content mode

    • setWindowMode

      @StudioProperty(type=ENUMERATION, defaultValue="NORMAL") void setWindowMode(WindowMode windowMode)
      Sets the mode of the dialog window
      Parameters:
      windowMode - the mode of the dialog window

    • getWindowMode

      WindowMode getWindowMode()
      Returns:
      the mode of the dialog window

    • setStyleName

      @StudioProperty(name="stylename", type=CSS_CLASSNAME_LIST) void setStyleName(String styleName)
      Sets dialog style name.
      Parameters:
      styleName - style name

    • getStyleName

      @Nullable String getStyleName()
      Returns:
      dialog style name

    • setWidth

      @StudioProperty(type=SIZE) void setWidth(@Nullable String width)
      Sets dialog width.
      Parameters:
      width - width

    • getWidth

      float getWidth()
      Returns:
      dialog width

    • getWidthSizeUnit

      SizeUnit getWidthSizeUnit()
      Returns:
      dialog width size unit

    • setHeight

      @StudioProperty(type=SIZE) void setHeight(@Nullable String height)
      Sets dialog height.
      Parameters:
      height - height

    • getHeight

      float getHeight()
      Returns:
      dialog height

    • getHeightSizeUnit

      SizeUnit getHeightSizeUnit()
      Returns:
      dialog height size unit

    • getActionTarget

      @Nullable String getActionTarget()
      Returns:
      id of action that triggers dialog

    • setActionTarget

      @StudioProperty(name="onAction", type=COMPONENT_REF, options="io.jmix.ui.action.Action") void setActionTarget(@Nullable String actionId)
      Sets that dialog should be shown when action with id actionId is performed.
      Parameters:
      actionId - action id

    • getButtonTarget

      @Nullable String getButtonTarget()
      Returns:
      id of button that triggers dialog

    • setButtonTarget

      @StudioProperty(name="onButton", type=COMPONENT_REF, options="io.jmix.ui.component.Button") void setButtonTarget(@Nullable String buttonId)
      Sets that dialog should be shown when button with id actionId is clicked.
      Parameters:
      buttonId - button id

    • setHtmlSanitizerEnabled

      @StudioProperty(type=BOOLEAN, defaultValue="true") void setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)
      Sets whether html sanitizer is enabled or not for dialog content.
      Parameters:
      htmlSanitizerEnabled - specifies whether html sanitizer is enabled

    • isHtmlSanitizerEnabled

      boolean isHtmlSanitizerEnabled()
      Returns:
      html sanitizer is enabled for dialog content

    • show

      void show()
      Shows dialog.