io.jmix.ui.component

Interface Window

All Superinterfaces:

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

All Known Subinterfaces:

DialogWindow, RootWindow, TabWindow, WindowImplementation

All Known Implementing Classes:

DialogWindowImpl, RootWindowImpl, TabWindowImpl, WindowImpl

public interface Window
extends Frame, Component.HasCaption, Component.HasIcon

Represents an independent window of application.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Window.BeforeCloseEvent Event sent right before the window is closed by an external (relative to the window content) action, like the button in the window tab or by the Esc keyboard shortcut.
static interface	Window.CloseOrigin Marker interface for all window close types, which describes the way a window was closed.
static interface	Window.Committable Represents a window that can be committed on close.
static class	Window.ContentSwitchMode Defines how the managed main TabSheet switches a tab with the given window: hides or unloads its content.
static interface	Window.HasUserIndicator Window having a user indicator.
static interface	Window.HasWorkArea Window having a work area.

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	BROWSE_WINDOW_SUFFIX
static java.lang.String	CLOSE_ACTION_ID Constant that should be passed to Screen.close(CloseAction) methods when the screen is closed without commit.
static java.lang.String	COMMIT_ACTION_ID Constant that should be passed to Screen.close(CloseAction) methods when the screen is closed after commit of changes.
static java.lang.String	CREATE_WINDOW_SUFFIX
static java.lang.String	EDITOR_WINDOW_SUFFIX
static java.lang.String	LOOKUP_WINDOW_SUFFIX
static java.lang.String	SELECT_ACTION_ID Constant that passed to Screen.close(CloseAction) method when the lookup screen is closed with selected items.

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addBeforeWindowCloseListener(java.util.function.Consumer<Window.BeforeCloseEvent> listener) Registers a new before window close listener.
WindowContext	getContext()
java.lang.String	getFocusComponent()
Screen	getFrameOwner()
java.lang.String	getMaxHeight()
java.lang.String	getMaxWidth()
java.lang.String	getMinHeight()
java.lang.String	getMinWidth()
boolean	isCloseable()
void	setCloseable(boolean closeable) Sets the closable status for the window.
void	setFocusComponent(java.lang.String componentId) Sets a component to be focused after the screen is opened.
void	setMaxHeight(java.lang.String maxHeight) Sets maximum CSS height for window layout.
void	setMaxWidth(java.lang.String maxWidth) Sets maximum CSS width for window layout.
void	setMinHeight(java.lang.String minHeight) Sets minimum CSS height for window layout.
void	setMinWidth(java.lang.String minWidth) Sets minimum CSS width for window layout.
boolean	validate(java.util.List<Validatable> fields) Checks validity by invoking validators on specified components which support them and show validation result notification.
boolean	validateAll() Checks validity by invoking validators on all components which support them and show validation result notification.

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

COMMIT_ACTION_ID

static final java.lang.String COMMIT_ACTION_ID

Constant that should be passed to Screen.close(CloseAction) methods when the screen is closed after commit of changes. Propagated to Screen.AfterCloseEvent listeners.

See Also:

Constant Field Values

CLOSE_ACTION_ID

static final java.lang.String CLOSE_ACTION_ID

Constant that should be passed to Screen.close(CloseAction) methods when the screen is closed without commit. Propagated to Screen.AfterCloseEvent listeners.

See Also:

Constant Field Values

SELECT_ACTION_ID

static final java.lang.String SELECT_ACTION_ID

Constant that passed to Screen.close(CloseAction) method when the lookup screen is closed with selected items. Propagated to Screen.AfterCloseEvent listeners.

See Also:

Constant Field Values

BROWSE_WINDOW_SUFFIX

static final java.lang.String BROWSE_WINDOW_SUFFIX

See Also:

Constant Field Values

LOOKUP_WINDOW_SUFFIX

static final java.lang.String LOOKUP_WINDOW_SUFFIX

See Also:

Constant Field Values

EDITOR_WINDOW_SUFFIX

static final java.lang.String EDITOR_WINDOW_SUFFIX

See Also:

Constant Field Values

CREATE_WINDOW_SUFFIX

static final java.lang.String CREATE_WINDOW_SUFFIX

See Also:

Constant Field Values

Method Detail

setCloseable

void setCloseable(boolean closeable)

Sets the closable status for the window.

Parameters:

closeable - closeable flag

isCloseable

boolean isCloseable()

Returns:

true if the window can be closed by user with close button or keyboard shortcut

setMinWidth

void setMinWidth(java.lang.String minWidth)

Sets minimum CSS width for window layout. Examples: "640px", "auto".

Parameters:

minWidth - minimum width

getMinWidth

@Nullable
java.lang.String getMinWidth()

Returns:

previously set minimal CSS width or null

setMaxWidth

void setMaxWidth(java.lang.String maxWidth)

Sets maximum CSS width for window layout. Examples: "640px", "100%".

Parameters:

maxWidth - maximum width

getMaxWidth

@Nullable
java.lang.String getMaxWidth()

Returns:

previously set maximum CSS width or null

setMinHeight

void setMinHeight(java.lang.String minHeight)

Sets minimum CSS height for window layout. Examples: "640px", "auto".

Parameters:

minHeight - minimum height

getMinHeight

@Nullable
java.lang.String getMinHeight()

Returns:

previously set minimum CSS height or null

setMaxHeight

void setMaxHeight(java.lang.String maxHeight)

Sets maximum CSS height for window layout. Examples: "640px", "100%".

Parameters:

maxHeight - maximum height

getMaxHeight

@Nullable
java.lang.String getMaxHeight()

Returns:

previously set maximum CSS height or null

getFrameOwner

Screen getFrameOwner()

Specified by:

getFrameOwner in interface Frame

Returns:

UI controller of the window

See Also:

Screen, ScreenFragment

getContext

WindowContext getContext()

Specified by:

getContext in interface Frame

Returns:

current window context

setFocusComponent

void setFocusComponent(@Nullable
                       java.lang.String componentId)

Sets a component to be focused after the screen is opened.

Parameters:

componentId - component's ID in XML. If null, then first focusable component will be focused

getFocusComponent

@Nullable
java.lang.String getFocusComponent()

Returns:

an ID of the component which is set to be focused after the screen is opened

validate

boolean validate(java.util.List<Validatable> fields)

Checks validity by invoking validators on specified components which support them and show validation result notification.

Specified by:

validate in interface Frame

Returns:

true if the validation was successful, false if there were any problems

validateAll

boolean validateAll()

Checks validity by invoking validators on all components which support them and show validation result notification.

Specified by:

validateAll in interface Frame

Returns:

true if the validation was successful, false if there were any problems

addBeforeWindowCloseListener

io.jmix.core.common.event.Subscription addBeforeWindowCloseListener(java.util.function.Consumer<Window.BeforeCloseEvent> listener)

Registers a new before window close listener.

Parameters:

listener - the listener to register

Returns:

a registration object for removing an event listener added to a window