Package io.jmix.flowui.impl

Class DialogsImpl.SideDialogBuilderImpl

java.lang.Object

io.jmix.flowui.impl.DialogsImpl.SideDialogBuilderImpl

All Implemented Interfaces:

Dialogs.Closeable<Dialogs.SideDialogBuilder>, Dialogs.HasHeader<Dialogs.SideDialogBuilder>, Dialogs.HasStyle<Dialogs.SideDialogBuilder>, Dialogs.SideDialogBuilder

Enclosing class:

DialogsImpl

public class DialogsImpl.SideDialogBuilderImpl
extends Object
implements Dialogs.SideDialogBuilder

Implementation of Dialogs.SideDialogBuilder that facilitates creating and managing SideDialogs.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Consumer<SideDialog>>	componentConsumers
protected List<com.vaadin.flow.component.Component>	contentComponents
protected List<com.vaadin.flow.component.Component>	footerComponents
protected List<com.vaadin.flow.component.Component>	headerComponents
protected SideDialog	sideDialog

Constructor Summary

Constructors

Constructor	Description
SideDialogBuilderImpl()

Method Summary

Modifier and Type	Method	Description
SideDialog	build()	Builds the dialog.
protected List<com.vaadin.flow.component.Component>	contentComponents()
protected SideDialog	createSideDialog()
protected void	fireDialogOpenedChangeEvent(SideDialogOpenedChangeEvent openedChangeEvent)
protected List<com.vaadin.flow.component.Component>	footerComponents()
String	getClassName()	Gets the CSS class names for this component.
String	getHeader()
String	getHorizontalMaxSize()
String	getHorizontalMinSize()
String	getHorizontalSize()
String	getOverlayRole()
SideDialogPosition	getSideDialogPosition()
String	getVerticalMaxSize()
String	getVerticalMinSize()
String	getVerticalSize()
protected List<com.vaadin.flow.component.Component>	headerComponents()
protected void	initDialog(SideDialog dialog)
boolean	isCloseOnEsc()
boolean	isCloseOnOutsideClick()
boolean	isFullscreenOnSmallDevices()
boolean	isModal()
SideDialog	open()	Opens the dialog.
Dialogs.SideDialogBuilder	withClassName(String className)	Sets the CSS class names of this component.
Dialogs.SideDialogBuilder	withCloseActionListener(com.vaadin.flow.component.ComponentEventListener<SideDialogCloseActionEvent> listener)	Sets a listener for the close action event of the dialog.
Dialogs.SideDialogBuilder	withCloseOnEsc(boolean closeOnEsc)	Sets whether this dialog can be closed by hitting the esc-key or not.
Dialogs.SideDialogBuilder	withCloseOnOutsideClick(boolean closeOnOutsideClick)	Sets whether this dialog can be closed by clicking outside.
Dialogs.SideDialogBuilder	withContentComponents(com.vaadin.flow.component.Component... components)	Adds components to the footer of the dialog.
Dialogs.SideDialogBuilder	withContentProvider(Function<SideDialog,com.vaadin.flow.component.Component> contentProvider)	Sets a provider for the content component of the dialog.
Dialogs.SideDialogBuilder	withFooterComponents(com.vaadin.flow.component.Component... components)	Adds components to the footer of the dialog.
Dialogs.SideDialogBuilder	withFooterProvider(Function<SideDialog,com.vaadin.flow.component.Component> footerProvider)	Sets a provider for the footer component of the dialog.
Dialogs.SideDialogBuilder	withFullscreenOnSmallDevices(boolean fullscreen)	Sets the fullscreen mode on small devices.
Dialogs.SideDialogBuilder	withHeader(String header)	Sets a header text.
Dialogs.SideDialogBuilder	withHeaderComponents(com.vaadin.flow.component.Component... components)	Adds components to the header of the dialog.
Dialogs.SideDialogBuilder	withHeaderProvider(Function<SideDialog,com.vaadin.flow.component.Component> headerProvider)	Sets a provider for the header component of the dialog.
Dialogs.SideDialogBuilder	withHorizontalMaxSize(String value)	Sets the horizontal max size of the dialog.
Dialogs.SideDialogBuilder	withHorizontalMinSize(String value)	Sets the horizontal min size of the dialog.
Dialogs.SideDialogBuilder	withHorizontalSize(String value)	Sets the horizontal size of the dialog.
Dialogs.SideDialogBuilder	withModal(boolean modal)	Sets whether the dialog should be modal.
Dialogs.SideDialogBuilder	withOpenedChangeListener(com.vaadin.flow.component.ComponentEventListener<SideDialogOpenedChangeEvent> listener)	Sets a listener for the opened change event of the dialog.
Dialogs.SideDialogBuilder	withOverlayRole(String role)	Sets the overlay role of the dialog.
Dialogs.SideDialogBuilder	withSideDialogPosition(SideDialogPosition position)	Sets the position of the dialog.
Dialogs.SideDialogBuilder	withVerticalMaxSize(String value)	Sets the vertical max size of the dialog.
Dialogs.SideDialogBuilder	withVerticalMinSize(String value)	Sets the vertical min size of the dialog.
Dialogs.SideDialogBuilder	withVerticalSize(String value)	Sets the vertical size of the dialog.

