io.jmix.ui.component.impl

Class DialogWindowImpl

java.lang.Object

io.jmix.ui.component.impl.WindowImpl

io.jmix.ui.component.impl.DialogWindowImpl

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, DialogWindow, ExpandingLayout, Frame, HasComponents, HasMargin, HasSpacing, HasSubParts, FrameImplementation, WindowImplementation, OrderedContainer, SecuredActionsHolder, SupportsExpandRatio, Window, org.springframework.beans.factory.InitializingBean

public class DialogWindowImpl
extends WindowImpl
implements DialogWindow, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DialogWindowImpl.DialogWindowActionHandler
static class	DialogWindowImpl.GuiDialogWindow

Nested classes/interfaces inherited from interface io.jmix.ui.component.Window

Window.BeforeCloseEvent, Window.CloseOrigin, Window.Committable, Window.ContentSwitchMode, Window.HasUserIndicator, Window.HasWorkArea

Nested classes/interfaces inherited from interface io.jmix.ui.component.ExpandingLayout

ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected JmixWindow	dialogWindow
protected Notifications	notifications
protected UiScreenProperties	screenProperties
protected Screens	screens

Fields inherited from class io.jmix.ui.component.impl.WindowImpl

actionsHolder, actionsPermissions, allComponents, C_WINDOW_LAYOUT, caption, closeable, component, context, defaultScreenWindow, description, element, facets, focusComponentId, frameOwner, icon, icons, id, ownComponents, resolvedState

Fields inherited from interface io.jmix.ui.component.DialogWindow

NAME

Fields inherited from interface io.jmix.ui.component.Window

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, SELECT_ACTION_ID

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
DialogWindowImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	center() Sets this window to be centered on screen.
protected JmixWindow	createComponent()
com.vaadin.ui.Component	getComposition()
float	getDialogHeight()
SizeUnit	getDialogHeightUnit()
java.lang.String	getDialogStylename()
float	getDialogWidth()
SizeUnit	getDialogWidthUnit()
int	getPositionX()
int	getPositionY()
WindowMode	getWindowMode()
boolean	isCloseOnClickOutside()
boolean	isDraggable()
boolean	isModal()
boolean	isResizable()
protected void	onCloseButtonClick(JmixWindow.PreCloseEvent preCloseEvent)
protected void	onCloseShortcutTriggered(java.lang.Object sender, java.lang.Object target)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCaption(java.lang.String caption) Sets the component's caption.
void	setCloseable(boolean closeable) Sets the closable status for the window.
void	setCloseOnClickOutside(boolean closeOnClickOutside) Sets if window can be closed by click outside of window content (by modality curtain).
void	setDescription(java.lang.String description) Sets the component's description.
void	setDialogHeight(java.lang.String dialogHeight) Sets dialog height.
void	setDialogStylename(java.lang.String stylename) Sets the custom CSS style.
void	setDialogWidth(java.lang.String dialogWidth) Sets dialog width.
void	setDraggable(boolean draggable) Enables or disables that a window can be dragged (moved) by the user.
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setModal(boolean modal) Sets window modality.
void	setNotifications(Notifications notifications)
void	setPositionX(int positionX) Sets the distance of Window left border in pixels from left border of the containing (main window).
void	setPositionY(int positionY) Sets the distance of Window top border in pixels from top border of the containing (main window).
void	setResizable(boolean resizable) Sets window resizable.
void	setScreenProperties(UiScreenProperties screenProperties)
void	setScreens(Screens screens)
protected void	setupContextMenu()
protected void	setupDefaultSize()
protected void	setupDialogShortcuts()
void	setWindowMode(WindowMode mode) Sets the mode for the window.

