Package io.jmix.ui.sys

Class DialogsImpl.MessageDialogBuilderImpl

java.lang.Object

io.jmix.ui.sys.DialogsImpl.MessageDialogBuilderImpl

All Implemented Interfaces:

Dialogs.DialogBuilder<Dialogs.MessageDialogBuilder>, Dialogs.HasCaption<Dialogs.MessageDialogBuilder>, Dialogs.HasContentMode<Dialogs.MessageDialogBuilder>, Dialogs.HasHtmlSanitizer<Dialogs.MessageDialogBuilder>, Dialogs.HasMessage<Dialogs.MessageDialogBuilder>, Dialogs.HasModal<Dialogs.MessageDialogBuilder>, Dialogs.HasSize<Dialogs.MessageDialogBuilder>, Dialogs.HasStyleName<Dialogs.MessageDialogBuilder>, Dialogs.HasWindowMode<Dialogs.MessageDialogBuilder>, Dialogs.MessageDialogBuilder

Enclosing class:

DialogsImpl

public class DialogsImpl.MessageDialogBuilderImpl
extends Object
implements Dialogs.MessageDialogBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	htmlSanitizerEnabled
protected com.vaadin.ui.VerticalLayout	layout
protected JmixLabel	messageLabel
protected JmixButton	okButton
protected JmixWindow	window

Constructor Summary

Constructors

Constructor	Description
MessageDialogBuilderImpl()

Method Summary

Modifier and Type	Method	Description
Dialogs.MessageDialogBuilder	closeOnClickOutside()	Enables closeOnClickOutside mode for window, so window can be closed by click outside of window content (by modality curtain).
String	getCaption()
ContentMode	getContentMode()
float	getHeight()
SizeUnit	getHeightSizeUnit()
String	getMessage()
String	getStyleName()
float	getWidth()
SizeUnit	getWidthSizeUnit()
WindowMode	getWindowMode()
protected void	initShortcuts()
boolean	isCloseOnClickOutside()
boolean	isHtmlSanitizerEnabled()
boolean	isModal()
Dialogs.MessageDialogBuilder	modal()	Enables modal mode for dialog.
void	show()	Shows the dialog.
Dialogs.MessageDialogBuilder	withCaption(String caption)	Sets caption text.
Dialogs.MessageDialogBuilder	withCloseOnClickOutside(boolean closeOnClickOutside)	Sets if window can be closed by click outside of window content (by modality curtain).
Dialogs.MessageDialogBuilder	withContentMode(ContentMode contentMode)	Sets content mode for message, e.g.
Dialogs.MessageDialogBuilder	withHeight(String height)	Sets dialog height.
Dialogs.MessageDialogBuilder	withHtmlSanitizer(boolean htmlSanitizerEnabled)	Sets whether html sanitizer is enabled or not for dialog content.
Dialogs.MessageDialogBuilder	withMessage(String message)	Sets message text.
Dialogs.MessageDialogBuilder	withModal(boolean modal)	Sets dialog modality.
Dialogs.MessageDialogBuilder	withStyleName(String styleName)	Sets custom CSS style name for dialog.
Dialogs.MessageDialogBuilder	withWidth(String width)	Sets dialog width.
Dialogs.MessageDialogBuilder	withWindowMode(WindowMode windowMode)	Sets the mode of the dialog window.

Methods inherited from class java.lang.Object

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

Field Details

window

protected JmixWindow window

messageLabel

protected JmixLabel messageLabel

layout

protected com.vaadin.ui.VerticalLayout layout

okButton

protected JmixButton okButton

htmlSanitizerEnabled

protected boolean htmlSanitizerEnabled

Constructor Details

MessageDialogBuilderImpl

public MessageDialogBuilderImpl()

Method Details

withCaption

public Dialogs.MessageDialogBuilder withCaption(String caption)

Description copied from interface: Dialogs.HasCaption

Sets caption text.

Specified by:

withCaption in interface Dialogs.HasCaption<Dialogs.MessageDialogBuilder>

Parameters:

caption - caption text

Returns:

builder

getCaption

public String getCaption()

Specified by:

getCaption in interface Dialogs.HasCaption<Dialogs.MessageDialogBuilder>

Returns:

caption text

withMessage

public Dialogs.MessageDialogBuilder withMessage(String message)

Description copied from interface: Dialogs.HasMessage

Sets message text.

Specified by:

withMessage in interface Dialogs.HasMessage<Dialogs.MessageDialogBuilder>

Parameters:

message - message text

Returns:

builder

getMessage

public String getMessage()

Specified by:

getMessage in interface Dialogs.HasMessage<Dialogs.MessageDialogBuilder>

Returns:

message text

withContentMode

public Dialogs.MessageDialogBuilder withContentMode(ContentMode contentMode)

Description copied from interface: Dialogs.HasContentMode

Sets content mode for message, e.g. ContentMode.TEXT, ContentMode.HTML or ContentMode.PREFORMATTED.

Specified by:

withContentMode in interface Dialogs.HasContentMode<Dialogs.MessageDialogBuilder>

Parameters:

contentMode - content mode

Returns:

builder

getContentMode

public ContentMode getContentMode()

Specified by:

getContentMode in interface Dialogs.HasContentMode<Dialogs.MessageDialogBuilder>

Returns:

message content mode

withWidth

public Dialogs.MessageDialogBuilder withWidth(String width)

Description copied from interface: Dialogs.HasSize

Sets dialog width.

Specified by:

withWidth in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Parameters:

width - width

Returns:

builder

getWidth

public float getWidth()

Specified by:

getWidth in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Returns:

dialog width value

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Specified by:

getWidthSizeUnit in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Returns:

dialog width unit

withHeight

public Dialogs.MessageDialogBuilder withHeight(String height)

Description copied from interface: Dialogs.HasSize

Sets dialog height.

Specified by:

withHeight in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Parameters:

height - height

Returns:

builder

getHeight

public float getHeight()

Specified by:

getHeight in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Returns:

dialog height value

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Specified by:

getHeightSizeUnit in interface Dialogs.HasSize<Dialogs.MessageDialogBuilder>

Returns:

dialog height unit

isModal

public boolean isModal()

Specified by:

isModal in interface Dialogs.HasModal<Dialogs.MessageDialogBuilder>

Returns:

true if window is modal

withModal

public Dialogs.MessageDialogBuilder withModal(boolean modal)

Description copied from interface: Dialogs.HasModal

Sets dialog modality. When a modal window is open, components outside that window cannot be accessed.

Specified by:

withModal in interface Dialogs.HasModal<Dialogs.MessageDialogBuilder>

Parameters:

modal - modal flag

Returns:

builder

modal

public Dialogs.MessageDialogBuilder modal()

Description copied from interface: Dialogs.HasModal

Enables modal mode for dialog.

Specified by:

modal in interface Dialogs.HasModal<Dialogs.MessageDialogBuilder>

Returns:

builder

withWindowMode

public Dialogs.MessageDialogBuilder withWindowMode(WindowMode windowMode)

Description copied from interface: Dialogs.HasWindowMode

Sets the mode of the dialog window.

Specified by:

withWindowMode in interface Dialogs.HasWindowMode<Dialogs.MessageDialogBuilder>

Parameters:

windowMode - the mode of the dialog window

Returns:

builder

getWindowMode

public WindowMode getWindowMode()

Specified by:

getWindowMode in interface Dialogs.HasWindowMode<Dialogs.MessageDialogBuilder>

Returns:

the mode of the dialog window

isCloseOnClickOutside

public boolean isCloseOnClickOutside()

Specified by:

isCloseOnClickOutside in interface Dialogs.MessageDialogBuilder

Returns:

true if window can be closed by click outside of window content (by modality curtain)

withCloseOnClickOutside

public Dialogs.MessageDialogBuilder withCloseOnClickOutside(boolean closeOnClickOutside)

Description copied from interface: Dialogs.MessageDialogBuilder

Sets if window can be closed by click outside of window content (by modality curtain).

Specified by:

withCloseOnClickOutside in interface Dialogs.MessageDialogBuilder

Parameters:

closeOnClickOutside - true if window to be closed by click outside of window content (by modality curtain)

Returns:

builder

closeOnClickOutside

public Dialogs.MessageDialogBuilder closeOnClickOutside()

Description copied from interface: Dialogs.MessageDialogBuilder

Enables closeOnClickOutside mode for window, so window can be closed by click outside of window content (by modality curtain).

Specified by:

closeOnClickOutside in interface Dialogs.MessageDialogBuilder

Returns:

builder

withStyleName

public Dialogs.MessageDialogBuilder withStyleName(String styleName)

Description copied from interface: Dialogs.HasStyleName

Sets custom CSS style name for dialog.

Specified by:

withStyleName in interface Dialogs.HasStyleName<Dialogs.MessageDialogBuilder>

Parameters:

styleName - style name

Returns:

builder

getStyleName

public String getStyleName()

Specified by:

getStyleName in interface Dialogs.HasStyleName<Dialogs.MessageDialogBuilder>

Returns:

custom style name

withHtmlSanitizer

public Dialogs.MessageDialogBuilder withHtmlSanitizer(boolean htmlSanitizerEnabled)

Description copied from interface: Dialogs.HasHtmlSanitizer

Sets whether html sanitizer is enabled or not for dialog content.

Specified by:

withHtmlSanitizer in interface Dialogs.HasHtmlSanitizer<Dialogs.MessageDialogBuilder>

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

Returns:

builder

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Specified by:

isHtmlSanitizerEnabled in interface Dialogs.HasHtmlSanitizer<Dialogs.MessageDialogBuilder>

Returns:

html sanitizer is enabled for dialog content

show

public void show()

Description copied from interface: Dialogs.MessageDialogBuilder

Shows the dialog.

Specified by:

show in interface Dialogs.MessageDialogBuilder

initShortcuts

protected void initShortcuts()