Methods inherited from class java.lang.Object

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

Field Details

sideDialog

protected SideDialog sideDialog

componentConsumers

protected List<Consumer<SideDialog>> componentConsumers

headerComponents

protected List<com.vaadin.flow.component.Component> headerComponents

contentComponents

protected List<com.vaadin.flow.component.Component> contentComponents

footerComponents

protected List<com.vaadin.flow.component.Component> footerComponents

Constructor Details

SideDialogBuilderImpl

public SideDialogBuilderImpl()

Method Details

withHeaderComponents

public Dialogs.SideDialogBuilder withHeaderComponents(com.vaadin.flow.component.Component... components)

Description copied from interface: Dialogs.SideDialogBuilder

Adds components to the header of the dialog.

Specified by:

withHeaderComponents in interface Dialogs.SideDialogBuilder

Parameters:

components - components to add

Returns:

builder

withHeaderProvider

public Dialogs.SideDialogBuilder withHeaderProvider(Function<SideDialog,com.vaadin.flow.component.Component> headerProvider)

Description copied from interface: Dialogs.SideDialogBuilder

Sets a provider for the header component of the dialog. The components from the provider are added to the header of the dialog. If the provider returns null, no components are added.

Usage example:

 @Autowired
 private Dialogs dialogs;
 @Autowired
 private UiComponents uiComponents;

 @Subscribe
 public void onInit(final InitEvent event) {
     dialogs.createSideDialog()
             .withHeaderProvider((sideDialog) -> {
                 HorizontalLayout layout = new HorizontalLayout();
                 layout.add(new H2("User profile"));

                 JmixButton closeButton = uiComponents.create(JmixButton.class);
                 closeButton.setIcon(JmixFontIcon.CLOSE.create());
                 closeButton.addThemeVariants(ButtonVariant.LUMO_TERTIARY_INLINE);
                 closeButton.addClickListener(__ -> sideDialog.close());

                 layout.add(closeButton);
                 return layout;
             })
             .withContentComponents(createContent())
             .withSideDialogPosition(SideDialogPosition.LEFT)
             .open();
 }
 

Specified by:

withHeaderProvider in interface Dialogs.SideDialogBuilder

Parameters:

headerProvider - provider for the header component

Returns:

builder

withContentComponents

public Dialogs.SideDialogBuilder withContentComponents(com.vaadin.flow.component.Component... components)

Description copied from interface: Dialogs.SideDialogBuilder

Adds components to the footer of the dialog.

Specified by:

withContentComponents in interface Dialogs.SideDialogBuilder

Parameters:

components - components to add

Returns:

builder

withContentProvider

public Dialogs.SideDialogBuilder withContentProvider(Function<SideDialog,com.vaadin.flow.component.Component> contentProvider)

