Package io.jmix.flowui.impl

Class DialogsImpl.OptionDialogBuilderImpl

java.lang.Object

io.jmix.flowui.impl.DialogsImpl.OptionDialogBuilderImpl

All Implemented Interfaces:

Dialogs.DialogBuilder<Dialogs.OptionDialogBuilder>, Dialogs.Draggable<Dialogs.OptionDialogBuilder>, Dialogs.HasContent<Dialogs.OptionDialogBuilder>, Dialogs.HasHeader<Dialogs.OptionDialogBuilder>, Dialogs.HasPosition<Dialogs.OptionDialogBuilder>, Dialogs.HasSize<Dialogs.OptionDialogBuilder>, Dialogs.HasStyle<Dialogs.OptionDialogBuilder>, Dialogs.HasText<Dialogs.OptionDialogBuilder>, Dialogs.HasTheme<Dialogs.OptionDialogBuilder>, Dialogs.OptionDialogBuilder, Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Enclosing class:

DialogsImpl

public class DialogsImpl.OptionDialogBuilderImpl
extends Object
implements Dialogs.OptionDialogBuilder

Implementation of the Dialogs.OptionDialogBuilder that enables configuring and building option dialogs. This class provides a variety of methods to customize the appearance and behavior of the dialog, including setting headers, content, dimensions, actions, and event listeners.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<com.vaadin.flow.component.button.Button>	actionButtons
protected Action[]	actions
protected com.vaadin.flow.component.Component	content
protected com.vaadin.flow.component.dialog.Dialog	dialog

Constructor Summary

Constructors

Constructor	Description
OptionDialogBuilderImpl()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.dialog.Dialog	build()	Builds option the dialog.
protected com.vaadin.flow.component.dialog.Dialog	createDialog()
protected DialogAction	findFirstActionWithType(Action[] actions, EnumSet<DialogAction.Type> types)
protected void	fireDialogOpenedChangeEvent(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent openedChangeEvent)
Action[]	getActions()
String	getClassName()	Gets the CSS class names for this component.
com.vaadin.flow.component.Component	getContent()
String	getHeader()
String	getHeight()
String	getLeft()	Gets the left position of the dialog.
String	getMaxHeight()
String	getMaxWidth()
String	getMinHeight()
String	getMinWidth()
String	getText()
String	getThemeName()	Gets the theme names for this component.
String	getTop()	Gets the top position of the dialog.
String	getWidth()
protected void	initDialog(com.vaadin.flow.component.dialog.Dialog dialog)
protected void	initKeyCombination(DialogAction firstOkAction, DialogAction firstDeclineAction, Action action, com.vaadin.flow.component.button.Button button)
boolean	isDraggable()
boolean	isResizable()
com.vaadin.flow.component.dialog.Dialog	open()	Opens the option dialog.
Dialogs.OptionDialogBuilder	withActions(Action... actions)	Sets dialog actions.
Dialogs.OptionDialogBuilder	withClassName(String className)	Sets the CSS class names of this component.
Dialogs.OptionDialogBuilder	withContent(com.vaadin.flow.component.Component content)	Sets a content.
Dialogs.OptionDialogBuilder	withDraggable(boolean draggable)	Sets whether dialog is enabled to be dragged by the user or not.
Dialogs.OptionDialogBuilder	withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds a listener that is called after user finishes dragging the dialog.
Dialogs.OptionDialogBuilder	withHeader(String header)	Sets a header text.
Dialogs.OptionDialogBuilder	withHeight(String height)	Sets dialog height.
Dialogs.OptionDialogBuilder	withLeft(String left)	Sets the distance of the dialog from the left of its container.
Dialogs.OptionDialogBuilder	withMaxHeight(String maxHeight)	Sets a dialog max height.
Dialogs.OptionDialogBuilder	withMaxWidth(String maxWidth)	Sets a dialog max width.
Dialogs.OptionDialogBuilder	withMinHeight(String minHeight)	Sets a dialog min height.
Dialogs.OptionDialogBuilder	withMinWidth(String minWidth)	Sets a dialog min width.
Dialogs.OptionDialogBuilder	withResizable(boolean resizable)	Sets whether dialog can be resized by user or not.
Dialogs.OptionDialogBuilder	withResizeListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)	Adds a listener that is called after user finishes resizing the dialog.
Dialogs.OptionDialogBuilder	withText(String text)	Sets a text.
Dialogs.OptionDialogBuilder	withThemeName(String themeName)	Sets the theme names of the dialog.
Dialogs.OptionDialogBuilder	withTop(String top)	Sets the top position of the dialog.
Dialogs.OptionDialogBuilder	withWidth(String width)	Sets dialog width.

Methods inherited from class java.lang.Object

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

Field Details

dialog

protected com.vaadin.flow.component.dialog.Dialog dialog

content

protected com.vaadin.flow.component.Component content

actions

protected Action[] actions

