@StudioFacet(xmlElement="messageDialog", caption="Message Dialog", description="Prepares and shows message dialogs", defaultProperty="message", category="Facets", icon="icon/dialog.svg", documentationURL="https://doc.cuba-platform.com/manual-%VERSION%/gui_MessageDialogFacet.html") public interface MessageDialogFacet extends Facet
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActionTarget() |
java.lang.String |
getButtonTarget() |
java.lang.String |
getCaption() |
ContentMode |
getContentMode() |
float |
getHeight() |
SizeUnit |
getHeightSizeUnit() |
java.lang.String |
getMessage() |
java.lang.String |
getStyleName() |
Dialogs.MessageType |
getType() |
float |
getWidth() |
SizeUnit |
getWidthSizeUnit() |
boolean |
isCloseOnClickOutside() |
boolean |
isHtmlSanitizerEnabled() |
boolean |
isMaximized() |
boolean |
isModal() |
void |
setActionTarget(java.lang.String actionId)
Sets that dialog should be shown when action with id
actionId
is performed. |
void |
setButtonTarget(java.lang.String buttonId)
Sets that dialog should be shown when button with id
actionId
is clicked. |
void |
setCaption(java.lang.String caption)
Sets dialog caption.
|
void |
setCloseOnClickOutside(boolean closeOnClickOutside)
Sets whether the dialog should be closed on click outside.
|
void |
setContentMode(ContentMode contentMode)
Sets dialog message content mode.
|
void |
setHeight(java.lang.String height)
Sets dialog height.
|
void |
setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)
Sets whether html sanitizer is enabled or not for dialog content.
|
void |
setMaximized(boolean maximized)
Sets whether dialog should be maximized.
|
void |
setMessage(java.lang.String message)
Sets dialog message.
|
void |
setModal(boolean modal)
Sets whether dialog should be modal
|
void |
setStyleName(java.lang.String styleName)
Sets dialog style name.
|
void |
setType(Dialogs.MessageType type)
Sets dialog type.
|
void |
setWidth(java.lang.String width)
Sets dialog width.
|
void |
show()
Shows dialog.
|
@StudioProperty(type=LOCALIZED_STRING) void setCaption(java.lang.String caption)
caption
- captionjava.lang.String getCaption()
@StudioProperty(type=LOCALIZED_STRING) void setMessage(java.lang.String message)
message
- messagejava.lang.String getMessage()
@StudioProperty(type=ENUMERATION) void setType(Dialogs.MessageType type)
type
- typeDialogs.MessageType getType()
@StudioProperty(type=ENUMERATION, defaultValue="TEXT") void setContentMode(ContentMode contentMode)
contentMode
- content modeContentMode getContentMode()
@StudioProperty(type=BOOLEAN) void setMaximized(boolean maximized)
maximized
- maximizedboolean isMaximized()
@StudioProperty(type=BOOLEAN) void setModal(boolean modal)
modal
- modalboolean isModal()
@StudioProperty(type=STRING) void setStyleName(java.lang.String styleName)
styleName
- style namejava.lang.String getStyleName()
@StudioProperty(type=SIZE) void setWidth(java.lang.String width)
width
- widthfloat getWidth()
SizeUnit getWidthSizeUnit()
@StudioProperty(type=SIZE) void setHeight(java.lang.String height)
height
- heightfloat getHeight()
SizeUnit getHeightSizeUnit()
@StudioProperty(name="onAction", type=COMPONENT_REF, options="com.haulmont.cuba.gui.components.Action") void setActionTarget(java.lang.String actionId)
actionId
is performed.actionId
- action idjava.lang.String getActionTarget()
@StudioProperty(name="onButton", type=COMPONENT_REF, options="com.haulmont.cuba.gui.components.Button") void setButtonTarget(java.lang.String buttonId)
actionId
is clicked.buttonId
- button idjava.lang.String getButtonTarget()
@StudioProperty(type=BOOLEAN) void setCloseOnClickOutside(boolean closeOnClickOutside)
closeOnClickOutside
- close on click outsideboolean isCloseOnClickOutside()
@StudioProperty(type=BOOLEAN) void setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)
htmlSanitizerEnabled
- specifies whether html sanitizer is enabledboolean isHtmlSanitizerEnabled()
void show()