Description copied from interface: Dialogs.SideDialogBuilder

Sets a provider for the content component of the dialog. The components from the provider are added to the content area of the dialog. If the provider returns null, no components are added.

Usage example:

 @Autowired
 private Dialogs dialogs;
 @Autowired
 private UiComponents uiComponents;

 @Subscribe("usersDataGrid")
 public void onUsersDataGridItemDoubleClick(final ItemDoubleClickEvent<User> event) {
     User user = event.getItem();
     dialogs.createSideDialog()
             .withHeaderProvider(this::createHeader)
             .withContentProvider(sideDialog -> {
                 FormLayout formLayout = uiComponents.create(FormLayout.class);

                 TypedTextField<String> usernameField = uiComponents.create(TypedTextField.class);
                 usernameField.setValue(user.getUsername());
                 usernameField.setReadOnly(true);
                 formLayout.addFormItem(usernameField, "Username");

                 JmixEmailField emailField = uiComponents.create(JmixEmailField.class);
                 emailField.setValue(Strings.nullToEmpty(user.getEmail()));
                 emailField.setReadOnly(true);
                 formLayout.addFormItem(emailField, "Email");

                 return formLayout;
             }).open();
 }
 

Specified by:

withContentProvider in interface Dialogs.SideDialogBuilder

Parameters:

contentProvider - provider for the content component

Returns:

builder

withFooterComponents

public Dialogs.SideDialogBuilder withFooterComponents(com.vaadin.flow.component.Component... components)

Description copied from interface: Dialogs.SideDialogBuilder

Adds components to the footer of the dialog.

Specified by:

withFooterComponents in interface Dialogs.SideDialogBuilder

Parameters:

components - components to add

Returns:

builder

withFooterProvider

public Dialogs.SideDialogBuilder withFooterProvider(Function<SideDialog,com.vaadin.flow.component.Component> footerProvider)

Description copied from interface: Dialogs.SideDialogBuilder

Sets a provider for the footer component of the dialog. The components from the provider are added to the footer of the dialog. If the provider returns null, no components are added.

Usage example:

 @Autowired
 private Dialogs dialogs;
 @Autowired
 private UiComponents uiComponents;

 @Subscribe
 public void onInit(final InitEvent event) {
     dialogs.createSideDialog()
             .withHeaderProvider(this::createHeader)
             .withContentComponents(createContent())
             .withFooterProvider(sideDialog -> {
                 JmixButton okButton = uiComponents.create(JmixButton.class);
                 okButton.addClickListener(__ -> sideDialog.close());

                 HorizontalLayout layout = new HorizontalLayout();
                 layout.add(okButton);
                 return layout;
             })
             .withSideDialogPosition(SideDialogPosition.LEFT)
             .open();
 }
 

Specified by:

withFooterProvider in interface Dialogs.SideDialogBuilder

Parameters:

footerProvider - provider for the footer component

Returns:

builder

withOpenedChangeListener

public Dialogs.SideDialogBuilder withOpenedChangeListener(com.vaadin.flow.component.ComponentEventListener<SideDialogOpenedChangeEvent> listener)

Description copied from interface: Dialogs.SideDialogBuilder

Sets a listener for the opened change event of the dialog.

Specified by:

withOpenedChangeListener in interface Dialogs.SideDialogBuilder

Parameters:

listener - listener for the opened change event

Returns:

builder

withCloseActionListener

public Dialogs.SideDialogBuilder withCloseActionListener(com.vaadin.flow.component.ComponentEventListener<SideDialogCloseActionEvent> listener)

Description copied from interface: Dialogs.SideDialogBuilder

Sets a listener for the close action event of the dialog.

Specified by:

withCloseActionListener in interface Dialogs.SideDialogBuilder

Parameters:

listener - listener for the close action event

Returns:

builder

getHorizontalSize

@Nullable
public String getHorizontalSize()

Specified by:

getHorizontalSize in interface Dialogs.SideDialogBuilder

Returns:

horizontal size of the dialog or null if not set

See Also:

• JmixSideDialog.getHorizontalSize()

withHorizontalSize

public Dialogs.SideDialogBuilder withHorizontalSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the horizontal size of the dialog.

Specified by:

withHorizontalSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the width of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setHorizontalSize(String)

getHorizontalMaxSize

@Nullable
public String getHorizontalMaxSize()

Specified by:

getHorizontalMaxSize in interface Dialogs.SideDialogBuilder

Returns:

horizontal max size of the dialog or null if not set

See Also:

• JmixSideDialog.getHorizontalMaxSize()

withHorizontalMaxSize

public Dialogs.SideDialogBuilder withHorizontalMaxSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the horizontal max size of the dialog.

Specified by:

withHorizontalMaxSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the maximum width of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setHorizontalMaxSize(String)

getHorizontalMinSize

@Nullable
public String getHorizontalMinSize()

Specified by:

getHorizontalMinSize in interface Dialogs.SideDialogBuilder

Returns:

horizontal min size of the dialog or null if not set

See Also:

• JmixSideDialog.getHorizontalMinSize()

withHorizontalMinSize

@Nullable
public Dialogs.SideDialogBuilder withHorizontalMinSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the horizontal min size of the dialog.

Specified by:

withHorizontalMinSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the minimum width of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setHorizontalMinSize(String)

getVerticalSize

@Nullable
public String getVerticalSize()

Specified by:

getVerticalSize in interface Dialogs.SideDialogBuilder

Returns:

vertical size of the dialog or null if not set

See Also:

• JmixSideDialog.getVerticalSize()

withVerticalSize

public Dialogs.SideDialogBuilder withVerticalSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the vertical size of the dialog.

Specified by:

withVerticalSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the height of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setVerticalSize(String)

getVerticalMaxSize

@Nullable
public String getVerticalMaxSize()

Specified by:

getVerticalMaxSize in interface Dialogs.SideDialogBuilder

Returns:

vertical max size of the dialog or null if not set

See Also:

• JmixSideDialog.getVerticalMaxSize()

withVerticalMaxSize

public Dialogs.SideDialogBuilder withVerticalMaxSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the vertical max size of the dialog.

Specified by:

withVerticalMaxSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the maximum height of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setVerticalMaxSize(String)

getVerticalMinSize

@Nullable
public String getVerticalMinSize()

Specified by:

getVerticalMinSize in interface Dialogs.SideDialogBuilder

Returns:

vertical min size of the dialog or null if not set

See Also:

• JmixSideDialog.getVerticalMinSize()

withVerticalMinSize

public Dialogs.SideDialogBuilder withVerticalMinSize(@Nullable
 String value)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the vertical min size of the dialog.

Specified by:

withVerticalMinSize in interface Dialogs.SideDialogBuilder

Parameters:

value - the minimum height of the dialog

Returns:

builder

See Also:

• JmixSideDialog.setVerticalMinSize(String)

isFullscreenOnSmallDevices

public boolean isFullscreenOnSmallDevices()

Specified by:

isFullscreenOnSmallDevices in interface Dialogs.SideDialogBuilder

Returns:

true if the dialog is fullscreen on small devices, false otherwise

withFullscreenOnSmallDevices

public Dialogs.SideDialogBuilder withFullscreenOnSmallDevices(boolean fullscreen)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the fullscreen mode on small devices.

Specified by:

withFullscreenOnSmallDevices in interface Dialogs.SideDialogBuilder

Parameters:

fullscreen - fullscreen option

Returns:

builder

See Also:

• JmixSideDialog.setFullscreenOnSmallDevices(boolean)

getSideDialogPosition

public SideDialogPosition getSideDialogPosition()

Specified by:

getSideDialogPosition in interface Dialogs.SideDialogBuilder

Returns:

position of the dialog

withSideDialogPosition

public Dialogs.SideDialogBuilder withSideDialogPosition(SideDialogPosition position)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the position of the dialog.

Specified by:

withSideDialogPosition in interface Dialogs.SideDialogBuilder

Parameters:

position - position of the dialog

Returns:

builder

getOverlayRole

@Nullable
public String getOverlayRole()

Specified by:

getOverlayRole in interface Dialogs.SideDialogBuilder

Returns:

overlay role of the dialog or null if not set

withOverlayRole

public Dialogs.SideDialogBuilder withOverlayRole(String role)

Description copied from interface: Dialogs.SideDialogBuilder

Sets the overlay role of the dialog.

Specified by:

withOverlayRole in interface Dialogs.SideDialogBuilder

Parameters:

role - role to set

Returns:

builder

isModal

public boolean isModal()

Specified by:

isModal in interface Dialogs.SideDialogBuilder

Returns:

true if the dialog is modal, false otherwise

withModal

public Dialogs.SideDialogBuilder withModal(boolean modal)

Description copied from interface: Dialogs.SideDialogBuilder

Sets whether the dialog should be modal.

Specified by:

withModal in interface Dialogs.SideDialogBuilder

Parameters:

modal - modal option

Returns:

builder

open

public SideDialog open()

Description copied from interface: Dialogs.SideDialogBuilder

Opens the dialog.

Specified by:

open in interface Dialogs.SideDialogBuilder

Returns:

opened dialog

build

public SideDialog build()

Description copied from interface: Dialogs.SideDialogBuilder

Builds the dialog.

Specified by:

build in interface Dialogs.SideDialogBuilder

Returns:

created dialog

isCloseOnOutsideClick

public boolean isCloseOnOutsideClick()

Specified by:

isCloseOnOutsideClick in interface Dialogs.Closeable<Dialogs.SideDialogBuilder>

Returns:

true if this dialog can be closed by an outside click, false otherwise

withCloseOnOutsideClick

public Dialogs.SideDialogBuilder withCloseOnOutsideClick(boolean closeOnOutsideClick)

Description copied from interface: Dialogs.Closeable

Sets whether this dialog can be closed by clicking outside.

By default, the dialog is closable with an outside click.

Specified by:

withCloseOnOutsideClick in interface Dialogs.Closeable<Dialogs.SideDialogBuilder>

Parameters:

closeOnOutsideClick - true to enable closing this dialog with an outside click, false to disable it

Returns:

builder

isCloseOnEsc

public boolean isCloseOnEsc()

Specified by:

isCloseOnEsc in interface Dialogs.Closeable<Dialogs.SideDialogBuilder>

Returns:

true if this dialog can be closed with the esc-key, false otherwise

withCloseOnEsc

public Dialogs.SideDialogBuilder withCloseOnEsc(boolean closeOnEsc)

Description copied from interface: Dialogs.Closeable

Sets whether this dialog can be closed by hitting the esc-key or not.

By default, the dialog is closable with esc.

Specified by:

withCloseOnEsc in interface Dialogs.Closeable<Dialogs.SideDialogBuilder>

Parameters:

closeOnEsc - true to enable closing this dialog with the esc-key, false to disable it

Returns:

builder

withHeader

public Dialogs.SideDialogBuilder withHeader(String header)

Description copied from interface: Dialogs.HasHeader

Sets a header text.

Specified by:

withHeader in interface Dialogs.HasHeader<Dialogs.SideDialogBuilder>

Parameters:

header - header text

Returns:

builder

getHeader

@Nullable
public String getHeader()

Specified by:

getHeader in interface Dialogs.HasHeader<Dialogs.SideDialogBuilder>

Returns:

header text

withClassName

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

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.SideDialogBuilder>

Returns:

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

createSideDialog

protected SideDialog createSideDialog()

initDialog

protected void initDialog(SideDialog dialog)

headerComponents

protected List<com.vaadin.flow.component.Component> headerComponents()

contentComponents

protected List<com.vaadin.flow.component.Component> contentComponents()

footerComponents

protected List<com.vaadin.flow.component.Component> footerComponents()

fireDialogOpenedChangeEvent

protected void fireDialogOpenedChangeEvent(SideDialogOpenedChangeEvent openedChangeEvent)