actionButtons

protected List<com.vaadin.flow.component.button.Button> actionButtons

Constructor Details

OptionDialogBuilderImpl

public OptionDialogBuilderImpl()

Method Details

createDialog

protected com.vaadin.flow.component.dialog.Dialog createDialog()

initDialog

protected void initDialog(com.vaadin.flow.component.dialog.Dialog dialog)

withHeader

public Dialogs.OptionDialogBuilder withHeader(String header)

Description copied from interface: Dialogs.HasHeader

Sets a header text.

Specified by:

withHeader in interface Dialogs.HasHeader<Dialogs.OptionDialogBuilder>

Parameters:

header - header text

Returns:

builder

getHeader

@Nullable
public String getHeader()

Specified by:

getHeader in interface Dialogs.HasHeader<Dialogs.OptionDialogBuilder>

Returns:

header text

withText

public Dialogs.OptionDialogBuilder withText(String text)

Description copied from interface: Dialogs.HasText

Sets a text.

Specified by:

withText in interface Dialogs.HasText<Dialogs.OptionDialogBuilder>

Parameters:

text - a text

Returns:

builder

getText

@Nullable
public String getText()

Specified by:

getText in interface Dialogs.HasText<Dialogs.OptionDialogBuilder>

Returns:

a text

withContent

public Dialogs.OptionDialogBuilder withContent(com.vaadin.flow.component.Component content)

Description copied from interface: Dialogs.HasContent

Sets a content.

Specified by:

withContent in interface Dialogs.HasContent<Dialogs.OptionDialogBuilder>

Parameters:

content - a content

Returns:

builder

getContent

@Nullable
public com.vaadin.flow.component.Component getContent()

Specified by:

getContent in interface Dialogs.HasContent<Dialogs.OptionDialogBuilder>

Returns:

a content

withWidth

public Dialogs.OptionDialogBuilder withWidth(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 String getWidth()

Specified by:

getWidth in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog width value

withHeight

public Dialogs.OptionDialogBuilder withHeight(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 String getHeight()

Specified by:

getHeight in interface Dialogs.HasSize<Dialogs.OptionDialogBuilder>

Returns:

dialog height value

withThemeName

public Dialogs.OptionDialogBuilder withThemeName(String themeName)

Description copied from interface: Dialogs.HasTheme

Sets the theme names of the dialog. This method overwrites any previous set theme names.

Specified by:

withThemeName in interface Dialogs.HasTheme<Dialogs.OptionDialogBuilder>

Parameters:

themeName - a space-separated string of theme names to set, or empty string to remove all theme names

Returns:

builder

getThemeName

@Nullable
public String getThemeName()

Description copied from interface: Dialogs.HasTheme

Gets the theme names for this component.

Specified by:

getThemeName in interface Dialogs.HasTheme<Dialogs.OptionDialogBuilder>

Returns:

a space-separated string of theme names, empty string if there are no theme names or null if attribute (theme) is not set at all

withClassName

public Dialogs.OptionDialogBuilder withClassName(@Nullable
 String className)

Description copied from interface: Dialogs.HasStyle

Sets the CSS class names of this component. This method overwrites any previous set class names.

Specified by:

withClassName in interface Dialogs.HasStyle<Dialogs.OptionDialogBuilder>

Parameters:

className - a space-separated string of class names to set, or null to remove all class names

getClassName

@Nullable
public String getClassName()

Description copied from interface: Dialogs.HasStyle

Gets the CSS class names for this component.

Specified by:

getClassName in interface Dialogs.HasStyle<Dialogs.OptionDialogBuilder>

Returns:

a space-separated string of class names, or null if there are no class names

withDraggable

public Dialogs.OptionDialogBuilder withDraggable(boolean draggable)

Description copied from interface: Dialogs.Draggable

Sets whether dialog is enabled to be dragged by the user or not.

Specified by:

withDraggable in interface Dialogs.Draggable<Dialogs.OptionDialogBuilder>

Parameters:

draggable - true to enable dragging of the dialog, false otherwise

Returns:

builder

isDraggable

public boolean isDraggable()

Specified by:

isDraggable in interface Dialogs.Draggable<Dialogs.OptionDialogBuilder>

Returns:

true if dragging is enabled, false otherwise

withDraggedListener

public Dialogs.OptionDialogBuilder withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)

Description copied from interface: Dialogs.Draggable

Adds a listener that is called after user finishes dragging the dialog. It is called only if dragging is enabled.

Note: By default, the component will sync the top/left values after every dragging.

Specified by:

withDraggedListener in interface Dialogs.Draggable<Dialogs.OptionDialogBuilder>

Parameters:

listener - the listener to add

Returns:

builder

See Also:

• Dialogs.Draggable.withDraggable(boolean)

withResizeListener

public Dialogs.OptionDialogBuilder withResizeListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)

Description copied from interface: Dialogs.Resizable

