com.haulmont.cuba.gui.components

Interface OptionDialogFacet

All Superinterfaces:

ActionsAwareDialogFacet<OptionDialogFacet>, Facet, HasSubParts

@StudioFacet(xmlElement="optionDialog",
             caption="Option Dialog",
             description="Prepares and shows option dialogs",
             defaultProperty="message",
             category="Facets",
             icon="icon/dialog.svg",
             documentationURL="https://doc.cuba-platform.com/manual-%VERSION%/gui_OptionDialogFacet.html")
public interface OptionDialogFacet
extends Facet, ActionsAwareDialogFacet<OptionDialogFacet>, HasSubParts

Prepares and shows option dialogs.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ActionsAwareDialogFacet

ActionsAwareDialogFacet.DialogAction<T>, ActionsAwareDialogFacet.DialogActionPerformedEvent<T>

Method Summary

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	isHtmlSanitizerEnabled()
boolean	isMaximized()
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	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	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.

Methods inherited from interface com.haulmont.cuba.gui.components.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsAwareDialogFacet

getActions, setActions

Methods inherited from interface com.haulmont.cuba.gui.components.HasSubParts

getSubPart

Method Detail

setCaption

@StudioProperty(type=LOCALIZED_STRING)
void setCaption(java.lang.String caption)

Sets dialog caption.

Parameters:

caption - caption

getCaption

java.lang.String getCaption()

Returns:

dialog caption

setMessage

@StudioProperty(type=LOCALIZED_STRING)
void setMessage(java.lang.String message)

Sets dialog message.

Parameters:

message - message

getMessage

java.lang.String getMessage()

Returns:

dialog message

setType

@StudioProperty
void setType(Dialogs.MessageType type)

Sets dialog type.

Parameters:

type - type

getType

Dialogs.MessageType getType()

Returns:

dialog type

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

setMaximized

@StudioProperty(type=BOOLEAN)
void setMaximized(boolean maximized)

Sets whether dialog should be maximized.

Parameters:

maximized - maximized

isMaximized

boolean isMaximized()

Returns:

whether dialog should be maximized

setStyleName

@StudioProperty(type=STRING)
void setStyleName(java.lang.String styleName)

Sets dialog style name.

Parameters:

styleName - style name

getStyleName

java.lang.String getStyleName()

Returns:

dialog style name

setWidth

@StudioProperty(type=SIZE)
void setWidth(java.lang.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(java.lang.String height)

Sets dialog height.

Parameters:

height - height

getHeight

float getHeight()

Returns:

dialog height

getHeightSizeUnit

SizeUnit getHeightSizeUnit()

Returns:

dialog height size unit

getActionTarget

java.lang.String getActionTarget()

Returns:

id of action that triggers dialog

setActionTarget

@StudioProperty(name="onAction",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Action")
void setActionTarget(java.lang.String actionId)

Sets that dialog should be shown when action with id actionId is performed.

Parameters:

actionId - action id

getButtonTarget

java.lang.String getButtonTarget()

Returns:

id of button that triggers dialog

setButtonTarget

@StudioProperty(name="onButton",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Button")
void setButtonTarget(java.lang.String buttonId)

Sets that dialog should be shown when button with id actionId is clicked.

Parameters:

buttonId - button id

setHtmlSanitizerEnabled

@StudioProperty(type=BOOLEAN)
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.