io.jmix.ui.sys

Class DialogsImpl.OptionDialogBuilderImpl

java.lang.Object

io.jmix.ui.sys.DialogsImpl.OptionDialogBuilderImpl

All Implemented Interfaces:

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

Enclosing class:

DialogsImpl

public class DialogsImpl.OptionDialogBuilderImpl
extends java.lang.Object
implements Dialogs.OptionDialogBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected Action[]	actions
protected com.vaadin.ui.HorizontalLayout	buttonsContainer
protected boolean	htmlSanitizerEnabled
protected com.vaadin.ui.VerticalLayout	layout
protected JmixLabel	messageLabel
protected JmixWindow	window

Constructor Summary

Constructors

Constructor and Description
OptionDialogBuilderImpl()

Method Summary

Modifier and Type	Method and Description
protected DialogAction	findFirstActionWithType(Action[] actions, java.util.EnumSet<DialogAction.Type> types)
Action[]	getActions()
java.lang.String	getCaption()
ContentMode	getContentMode()
float	getHeight()
SizeUnit	getHeightSizeUnit()
java.lang.String	getMessage()
java.lang.String	getStyleName()
float	getWidth()
SizeUnit	getWidthSizeUnit()
WindowMode	getWindowMode()
boolean	isHtmlSanitizerEnabled()
void	show() Shows the dialog.
Dialogs.OptionDialogBuilder	withActions(Action... actions) Sets dialog actions.
Dialogs.OptionDialogBuilder	withCaption(java.lang.String caption) Sets caption text.
Dialogs.OptionDialogBuilder	withContentMode(ContentMode contentMode) Sets content mode for message, e.g.
Dialogs.OptionDialogBuilder	withHeight(java.lang.String height) Sets dialog height.
Dialogs.OptionDialogBuilder	withHtmlSanitizer(boolean htmlSanitizerEnabled) Sets whether html sanitizer is enabled or not for dialog content.
Dialogs.OptionDialogBuilder	withMessage(java.lang.String message) Sets message text.
Dialogs.OptionDialogBuilder	withStyleName(java.lang.String styleName) Sets custom CSS style name for dialog.
Dialogs.OptionDialogBuilder	withWidth(java.lang.String width) Sets dialog width.
Dialogs.OptionDialogBuilder	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 Detail

window

protected JmixWindow window

messageLabel

protected JmixLabel messageLabel

layout

protected com.vaadin.ui.VerticalLayout layout

buttonsContainer

protected com.vaadin.ui.HorizontalLayout buttonsContainer

htmlSanitizerEnabled

protected boolean htmlSanitizerEnabled

actions

protected Action[] actions

Constructor Detail

OptionDialogBuilderImpl

public OptionDialogBuilderImpl()

Method Detail

withCaption

public Dialogs.OptionDialogBuilder withCaption(java.lang.String caption)

Description copied from interface: Dialogs.HasCaption

Sets caption text.

Specified by:

withCaption in interface Dialogs.HasCaption<Dialogs.OptionDialogBuilder>

Parameters:

caption - caption text

Returns:

builder

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface Dialogs.HasCaption<Dialogs.OptionDialogBuilder>

Returns:

caption text

withMessage

public Dialogs.OptionDialogBuilder withMessage(java.lang.String message)

Description copied from interface: Dialogs.HasMessage

Sets message text.

Specified by:

withMessage in interface Dialogs.HasMessage<Dialogs.OptionDialogBuilder>

Parameters:

message - message text

Returns:

builder

getMessage

public java.lang.String getMessage()

Specified by:

getMessage in interface Dialogs.HasMessage<Dialogs.OptionDialogBuilder>

Returns:

message text

withContentMode

public Dialogs.OptionDialogBuilder 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.OptionDialogBuilder>

Parameters:

contentMode - content mode

Returns:

builder

getContentMode

public ContentMode getContentMode()

Specified by:

getContentMode in interface Dialogs.HasContentMode<Dialogs.OptionDialogBuilder>

Returns:

message content mode

withActions

public Dialogs.OptionDialogBuilder withActions(Action... actions)

Description copied from interface: Dialogs.OptionDialogBuilder

Sets dialog actions.

Specified by:

withActions in interface Dialogs.OptionDialogBuilder

Parameters:

actions - actions

Returns:

builder

getActions

public Action[] getActions()

Specified by:

getActions in interface Dialogs.OptionDialogBuilder

Returns:

dialog actions

withWidth

public Dialogs.OptionDialogBuilder withWidth(java.lang.String width)

Description copied from interface: Dialogs.HasSize

Sets dialog width.

Specified by:

withWidth in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Parameters:

width - width

Returns:

builder

getWidth

public float getWidth()

Specified by:

getWidth in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog width value

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Specified by:

getWidthSizeUnit in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog width unit

withHeight

public Dialogs.OptionDialogBuilder withHeight(java.lang.String height)

Description copied from interface: Dialogs.HasSize

Sets dialog height.

Specified by:

withHeight in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Parameters:

height - height

Returns:

builder

getHeight

public float getHeight()

Specified by:

getHeight in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog height value

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Specified by:

getHeightSizeUnit in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog height unit

withWindowMode

public Dialogs.OptionDialogBuilder withWindowMode(WindowMode windowMode)

Description copied from interface: Dialogs.HasWindowMode

Sets the mode of the dialog window.

Specified by:

withWindowMode in interface Dialogs.HasWindowMode<Dialogs.OptionDialogBuilder>

Parameters:

windowMode - the mode of the dialog window

Returns:

builder

getWindowMode

public WindowMode getWindowMode()

Specified by:

getWindowMode in interface Dialogs.HasWindowMode<Dialogs.OptionDialogBuilder>

Returns:

the mode of the dialog window

withStyleName

public Dialogs.OptionDialogBuilder withStyleName(java.lang.String styleName)

Description copied from interface: Dialogs.HasStyleName

Sets custom CSS style name for dialog.

Specified by:

withStyleName in interface Dialogs.HasStyleName<Dialogs.OptionDialogBuilder>

Parameters:

styleName - style name

Returns:

builder

getStyleName

public java.lang.String getStyleName()

Specified by:

getStyleName in interface Dialogs.HasStyleName<Dialogs.OptionDialogBuilder>

Returns:

custom style name

withHtmlSanitizer

public Dialogs.OptionDialogBuilder 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.OptionDialogBuilder>

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

Returns:

builder

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Specified by:

isHtmlSanitizerEnabled in interface Dialogs.HasHtmlSanitizer<Dialogs.OptionDialogBuilder>

Returns:

html sanitizer is enabled for dialog content

show

public void show()

Description copied from interface: Dialogs.OptionDialogBuilder

Shows the dialog.

Specified by:

show in interface Dialogs.OptionDialogBuilder

findFirstActionWithType

@Nullable
protected DialogAction findFirstActionWithType(Action[] actions,
                                                         java.util.EnumSet<DialogAction.Type> types)