com.haulmont.cuba.gui.components

Interface Window

All Superinterfaces:

io.jmix.ui.component.ActionsHolder, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.ComponentContainer, io.jmix.ui.component.ExpandingLayout, io.jmix.ui.component.Frame, io.jmix.ui.component.HasComponents, io.jmix.ui.component.HasMargin, io.jmix.ui.component.HasSpacing, io.jmix.ui.component.HasSubParts, HasWindowManager, io.jmix.ui.component.OrderedContainer, io.jmix.ui.component.SupportsExpandRatio, io.jmix.ui.component.Window

All Known Subinterfaces:

Window.Editor<T>, Window.Lookup<T>

All Known Implementing Classes:

AbstractEditor, AbstractLookup, EntityCombinedScreen, ScheduledTaskEditor, ScreenEditorWrapper, ScreenLookupWrapper

Deprecated.

Use Window instead

@Deprecated
public interface Window
extends io.jmix.ui.component.Window, Frame

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Window.BeforeCloseWithCloseButtonEvent Deprecated. Use BeforeCloseEvent with CloseOrigin
static class	Window.BeforeCloseWithShortcutEvent Deprecated. Use BeforeCloseEvent with CloseOrigin
static interface	Window.CloseListener Deprecated. Use Screen.addAfterCloseListener(Consumer) instead
static interface	Window.CloseWithCommitListener Deprecated. Use Screen.addAfterCloseListener(Consumer) instead
static interface	Window.Editor<T> Deprecated.
static interface	Window.HasFoldersPane Deprecated.
static interface	Window.Lookup<T> Deprecated.
static interface	Window.TopLevelWindow Deprecated. Is not required for screen controllers anymore
static interface	Window.Wrapper Deprecated.

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

io.jmix.ui.component.Window.BeforeCloseEvent, io.jmix.ui.component.Window.CloseOrigin, io.jmix.ui.component.Window.Committable, io.jmix.ui.component.Window.ContentSwitchMode, io.jmix.ui.component.Window.HasUserIndicator, io.jmix.ui.component.Window.HasWorkArea

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

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

io.jmix.ui.component.ExpandingLayout.ExpandDirection

Field Summary

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

Method Summary

Modifier and Type	Method and Description
default void	addBeforeCloseWithCloseButtonListener(java.util.function.Consumer<Window.BeforeCloseWithCloseButtonEvent> listener) Deprecated.
default void	addBeforeCloseWithShortcutListener(java.util.function.Consumer<Window.BeforeCloseWithShortcutEvent> listener) Deprecated.
default void	addCloseListener(Window.CloseListener listener) Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.
default void	addListener(Window.CloseListener listener) Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.
default boolean	close(java.lang.String actionId) Deprecated.
default boolean	close(java.lang.String actionId, boolean force) Deprecated.
WindowContext	getContext() Deprecated.
DialogOptions	getDialogOptions() Deprecated. Cast a window instance to DialogWindow
WindowManager	getWindowManager() Deprecated. Use Screens and Notifications instead.
default void	removeBeforeCloseWithCloseButtonListener(java.util.function.Consumer<Window.BeforeCloseWithCloseButtonEvent> listener) Deprecated.
default void	removeBeforeCloseWithShortcutListener(java.util.function.Consumer<Window.BeforeCloseWithShortcutEvent> listener) Deprecated.
default void	removeBeforeWindowCloseListener(java.util.function.Consumer<io.jmix.ui.component.Window.BeforeCloseEvent> listener) Deprecated. Use Subscription instead
default void	removeCloseListener(Window.CloseListener listener) Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.
default void	removeListener(Window.CloseListener listener) Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.

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

addBeforeWindowCloseListener, 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.OrderedContainer

add, getComponent, getComponentNN, indexOf

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

getExpandRatio, setExpandRatio

Methods inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

expand

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

expand, getExpandDirection, isExpanded, resetExpanded

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

add, add, remove, remove, removeAll

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

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

Methods inherited from interface com.haulmont.cuba.gui.components.HasWindowManager

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Method Detail

getContext

WindowContext getContext()

