io.jmix.ui.component

Interface DialogWindow

All Superinterfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, ExpandingLayout, Frame, HasComponents, HasMargin, HasSpacing, HasSubParts, OrderedContainer, SupportsExpandRatio, Window

All Known Implementing Classes:

DialogWindowImpl

public interface DialogWindow
extends Window

UI component that represents a dialog window of application.

Nested Class Summary

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
static java.lang.String	NAME Name that is used to register a client type specific screen implementation in UiComponents.

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

Method Summary

Modifier and Type	Method and Description
void	center() Sets this window to be centered on screen.
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()
void	setCloseOnClickOutside(boolean closeOnClickOutside) Sets if window can be closed by click outside of window content (by modality curtain).
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	setModal(boolean modal) Sets window modality.
default void	setPosition(int x, int y) Sets the position of the window on the screen.
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	setWindowMode(WindowMode mode) Sets the mode for the window.

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

addBeforeWindowCloseListener, getContext, getFocusComponent, getFrameOwner, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, isCloseable, setCloseable, 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, setIcon, setIconFromSet

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

getCaption, setCaption

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

getDescription, setDescription

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

getExpandRatio, setExpandRatio

Field Detail

NAME

static final java.lang.String NAME

Name that is used to register a client type specific screen implementation in UiComponents.

See Also:

Constant Field Values

Method Detail

setDialogWidth

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

Sets dialog width.

Parameters:

dialogWidth - width

getDialogWidth

float getDialogWidth()

Returns:

dialog width

getDialogWidthUnit

SizeUnit getDialogWidthUnit()

Returns:

dialog width unit

setDialogHeight

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

Sets dialog height.

Parameters:

dialogHeight - height

getDialogHeight

float getDialogHeight()

Returns:

height

getDialogHeightUnit

SizeUnit getDialogHeightUnit()

Returns:

dialog height unit

setDialogStylename

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

Sets the custom CSS style.

Parameters:

stylename - style name

getDialogStylename

@Nullable
java.lang.String getDialogStylename()

Returns:

custom style name

setResizable

void setResizable(boolean resizable)

Sets window resizable.

Parameters:

resizable - resizable flag

isResizable

boolean isResizable()

Returns:

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

setDraggable

void setDraggable(boolean draggable)

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

Parameters:

draggable - draggable flag

isDraggable

boolean isDraggable()

Returns:

true if window is draggable

setModal

void setModal(boolean modal)

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

Parameters:

modal - modal flag

isModal

boolean isModal()

Returns:

true if window is modal

setCloseOnClickOutside

void setCloseOnClickOutside(boolean closeOnClickOutside)

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

Parameters:

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

isCloseOnClickOutside

boolean isCloseOnClickOutside()

Returns:

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

setWindowMode

void setWindowMode(WindowMode mode)

Sets the mode for the window.

Parameters:

mode - mode

getWindowMode

WindowMode getWindowMode()

Returns:

the mode of the window

center

void center()

Sets this window to be centered on screen.

setPosition

default void setPosition(int x,
                         int y)

Sets the position of the window on the screen.

Parameters:

x - left position in pixels

y - top position in pixels

setPositionX

void setPositionX(int positionX)

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

Parameters:

positionX - left position in pixels

getPositionX

int getPositionX()

Returns:

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

setPositionY

void setPositionY(int positionY)

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

Parameters:

positionY - top position in pixels

getPositionY

int getPositionY()

Returns:

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