com.haulmont.cuba.gui.components

Class AbstractWindow

java.lang.Object

io.jmix.ui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

All Implemented Interfaces:

Frame.Wrapper, HasWindowManager, Window.Wrapper, LegacyFrame, CubaLegacySettings, 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.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, 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, io.jmix.ui.component.OrderedContainer, io.jmix.ui.component.SecuredActionsHolder, io.jmix.ui.component.SupportsExpandRatio, io.jmix.ui.component.Window, io.jmix.ui.screen.ChangeTracker, io.jmix.ui.screen.FrameOwner

Direct Known Subclasses:

AbstractEditor, AbstractLookup, AbstractTopLevelWindow, AddConditionWindow, AppLoginWindow, BackgroundWorkProgressWindow, BackgroundWorkWindow, BulkEditorWindow, CustomConditionEditor, DateIntervalEditor, DynamicAttributesConditionEditor, FileUploadDialog, FilterEditor, FilterSelectWindow, ListEditorPopupWindow, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScreenWrapper

Deprecated.

Use Screen APIs instead.

@Deprecated
public class AbstractWindow
extends io.jmix.ui.screen.Screen
implements Window, Window.Wrapper, LegacyFrame, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.SecuredActionsHolder, io.jmix.ui.screen.ChangeTracker, CubaLegacySettings

Base class for simple screen controllers.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

io.jmix.ui.screen.Screen.AfterCloseEvent, io.jmix.ui.screen.Screen.AfterDetachEvent, io.jmix.ui.screen.Screen.AfterInitEvent, io.jmix.ui.screen.Screen.AfterShowEvent, io.jmix.ui.screen.Screen.BeforeCloseEvent, io.jmix.ui.screen.Screen.BeforeShowEvent, io.jmix.ui.screen.Screen.InitEvent

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

Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseWithCommitListener, Window.Editor<T>, Window.HasFoldersPane, Window.Lookup<T>, Window.TopLevelWindow, Window.Wrapper

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