Methods inherited from class io.jmix.ui.component.impl.WindowImpl

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, createLayout, disableEventListeners, enableEventListeners, expand, findAndFocusChildComponent, fireBeforeClose, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getComponent, getComponent, getComponent, getComponents, getComponentToFocus, getContainer, getContext, getDescription, getEventHub, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getId, getMargin, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getRegisteredComponent, getResolvedState, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getXmlDescriptor, handleValidationErrors, indexOf, initUiEventListeners, isCloseable, isDefaultScreenWindow, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isValid, isVisible, isVisibleRecursive, publish, registerComponent, remove, removeAction, removeAction, removeAll, removeAllActions, removeFacet, removeStyleName, resetExpanded, setAlignment, setContext, setDefaultScreenWindow, setEnabled, setExpandRatio, setFocusComponent, setFrame, setFrameOwner, setHeight, setIconFromSet, setIcons, setId, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setResolvedState, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setXmlDescriptor, unregisterComponent, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAll, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.DialogWindow

setPosition

Methods inherited from interface io.jmix.ui.component.Window

addBeforeWindowCloseListener, getContext, getFocusComponent, getFrameOwner, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, isCloseable, setFocusComponent, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, validate, validateAll

Methods inherited from interface io.jmix.ui.component.Frame

addFacet, getFacet, getFacetNN, getFacets, isValid, removeFacet, validate

Methods inherited from interface io.jmix.ui.component.ExpandingLayout

expand, getExpandDirection, isExpanded, resetExpanded

Methods inherited from interface io.jmix.ui.component.OrderedContainer

add, getComponent, getComponentNN, indexOf

Methods inherited from interface io.jmix.ui.component.ComponentContainer

add, add, remove, remove, removeAll

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.HasSpacing

getSpacing, setSpacing

Methods inherited from interface io.jmix.ui.component.HasMargin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface io.jmix.ui.component.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription

Methods inherited from interface io.jmix.ui.component.SupportsExpandRatio

getExpandRatio, setExpandRatio

Field Detail

dialogWindow

protected JmixWindow dialogWindow

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

notifications

protected Notifications notifications

screens

protected Screens screens

screenProperties

protected UiScreenProperties screenProperties

Constructor Detail

DialogWindowImpl

public DialogWindowImpl()

Method Detail

createComponent

protected JmixWindow createComponent()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

setupDefaultSize

protected void setupDefaultSize()

setupContextMenu

protected void setupContextMenu()

setupDialogShortcuts

protected void setupDialogShortcuts()

onCloseButtonClick

protected void onCloseButtonClick(JmixWindow.PreCloseEvent preCloseEvent)

onCloseShortcutTriggered

protected void onCloseShortcutTriggered(java.lang.Object sender,
                                        java.lang.Object target)

setApplicationContext

@Autowired
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

setNotifications

@Autowired
public void setNotifications(Notifications notifications)

setScreens

@Autowired
public void setScreens(Screens screens)

setScreenProperties

@Autowired
public void setScreenProperties(UiScreenProperties screenProperties)

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

Overrides:

setIcon in class WindowImpl

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Overrides:

setCaption in class WindowImpl

Parameters:

caption - the new component's caption

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Overrides:

setDescription in class WindowImpl

Parameters:

description - the new description to set

getComposition

public com.vaadin.ui.Component getComposition()

Specified by:

getComposition in interface Component.Wrapper

Overrides:

getComposition in class WindowImpl

setDialogWidth

public void setDialogWidth(@Nullable
                           java.lang.String dialogWidth)

Description copied from interface: DialogWindow

Sets dialog width.

Specified by:

setDialogWidth in interface DialogWindow

Parameters:

dialogWidth - width

getDialogWidth

public float getDialogWidth()

Specified by:

getDialogWidth in interface DialogWindow

Returns:

dialog width

getDialogWidthUnit

public SizeUnit getDialogWidthUnit()

Specified by:

getDialogWidthUnit in interface DialogWindow

Returns:

dialog width unit

setDialogHeight

public void setDialogHeight(@Nullable
                            java.lang.String dialogHeight)