Adds a listener that is called after user finishes resizing the dialog. It is called only if resizing is enabled (see Dialogs.Resizable.withResizable(boolean)).

Note: By default, the component will sync the width/height and top/left values after every resizing.

Specified by:

withResizeListener in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

listener - the listener to add

Returns:

registration for removal of listener

withResizable

public Dialogs.OptionDialogBuilder withResizable(boolean resizable)

Description copied from interface: Dialogs.Resizable

Sets whether dialog can be resized by user or not.

By default, the dialog is not resizable.

Specified by:

withResizable in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

resizable - true to enabled resizing of the dialog, false otherwise.

Returns:

builder

isResizable

public boolean isResizable()

Specified by:

isResizable in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Returns:

true if resizing is enabled, false otherwise

withMinWidth

public Dialogs.OptionDialogBuilder withMinWidth(String minWidth)

Description copied from interface: Dialogs.Resizable

Sets a dialog min width.

Specified by:

withMinWidth in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

minWidth - a dialog min width

Returns:

builder

getMinWidth

public String getMinWidth()

Specified by:

getMinWidth in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Returns:

dialog min width value

withMinHeight

public Dialogs.OptionDialogBuilder withMinHeight(String minHeight)

Description copied from interface: Dialogs.Resizable

Sets a dialog min height.

Specified by:

withMinHeight in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

minHeight - a dialog min height

Returns:

builder

getMinHeight

public String getMinHeight()

Specified by:

getMinHeight in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Returns:

dialog min height value

withMaxWidth

public Dialogs.OptionDialogBuilder withMaxWidth(String maxWidth)

Description copied from interface: Dialogs.Resizable

Sets a dialog max width.

Specified by:

withMaxWidth in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

maxWidth - a dialog max width

Returns:

builder

getMaxWidth

public String getMaxWidth()

Specified by:

getMaxWidth in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Returns:

dialog max width value

withMaxHeight

public Dialogs.OptionDialogBuilder withMaxHeight(String maxHeight)

Description copied from interface: Dialogs.Resizable

Sets a dialog max height.

Specified by:

withMaxHeight in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Parameters:

maxHeight - a dialog max height

Returns:

builder

getMaxHeight

public String getMaxHeight()

Specified by:

getMaxHeight in interface Dialogs.Resizable<Dialogs.OptionDialogBuilder>

Returns:

dialog max height value

getLeft

public String getLeft()

Description copied from interface: Dialogs.HasPosition

Gets the left position of the dialog.

Specified by:

getLeft in interface Dialogs.HasPosition<Dialogs.OptionDialogBuilder>

Returns:

the left position of the dialog

withLeft

public Dialogs.OptionDialogBuilder withLeft(String left)

Description copied from interface: Dialogs.HasPosition

Sets the distance of the dialog from the left of its container. If a unitless number is provided, pixels are assumed.

Note that the dialog left edge may not be the same as the viewport left edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the left of the viewport).

Specified by:

withLeft in interface Dialogs.HasPosition<Dialogs.OptionDialogBuilder>

Parameters:

left - the left position of the dialog

Returns:

builder

getTop

public String getTop()

Description copied from interface: Dialogs.HasPosition

Gets the top position of the dialog.

Specified by:

getTop in interface Dialogs.HasPosition<Dialogs.OptionDialogBuilder>

Returns:

the top position of the dialog

withTop

public Dialogs.OptionDialogBuilder withTop(String top)

Description copied from interface: Dialogs.HasPosition

Sets the top position of the dialog. If a unitless number is provided, pixels are assumed.

Note that the dialog top edge may not be the same as the viewport top edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the top of the viewport).

Specified by:

withTop in interface Dialogs.HasPosition<Dialogs.OptionDialogBuilder>

Parameters:

top - the top position of the dialog

Returns:

builder

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 - dialog actions

Returns:

builder

getActions

public Action[] getActions()

Specified by:

getActions in interface Dialogs.OptionDialogBuilder

Returns:

dialog actions

build

public com.vaadin.flow.component.dialog.Dialog build()

Description copied from interface: Dialogs.OptionDialogBuilder

Builds option the dialog. Dialog should be shown using Dialog.open().

Specified by:

build in interface Dialogs.OptionDialogBuilder

Returns:

built option dialog

open

public com.vaadin.flow.component.dialog.Dialog open()

Description copied from interface: Dialogs.OptionDialogBuilder

Opens the option dialog.

Specified by:

open in interface Dialogs.OptionDialogBuilder

Returns:

opened Dialog instance

initKeyCombination

protected void initKeyCombination(@Nullable
 DialogAction firstOkAction,
 @Nullable
 DialogAction firstDeclineAction,
 Action action,
 com.vaadin.flow.component.button.Button button)

findFirstActionWithType

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

fireDialogOpenedChangeEvent

protected void fireDialogOpenedChangeEvent(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent openedChangeEvent)