Modifier and Type	Field and Description
protected io.jmix.ui.component.Frame	frame Deprecated.
protected Messages	messages Deprecated.
protected io.jmix.core.MessageTools	messageTools Deprecated.
static java.lang.String	UNKNOWN_CLOSE_ACTION_ID Deprecated.

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.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
AbstractWindow() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	add(io.jmix.ui.component.Component component) Deprecated.
void	add(io.jmix.ui.component.Component childComponent, int index) Deprecated.
void	addAction(io.jmix.ui.action.Action action) Deprecated.
void	addAction(io.jmix.ui.action.Action action, int index) Deprecated.
io.jmix.core.common.event.Subscription	addBeforeWindowCloseListener(java.util.function.Consumer<io.jmix.ui.component.Window.BeforeCloseEvent> listener) Deprecated.
void	addFacet(io.jmix.ui.component.Facet facet) Deprecated.
void	addStyleName(java.lang.String styleName) Deprecated.
protected void	afterShow(io.jmix.ui.screen.Screen.AfterShowEvent event) Deprecated.
void	applyDataLoadingSettings(Settings settings) Deprecated. Applies screen settings to data components.
void	applySettings(Settings settings) Deprecated. This method is called when the screen is opened to restore settings saved in the database for the current user.
protected void	beforeClose(io.jmix.ui.screen.Screen.BeforeCloseEvent event) Deprecated.
io.jmix.ui.util.OperationResult	closeWithDiscard() Deprecated. Ignores the unsaved changes and closes the screen with FrameOwner.WINDOW_DISCARD_AND_CLOSE_ACTION action.
void	deleteSettings() Deprecated. This method is called by the framework on reset to defaults action
void	expand(io.jmix.ui.component.Component component) Deprecated.
void	expand(io.jmix.ui.component.Component component, java.lang.String height, java.lang.String width) Deprecated.
protected java.lang.String	formatMessage(java.lang.String key, java.lang.Object... params) Deprecated. Get localized message from the message pack associated with this frame or window, and use it as a format string for parameters provided.
io.jmix.ui.action.Action	getAction(java.lang.String id) Deprecated.
java.util.Collection<io.jmix.ui.action.Action>	getActions() Deprecated.
io.jmix.ui.component.ActionsPermissions	getActionsPermissions() Deprecated.
io.jmix.ui.component.Component.Alignment	getAlignment() Deprecated.
java.lang.String	getCaption() Deprecated.
<T> T	getCompanion() Deprecated.
java.lang.Object	getComponent() Deprecated.
io.jmix.ui.component.Component	getComponent(int index) Deprecated.
io.jmix.ui.component.Component	getComponent(java.lang.String id) Deprecated.
java.util.Collection<io.jmix.ui.component.Component>	getComponents() Deprecated.
java.lang.Object	getComposition() Deprecated.
io.jmix.ui.component.Window.ContentSwitchMode	getContentSwitchMode() Deprecated.
WindowContext	getContext() Deprecated.
java.lang.String	getDescription() Deprecated. Screen description is used by the framework to show some specified information, e.g.
DialogOptions	getDialogOptions() Deprecated.
DsContext	getDsContext() Deprecated.
io.jmix.ui.component.ExpandingLayout.ExpandDirection	getExpandDirection() Deprecated.
float	getExpandRatio(io.jmix.ui.component.Component component) Deprecated.
io.jmix.ui.component.Facet	getFacet(java.lang.String id) Deprecated.
java.util.stream.Stream<io.jmix.ui.component.Facet>	getFacets() Deprecated.
java.lang.String	getFocusComponent() Deprecated.
io.jmix.ui.component.Frame	getFrame() Deprecated.
io.jmix.ui.screen.Screen	getFrameOwner() Deprecated.
float	getHeight() Deprecated.
io.jmix.ui.component.SizeUnit	getHeightSizeUnit() Deprecated.
java.lang.String	getIcon() Deprecated.
io.jmix.ui.component.MarginInfo	getMargin() Deprecated.
java.lang.String	getMaxHeight() Deprecated.
java.lang.String	getMaxWidth() Deprecated.
protected java.lang.String	getMessage(java.lang.String key) Deprecated. Get localized message from the message pack associated with this frame or window.
java.lang.String	getMessagesPack() Deprecated.
java.lang.String	getMinHeight() Deprecated.
java.lang.String	getMinWidth() Deprecated.
io.jmix.ui.component.Component	getOwnComponent(java.lang.String id) Deprecated.
java.util.Collection<io.jmix.ui.component.Component>	getOwnComponents() Deprecated.
java.util.stream.Stream<io.jmix.ui.component.Component>	getOwnComponentsStream() Deprecated.
io.jmix.ui.component.Component	getParent() Deprecated.
protected int	getScreenHashCode(io.jmix.ui.screen.Screen screen) Deprecated.
Settings	getSettings() Deprecated.
boolean	getSpacing() Deprecated.
java.lang.String	getStyleName() Deprecated.
float	getWidth() Deprecated.
io.jmix.ui.component.SizeUnit	getWidthSizeUnit() Deprecated.
WindowManager	getWindowManager() Deprecated. It is recommended to use Screens instead, it can be obtained from ScreenContext of FrameOwner.
io.jmix.ui.component.Frame	getWrappedFrame() Deprecated.
io.jmix.ui.component.Window	getWrappedWindow() Deprecated. INTERNAL.
org.dom4j.Element	getXmlDescriptor() Deprecated.
protected boolean	handleValidationErrors(io.jmix.ui.component.ValidationErrors errors) Deprecated.
boolean	hasUnsavedChanges() Deprecated.
int	indexOf(io.jmix.ui.component.Component component) Deprecated.
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Called by the framework after creation of all components and before showing the screen.
protected void	init(io.jmix.ui.screen.Screen.InitEvent initEvent) Deprecated.
protected void	initEnableEditingActionStub() Deprecated.
boolean	isAttributeAccessControlEnabled() Deprecated. Whether automatic applying of attribute access rules enabled.
boolean	isCloseable() Deprecated.
boolean	isEnabled() Deprecated.
boolean	isEnabledRecursive() Deprecated.
boolean	isExpanded(io.jmix.ui.component.Component component) Deprecated.
boolean	isResponsive() Deprecated.
protected boolean	isSameScreen(io.jmix.ui.screen.Screen openedScreen) Deprecated.
boolean	isValid() Deprecated.
boolean	isVisible() Deprecated.
boolean	isVisibleRecursive() Deprecated.
void	onAfterDetach(io.jmix.ui.screen.Screen.AfterDetachEvent event) Deprecated.
protected void	postValidate(io.jmix.ui.component.ValidationErrors errors) Deprecated. Hook to be implemented in subclasses.
protected boolean	preClose(java.lang.String actionId) Deprecated. Hook to be implemented in subclasses.
void	ready() Deprecated. Hook to be implemented in subclasses.
void	remove(io.jmix.ui.component.Component component) Deprecated.
void	removeAction(io.jmix.ui.action.Action action) Deprecated.
void	removeAction(java.lang.String id) Deprecated.
void	removeAll() Deprecated.
void	removeAllActions() Deprecated.
void	removeBeforeWindowCloseListener(java.util.function.Consumer<io.jmix.ui.component.Window.BeforeCloseEvent> listener) Deprecated. Removes a previously added listener.
void	removeFacet(io.jmix.ui.component.Facet facet) Deprecated.
void	removeStyleName(java.lang.String styleName) Deprecated.
void	resetExpanded() Deprecated.
void	saveSettings() Deprecated. This method is called when the screen is closed to save the screen settings to the database.
void	setAlignment(io.jmix.ui.component.Component.Alignment alignment) Deprecated.
void	setCaption(java.lang.String caption) Deprecated. Set the screen caption.
void	setCloseable(boolean closeable) Deprecated.
void	setCompanion(java.lang.Object companion) Deprecated. INTERNAL.
void	setContentSwitchMode(io.jmix.ui.component.Window.ContentSwitchMode mode) Deprecated.
void	setDescription(java.lang.String description) Deprecated. Screen description is used by the framework to show some specified information, e.g.
void	setDsContext(DsContext dsContext) Deprecated. INTERNAL.
void	setEnabled(boolean enabled) Deprecated.
void	setExpandRatio(io.jmix.ui.component.Component component, float ratio) Deprecated.
void	setFocusComponent(java.lang.String componentId) Deprecated.
void	setFrame(io.jmix.ui.component.Frame frame) Deprecated.
void	setHeight(java.lang.String height) Deprecated.
void	setIcon(java.lang.String icon) Deprecated.
void	setIconFromSet(io.jmix.ui.icon.Icons.Icon icon) Deprecated.
void	setId(java.lang.String id) Deprecated.
void	setMargin(io.jmix.ui.component.MarginInfo marginInfo) Deprecated.
void	setMaxHeight(java.lang.String maxHeight) Deprecated.
void	setMaxWidth(java.lang.String maxWidth) Deprecated.
void	setMessagesPack(java.lang.String name) Deprecated.
void	setMinHeight(java.lang.String minHeight) Deprecated.
void	setMinWidth(java.lang.String minWidth) Deprecated.
void	setParent(io.jmix.ui.component.Component parent) Deprecated.
void	setResponsive(boolean responsive) Deprecated.
void	setSpacing(boolean enabled) Deprecated.
void	setStyleName(java.lang.String styleName) Deprecated.
void	setVisible(boolean visible) Deprecated.
void	setWidth(java.lang.String width) Deprecated.
protected void	setWindow(io.jmix.ui.component.Window window) Deprecated.
void	setXmlDescriptor(org.dom4j.Element element) Deprecated.
protected void	showValidationErrors(io.jmix.ui.component.ValidationErrors errors) Deprecated.
<X> X	unwrap(java.lang.Class<X> internalComponentClass) Deprecated.
<X> X	unwrapComposition(java.lang.Class<X> internalCompositionClass) Deprecated.
<X> X	unwrapCompositionOrNull(java.lang.Class<X> internalCompositionClass) Deprecated.
<X> X	unwrapOrNull(java.lang.Class<X> internalComponentClass) Deprecated.
void	validate() Deprecated.
boolean	validate(java.util.List<io.jmix.ui.component.Validatable> fields) Deprecated.
protected void	validateAdditionalRules(io.jmix.ui.component.ValidationErrors errors) Deprecated.
boolean	validateAll() Deprecated. Check validity by invoking validators on all components which support them and show validation result notification.
<X> void	withUnwrapped(java.lang.Class<X> internalComponentClass, java.util.function.Consumer<X> action) Deprecated.
<X> void	withUnwrappedComposition(java.lang.Class<X> internalCompositionClass, java.util.function.Consumer<X> action) Deprecated.

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, setApplicationContext, setExtensions, setScreenData, setUiEventListeners, show