Description copied from interface: DialogWindow

Sets dialog height.

Specified by:

setDialogHeight in interface DialogWindow

Parameters:

dialogHeight - height

getDialogHeight

public float getDialogHeight()

Specified by:

getDialogHeight in interface DialogWindow

Returns:

height

getDialogHeightUnit

public SizeUnit getDialogHeightUnit()

Specified by:

getDialogHeightUnit in interface DialogWindow

Returns:

dialog height unit

setDialogStylename

public void setDialogStylename(@Nullable
                               java.lang.String stylename)

Description copied from interface: DialogWindow

Sets the custom CSS style.

Specified by:

setDialogStylename in interface DialogWindow

Parameters:

stylename - style name

getDialogStylename

@Nullable
public java.lang.String getDialogStylename()

Specified by:

getDialogStylename in interface DialogWindow

Returns:

custom style name

setResizable

public void setResizable(boolean resizable)

Description copied from interface: DialogWindow

Sets window resizable.

Specified by:

setResizable in interface DialogWindow

Parameters:

resizable - resizable flag

isResizable

public boolean isResizable()

Specified by:

isResizable in interface DialogWindow

Returns:

true if window is resizable by the end-user, otherwise false.

setDraggable

public void setDraggable(boolean draggable)

Description copied from interface: DialogWindow

Enables or disables that a window can be dragged (moved) by the user. By default a window is draggable.

Specified by:

setDraggable in interface DialogWindow

Parameters:

draggable - draggable flag

isDraggable

public boolean isDraggable()

Specified by:

isDraggable in interface DialogWindow

Returns:

true if window is draggable

setCloseable

public void setCloseable(boolean closeable)

Description copied from interface: Window

Sets the closable status for the window.

Specified by:

setCloseable in interface Window

Overrides:

setCloseable in class WindowImpl

Parameters:

closeable - closeable flag

setModal

public void setModal(boolean modal)

Description copied from interface: DialogWindow

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

Specified by:

setModal in interface DialogWindow

Parameters:

modal - modal flag

isModal

public boolean isModal()

Specified by:

isModal in interface DialogWindow

Returns:

true if window is modal

setCloseOnClickOutside

public void setCloseOnClickOutside(boolean closeOnClickOutside)

Description copied from interface: DialogWindow

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

Specified by:

setCloseOnClickOutside in interface DialogWindow

Parameters:

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

isCloseOnClickOutside

public boolean isCloseOnClickOutside()

Specified by:

isCloseOnClickOutside in interface DialogWindow

Returns:

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

setWindowMode

public void setWindowMode(WindowMode mode)

Description copied from interface: DialogWindow

Sets the mode for the window.

Specified by:

setWindowMode in interface DialogWindow

Parameters:

mode - mode

getWindowMode

public WindowMode getWindowMode()

Specified by:

getWindowMode in interface DialogWindow

Returns:

the mode of the window

center

public void center()

Description copied from interface: DialogWindow

Sets this window to be centered on screen.

Specified by:

center in interface DialogWindow

setPositionX

public void setPositionX(int positionX)

Description copied from interface: DialogWindow

Sets the distance of Window left border in pixels from left border of the containing (main window).

Specified by:

setPositionX in interface DialogWindow

Parameters:

positionX - left position in pixels

getPositionX

public int getPositionX()

Specified by:

getPositionX in interface DialogWindow

Returns:

the distance of Window left border in pixels from left border of the containing (main window) or -1 if unspecified

setPositionY

public void setPositionY(int positionY)

Description copied from interface: DialogWindow

Sets the distance of Window top border in pixels from top border of the containing (main window).

Specified by:

setPositionY in interface DialogWindow

Parameters:

positionY - top position in pixels

getPositionY

public int getPositionY()

Specified by:

getPositionY in interface DialogWindow

Returns:

distance of Window top border in pixels from top border of the containing (main window) or -1 if unspecified