Deprecated.

Specified by:

getContext in interface io.jmix.ui.component.Frame

Specified by:

getContext in interface io.jmix.ui.component.Window

close

@Deprecated
default boolean close(java.lang.String actionId,
                                  boolean force)

Deprecated.

Closes the screen.
If the window has uncommitted changes in its DsContext, and force=false, the confirmation dialog will be shown.

Parameters:

actionId - action ID that will be propagated to attached Window.CloseListeners. Use Window.COMMIT_ACTION_ID if some changes have just been committed, or Window.CLOSE_ACTION_ID otherwise. These constants are recognized by various mechanisms of the framework.

force - if true, no confirmation dialog will be shown even if the screen has uncommitted changes

close

@Deprecated
default boolean close(java.lang.String actionId)

Deprecated.

Closes the screen.
If the screen has uncommitted changes in its DsContext, the confirmation dialog will be shown.
Don't override this method in subclasses, use hook AbstractWindow.preClose(String)

Parameters:

actionId - action ID that will be propagated to attached Window.CloseListeners. Use Window.COMMIT_ACTION_ID if some changes have just been committed, or Window.CLOSE_ACTION_ID otherwise. These constants are recognized by various mechanisms of the framework.

getWindowManager

@Deprecated
WindowManager getWindowManager()

Deprecated. Use Screens and Notifications instead.

Description copied from interface: HasWindowManager

It is recommended to use Screens instead, it can be obtained from ScreenContext of FrameOwner.

Specified by:

getWindowManager in interface HasWindowManager

Returns:

window manager instance

getDialogOptions

@Deprecated
DialogOptions getDialogOptions()

Deprecated. Cast a window instance to DialogWindow

Returns:

dialog options of window. Options will be applied only if window opened with OpenMode.DIALOG

addListener

@Deprecated
default void addListener(Window.CloseListener listener)

Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.

Adds a listener that will be notified when this screen is closed.

Parameters:

listener - listener instance

removeListener

@Deprecated
default void removeListener(Window.CloseListener listener)

Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.

Removes a previously registered CloseListener.

Parameters:

listener - the listener to remove

addCloseListener

@Deprecated
default void addCloseListener(Window.CloseListener listener)

Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.

Addы a listener that will be notified when this screen is closed.

Parameters:

listener - listener instance

removeCloseListener

@Deprecated
default void removeCloseListener(Window.CloseListener listener)

Deprecated. Use Screen.addAfterCloseListener(Consumer) instead.

Removes a previously registered CloseListener.

Parameters:

listener - the listener to remove

removeBeforeWindowCloseListener

@Deprecated
default void removeBeforeWindowCloseListener(java.util.function.Consumer<io.jmix.ui.component.Window.BeforeCloseEvent> listener)

Deprecated. Use Subscription instead

Removes a previously added listener.

Parameters:

listener - the listener to remove

addBeforeCloseWithShortcutListener

@Deprecated
default void addBeforeCloseWithShortcutListener(java.util.function.Consumer<Window.BeforeCloseWithShortcutEvent> listener)

Deprecated.

Registers a new before close with shortcut listener.

Parameters:

listener - the listener to register

removeBeforeCloseWithShortcutListener

@Deprecated
default void removeBeforeCloseWithShortcutListener(java.util.function.Consumer<Window.BeforeCloseWithShortcutEvent> listener)

Deprecated.

Removes a previously registered before close with shortcut listener.

Parameters:

listener - the listener to remove

addBeforeCloseWithCloseButtonListener

@Deprecated
default void addBeforeCloseWithCloseButtonListener(java.util.function.Consumer<Window.BeforeCloseWithCloseButtonEvent> listener)

Deprecated.

Registers a new before close with close button listener.

Parameters:

listener - the listener to register

removeBeforeCloseWithCloseButtonListener

@Deprecated
default void removeBeforeCloseWithCloseButtonListener(java.util.function.Consumer<Window.BeforeCloseWithCloseButtonEvent> listener)

Deprecated.

Removes a previously registered before close with close button listener.

Parameters:

listener - the listener to remove