Methods inherited from class java.lang.Object

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

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

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addListener, close, close, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeListener

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

getFacetNN

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

getComponentNN

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

setMargin, setMargin

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

getActionNN, getSubPart

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

add, remove

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

focusFirstComponent, getComponentNN

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

Field Detail

UNKNOWN_CLOSE_ACTION_ID

public static final java.lang.String UNKNOWN_CLOSE_ACTION_ID

Deprecated.

See Also:

Constant Field Values

frame

protected io.jmix.ui.component.Frame frame

Deprecated.

messages

@Autowired
protected Messages messages

Deprecated.

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

Deprecated.

Constructor Detail

AbstractWindow

public AbstractWindow()

Deprecated.

Method Detail

setWindow

protected void setWindow(io.jmix.ui.component.Window window)

Deprecated.

Overrides:

setWindow in class io.jmix.ui.screen.Screen

getWindowManager

public WindowManager getWindowManager()

Deprecated.

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

public DialogOptions getDialogOptions()

Deprecated.

Returns:

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

getWrappedFrame

public io.jmix.ui.component.Frame getWrappedFrame()

Deprecated.

Specified by:

getWrappedFrame in interface Frame.Wrapper

init

@Order(value=110)
 @Subscribe
protected void init(io.jmix.ui.screen.Screen.InitEvent initEvent)

Deprecated.

initEnableEditingActionStub

protected void initEnableEditingActionStub()

Deprecated.

afterShow

@Order(value=110)
 @Subscribe
protected void afterShow(io.jmix.ui.screen.Screen.AfterShowEvent event)

Deprecated.

beforeClose

@Order(value=110)
 @Subscribe
protected void beforeClose(io.jmix.ui.screen.Screen.BeforeCloseEvent event)

Deprecated.

onAfterDetach

@Subscribe
public void onAfterDetach(io.jmix.ui.screen.Screen.AfterDetachEvent event)

Deprecated.

closeWithDiscard

public io.jmix.ui.util.OperationResult closeWithDiscard()

Deprecated.

Ignores the unsaved changes and closes the screen with FrameOwner.WINDOW_DISCARD_AND_CLOSE_ACTION action.

Returns:

result of close request

hasUnsavedChanges

public boolean hasUnsavedChanges()

Deprecated.

Specified by:

hasUnsavedChanges in interface io.jmix.ui.screen.ChangeTracker

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

setId

public void setId(java.lang.String id)

Deprecated.

Specified by:

setId in interface io.jmix.ui.component.Component

Overrides:

setId in class io.jmix.ui.screen.Screen

getParent

public io.jmix.ui.component.Component getParent()

Deprecated.

Specified by:

getParent in interface io.jmix.ui.component.Component

setParent

public void setParent(io.jmix.ui.component.Component parent)

Deprecated.

Specified by:

setParent in interface io.jmix.ui.component.Component

isEnabled

public boolean isEnabled()

Deprecated.

Specified by:

isEnabled in interface io.jmix.ui.component.Component

isEnabledRecursive

public boolean isEnabledRecursive()

Deprecated.

Specified by:

isEnabledRecursive in interface io.jmix.ui.component.Component

setEnabled

public void setEnabled(boolean enabled)

Deprecated.

Specified by:

setEnabled in interface io.jmix.ui.component.Component

isVisible

public boolean isVisible()

Deprecated.

Specified by:

isVisible in interface io.jmix.ui.component.Component

setVisible

public void setVisible(boolean visible)

Deprecated.

Specified by:

setVisible in interface io.jmix.ui.component.Component

isVisibleRecursive

public boolean isVisibleRecursive()

Deprecated.

Specified by:

isVisibleRecursive in interface io.jmix.ui.component.Component

getHeight

public float getHeight()

Deprecated.

Specified by:

getHeight in interface io.jmix.ui.component.Component

getHeightSizeUnit

public io.jmix.ui.component.SizeUnit getHeightSizeUnit()

Deprecated.

Specified by:

getHeightSizeUnit in interface io.jmix.ui.component.Component

setHeight

public void setHeight(java.lang.String height)

Deprecated.

Specified by:

setHeight in interface io.jmix.ui.component.Component

getWidth

public float getWidth()

Deprecated.

Specified by:

getWidth in interface io.jmix.ui.component.Component

getWidthSizeUnit

public io.jmix.ui.component.SizeUnit getWidthSizeUnit()

Deprecated.

Specified by:

getWidthSizeUnit in interface io.jmix.ui.component.Component

setWidth

public void setWidth(java.lang.String width)

Deprecated.

Specified by:

setWidth in interface io.jmix.ui.component.Component

getAlignment

public io.jmix.ui.component.Component.Alignment getAlignment()

Deprecated.

Specified by:

getAlignment in interface io.jmix.ui.component.Component

setAlignment

public void setAlignment(io.jmix.ui.component.Component.Alignment alignment)

Deprecated.

Specified by:

setAlignment in interface io.jmix.ui.component.Component

isResponsive

public boolean isResponsive()

Deprecated.

Specified by:

isResponsive in interface io.jmix.ui.component.Component

setResponsive

public void setResponsive(boolean responsive)

Deprecated.

Specified by:

setResponsive in interface io.jmix.ui.component.Component

getIcon

public java.lang.String getIcon()

Deprecated.

Specified by:

getIcon in interface io.jmix.ui.component.Component.HasIcon

setIcon

public void setIcon(java.lang.String icon)

Deprecated.

Specified by:

setIcon in interface io.jmix.ui.component.Component.HasIcon

setIconFromSet

public void setIconFromSet(io.jmix.ui.icon.Icons.Icon icon)

Deprecated.

Specified by:

setIconFromSet in interface io.jmix.ui.component.Component.HasIcon

add

public void add(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

add in interface io.jmix.ui.component.ComponentContainer

remove

public void remove(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

remove in interface io.jmix.ui.component.ComponentContainer

removeAll

public void removeAll()

Deprecated.

Specified by:

removeAll in interface io.jmix.ui.component.ComponentContainer

getOwnComponent

public io.jmix.ui.component.Component getOwnComponent(java.lang.String id)

Deprecated.

Specified by:

getOwnComponent in interface io.jmix.ui.component.HasComponents

getComponent

@Nullable
public io.jmix.ui.component.Component getComponent(java.lang.String id)

Deprecated.

Specified by:

getComponent in interface io.jmix.ui.component.HasComponents

getOwnComponents

public java.util.Collection<io.jmix.ui.component.Component> getOwnComponents()

Deprecated.

Specified by:

getOwnComponents in interface io.jmix.ui.component.HasComponents

getOwnComponentsStream

public java.util.stream.Stream<io.jmix.ui.component.Component> getOwnComponentsStream()

Deprecated.

Specified by:

getOwnComponentsStream in interface io.jmix.ui.component.HasComponents

getComponents

public java.util.Collection<io.jmix.ui.component.Component> getComponents()

Deprecated.

Specified by:

getComponents in interface io.jmix.ui.component.HasComponents

getComponent

public java.lang.Object getComponent()

Deprecated.

Specified by:

getComponent in interface io.jmix.ui.component.Component.Wrapper

getComposition

public java.lang.Object getComposition()

Deprecated.

Specified by:

getComposition in interface io.jmix.ui.component.Component.Wrapper

expand

public void expand(io.jmix.ui.component.Component component,
                   java.lang.String height,
                   java.lang.String width)

Deprecated.

expand

public void expand(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

expand in interface io.jmix.ui.component.ExpandingLayout

resetExpanded

public void resetExpanded()

Deprecated.

Specified by:

resetExpanded in interface io.jmix.ui.component.ExpandingLayout

isExpanded

public boolean isExpanded(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

isExpanded in interface io.jmix.ui.component.ExpandingLayout

getExpandDirection

public io.jmix.ui.component.ExpandingLayout.ExpandDirection getExpandDirection()

Deprecated.

Specified by:

getExpandDirection in interface io.jmix.ui.component.ExpandingLayout

getMessagesPack

public java.lang.String getMessagesPack()

Deprecated.

Specified by:

getMessagesPack in interface LegacyFrame

setMessagesPack

public void setMessagesPack(java.lang.String name)

Deprecated.

Specified by:

setMessagesPack in interface LegacyFrame

getMessage

protected java.lang.String getMessage(java.lang.String key)

Deprecated.

Get localized message from the message pack associated with this frame or window.

Parameters:

key - message key

Returns:

localized message

See Also:

Messages.getMessage(String, String)

formatMessage

protected java.lang.String formatMessage(java.lang.String key,
                                         java.lang.Object... params)

Deprecated.

Get localized message from the message pack associated with this frame or window, and use it as a format string for parameters provided.

Parameters:

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

See Also:

Messages.formatMessage(String, String, Object...)

isValid

public boolean isValid()

Deprecated.

Specified by:

isValid in interface LegacyFrame

Specified by:

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

validate

public void validate()
              throws io.jmix.ui.component.ValidationException

Deprecated.

Specified by:

validate in interface LegacyFrame

Specified by:

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

Throws:

io.jmix.ui.component.ValidationException

add

public void add(io.jmix.ui.component.Component childComponent,
                int index)

Deprecated.

Specified by:

add in interface io.jmix.ui.component.OrderedContainer

indexOf

public int indexOf(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

indexOf in interface io.jmix.ui.component.OrderedContainer

getComponent

@Nullable
public io.jmix.ui.component.Component getComponent(int index)

Deprecated.

Specified by:

getComponent in interface io.jmix.ui.component.OrderedContainer

getCompanion

@Nullable
public <T> T getCompanion()

Deprecated.

Specified by:

getCompanion in interface LegacyFrame

Returns:

a companion implementation, specific for the current client type

setCompanion

public void setCompanion(java.lang.Object companion)

Deprecated.

INTERNAL. Don't call from application code.

getFrame

public io.jmix.ui.component.Frame getFrame()

Deprecated.

Specified by:

getFrame in interface io.jmix.ui.component.Component.BelongToFrame

setFrame

public void setFrame(io.jmix.ui.component.Frame frame)

Deprecated.

Specified by:

setFrame in interface io.jmix.ui.component.Component.BelongToFrame

getStyleName

public java.lang.String getStyleName()

Deprecated.

Specified by:

getStyleName in interface io.jmix.ui.component.Component

setStyleName

public void setStyleName(java.lang.String styleName)

Deprecated.

Specified by:

setStyleName in interface io.jmix.ui.component.Component

addStyleName

public void addStyleName(java.lang.String styleName)

Deprecated.

Specified by:

addStyleName in interface io.jmix.ui.component.Component

removeStyleName

public void removeStyleName(java.lang.String styleName)

Deprecated.

Specified by:

removeStyleName in interface io.jmix.ui.component.Component

unwrap

public <X> X unwrap(java.lang.Class<X> internalComponentClass)

Deprecated.

Specified by:

unwrap in interface io.jmix.ui.component.Component

unwrapOrNull

@Nullable
public <X> X unwrapOrNull(java.lang.Class<X> internalComponentClass)

Deprecated.

Specified by:

unwrapOrNull in interface io.jmix.ui.component.Component

withUnwrapped

public <X> void withUnwrapped(java.lang.Class<X> internalComponentClass,
                              java.util.function.Consumer<X> action)

Deprecated.

Specified by:

withUnwrapped in interface io.jmix.ui.component.Component

unwrapComposition

public <X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)

Deprecated.

Specified by:

unwrapComposition in interface io.jmix.ui.component.Component

unwrapCompositionOrNull

@Nullable
public <X> X unwrapCompositionOrNull(java.lang.Class<X> internalCompositionClass)

Deprecated.

Specified by:

unwrapCompositionOrNull in interface io.jmix.ui.component.Component

withUnwrappedComposition

public <X> void withUnwrappedComposition(java.lang.Class<X> internalCompositionClass,
                                         java.util.function.Consumer<X> action)

Deprecated.

Specified by:

withUnwrappedComposition in interface io.jmix.ui.component.Component

setSpacing

public void setSpacing(boolean enabled)

Deprecated.

Specified by:

setSpacing in interface io.jmix.ui.component.HasSpacing

getSpacing

public boolean getSpacing()

Deprecated.

Specified by:

getSpacing in interface io.jmix.ui.component.HasSpacing

setMargin

public void setMargin(io.jmix.ui.component.MarginInfo marginInfo)

Deprecated.

Specified by:

setMargin in interface io.jmix.ui.component.HasMargin

getMargin

public io.jmix.ui.component.MarginInfo getMargin()

Deprecated.

Specified by:

getMargin in interface io.jmix.ui.component.HasMargin

addAction

public void addAction(io.jmix.ui.action.Action action)

Deprecated.

Specified by:

addAction in interface io.jmix.ui.component.ActionsHolder

addAction

public void addAction(io.jmix.ui.action.Action action,
                      int index)

Deprecated.

Specified by:

addAction in interface io.jmix.ui.component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         io.jmix.ui.action.Action action)

Deprecated.

Specified by:

removeAction in interface io.jmix.ui.component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         java.lang.String id)

Deprecated.

Specified by:

removeAction in interface io.jmix.ui.component.ActionsHolder

removeAllActions

public void removeAllActions()

Deprecated.

Specified by:

removeAllActions in interface io.jmix.ui.component.ActionsHolder

getActions

public java.util.Collection<io.jmix.ui.action.Action> getActions()

Deprecated.

Specified by:

getActions in interface io.jmix.ui.component.ActionsHolder

getAction

@Nullable
public io.jmix.ui.action.Action getAction(java.lang.String id)

Deprecated.

Specified by:

getAction in interface io.jmix.ui.component.ActionsHolder

getXmlDescriptor

public org.dom4j.Element getXmlDescriptor()

Deprecated.

Specified by:

getXmlDescriptor in interface LegacyFrame

Specified by:

getXmlDescriptor in interface io.jmix.ui.component.Component.HasXmlDescriptor

setXmlDescriptor

public void setXmlDescriptor(org.dom4j.Element element)

Deprecated.

Specified by:

setXmlDescriptor in interface LegacyFrame

Specified by:

setXmlDescriptor in interface io.jmix.ui.component.Component.HasXmlDescriptor

setCloseable

public void setCloseable(boolean closeable)

Deprecated.

Specified by:

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

isCloseable

public boolean isCloseable()

Deprecated.

Specified by:

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

setMinWidth

public void setMinWidth(java.lang.String minWidth)

Deprecated.

Specified by:

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

getMinWidth

public java.lang.String getMinWidth()

Deprecated.

Specified by:

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

setMaxWidth

public void setMaxWidth(java.lang.String maxWidth)

Deprecated.

Specified by:

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

getMaxWidth

public java.lang.String getMaxWidth()

Deprecated.

Specified by:

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

setMinHeight

public void setMinHeight(java.lang.String minHeight)

Deprecated.

Specified by:

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

getMinHeight

public java.lang.String getMinHeight()

Deprecated.

Specified by:

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

setMaxHeight

public void setMaxHeight(java.lang.String maxHeight)

Deprecated.

Specified by:

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

getMaxHeight

public java.lang.String getMaxHeight()

Deprecated.

Specified by:

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

getFrameOwner

public io.jmix.ui.screen.Screen getFrameOwner()

Deprecated.

Specified by:

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

Specified by:

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

getContext

public WindowContext getContext()

Deprecated.

Specified by:

getContext in interface LegacyFrame

Specified by:

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

Specified by:

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

getDsContext

public DsContext getDsContext()

Deprecated.

Specified by:

getDsContext in interface LegacyFrame

Returns:

DsContext of the current frame or window

setDsContext

public void setDsContext(DsContext dsContext)

Deprecated.

Description copied from interface: LegacyFrame

INTERNAL. Don't call from application code.

Specified by:

setDsContext in interface LegacyFrame

getCaption

public java.lang.String getCaption()

Deprecated.

Specified by:

getCaption in interface io.jmix.ui.component.Component.HasCaption

Returns:

screen caption which is set in XML or via setCaption(String)

setCaption

public void setCaption(java.lang.String caption)

Deprecated.

Set the screen caption. If called in init(Map), overrides the value from XML.

Specified by:

setCaption in interface io.jmix.ui.component.Component.HasCaption

Parameters:

caption - caption

getDescription

public java.lang.String getDescription()

Deprecated.

Screen description is used by the framework to show some specified information, e.g. current filter or folder name. We don't recommend to use it in application code.

Specified by:

getDescription in interface io.jmix.ui.component.Component.HasDescription

setDescription

public void setDescription(java.lang.String description)

Deprecated.

Screen description is used by the framework to show some specified information, e.g. current filter or folder name. We don't recommend to use it in application code.

Specified by:

setDescription in interface io.jmix.ui.component.Component.HasDescription

getWrappedWindow

public io.jmix.ui.component.Window getWrappedWindow()

Deprecated.

INTERNAL. Don't call from application code.

Specified by:

getWrappedWindow in interface Window.Wrapper

applySettings

public void applySettings(Settings settings)

Deprecated.

This method is called when the screen is opened to restore settings saved in the database for the current user.

You can override it to restore custom settings.

For example:

 public void applySettings(Settings settings) {
     super.applySettings(settings);
     String visible = settings.get(hintBox.getId()).attributeValue("visible");
     if (visible != null)
         hintBox.setVisible(Boolean.valueOf(visible));
 }
 

Specified by:

applySettings in interface CubaLegacySettings

Parameters:

settings - settings object loaded from the database for the current user

applyDataLoadingSettings

public void applyDataLoadingSettings(Settings settings)

Deprecated.

Description copied from interface: CubaLegacySettings

Applies screen settings to data components.

Specified by:

applyDataLoadingSettings in interface CubaLegacySettings

Parameters:

settings - screen settings

saveSettings

public void saveSettings()

Deprecated.

This method is called when the screen is closed to save the screen settings to the database.

Specified by:

saveSettings in interface CubaLegacySettings

deleteSettings

public void deleteSettings()

Deprecated.

Description copied from interface: CubaLegacySettings

This method is called by the framework on reset to defaults action

Specified by:

deleteSettings in interface CubaLegacySettings

getSettings

public Settings getSettings()

Deprecated.

Specified by:

getSettings in interface CubaLegacySettings

Returns:

object encapsulating user settings for the current screen

setFocusComponent

public void setFocusComponent(java.lang.String componentId)

Deprecated.

Specified by:

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

getFocusComponent

public java.lang.String getFocusComponent()

Deprecated.

Specified by:

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

validate

public boolean validate(java.util.List<io.jmix.ui.component.Validatable> fields)

Deprecated.

Specified by:

validate in interface LegacyFrame

Specified by:

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

Specified by:

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

isAttributeAccessControlEnabled

public boolean isAttributeAccessControlEnabled()

Deprecated.

Whether automatic applying of attribute access rules enabled. If you don't want to apply attribute access rules to a screen, override this method and return false.

ready

public void ready()

Deprecated.

Hook to be implemented in subclasses.
Called by the framework after the screen is fully initialized and opened.
Override this method and put custom initialization logic here.

postValidate

protected void postValidate(io.jmix.ui.component.ValidationErrors errors)

Deprecated.

Hook to be implemented in subclasses. Called by validateAll() at the end of standard validation.

Parameters:

errors - the list of validation errors. Caller fills it by errors found during the default validation. Overridden method should add into it errors found by custom validation.

preClose

protected boolean preClose(java.lang.String actionId)

Deprecated.

Hook to be implemented in subclasses. Called by the framework before closing the screen.

Parameters:

actionId - a string that is passed to one of Screen.close(io.jmix.ui.screen.CloseAction) methods by calling code to identify itself. Can be an Action ID, or a constant like Window.COMMIT_ACTION_ID or Window.CLOSE_ACTION_ID.

Returns:

true to proceed with closing, false to interrupt and leave the screen open

validateAdditionalRules

protected void validateAdditionalRules(io.jmix.ui.component.ValidationErrors errors)

Deprecated.

showValidationErrors

protected void showValidationErrors(io.jmix.ui.component.ValidationErrors errors)

Deprecated.

isSameScreen

protected boolean isSameScreen(io.jmix.ui.screen.Screen openedScreen)

Deprecated.

Overrides:

isSameScreen in class io.jmix.ui.screen.Screen

getScreenHashCode

protected int getScreenHashCode(io.jmix.ui.screen.Screen screen)

Deprecated.

validateAll

public boolean validateAll()

Deprecated.

Check validity by invoking validators on all components which support them and show validation result notification. This method also calls postValidate(ValidationErrors) hook to support additional validation.

You should override this method in subclasses ONLY if you want to completely replace the validation process, otherwise use postValidate(ValidationErrors).

Specified by:

validateAll in interface LegacyFrame

Specified by:

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

Specified by:

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

Returns:

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

handleValidationErrors

protected boolean handleValidationErrors(io.jmix.ui.component.ValidationErrors errors)

Deprecated.

getActionsPermissions

public io.jmix.ui.component.ActionsPermissions getActionsPermissions()

Deprecated.

Specified by:

getActionsPermissions in interface io.jmix.ui.component.SecuredActionsHolder

getContentSwitchMode

public io.jmix.ui.component.Window.ContentSwitchMode getContentSwitchMode()

Deprecated.

setContentSwitchMode

public void setContentSwitchMode(io.jmix.ui.component.Window.ContentSwitchMode mode)

Deprecated.

addBeforeWindowCloseListener

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

Deprecated.

Specified by:

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

removeBeforeWindowCloseListener

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

Deprecated.

Description copied from interface: Window

Removes a previously added listener.

Parameters:

listener - the listener to remove

setExpandRatio

public void setExpandRatio(io.jmix.ui.component.Component component,
                           float ratio)

Deprecated.

Specified by:

setExpandRatio in interface io.jmix.ui.component.SupportsExpandRatio

getExpandRatio

public float getExpandRatio(io.jmix.ui.component.Component component)

Deprecated.

Specified by:

getExpandRatio in interface io.jmix.ui.component.SupportsExpandRatio

addFacet

public void addFacet(io.jmix.ui.component.Facet facet)

Deprecated.

Specified by:

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

getFacet

@Nullable
public io.jmix.ui.component.Facet getFacet(java.lang.String id)

Deprecated.

Specified by:

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

removeFacet

public void removeFacet(io.jmix.ui.component.Facet facet)

Deprecated.

Specified by:

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

getFacets

public java.util.stream.Stream<io.jmix.ui.component.Facet> getFacets()

Deprecated.

Specified by:

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