com.haulmont.cuba.gui.components

Class AbstractMainWindow

java.lang.Object

io.jmix.ui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.components.AbstractTopLevelWindow

com.haulmont.cuba.gui.components.AbstractMainWindow

All Implemented Interfaces:

Frame.Wrapper, HasWindowManager, Window.HasFoldersPane, Window.TopLevelWindow, 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.component.Window.HasUserIndicator, io.jmix.ui.component.Window.HasWorkArea, io.jmix.ui.screen.ChangeTracker, io.jmix.ui.screen.FrameOwner

Direct Known Subclasses:

AppMainWindow

public class AbstractMainWindow
extends AbstractTopLevelWindow
implements io.jmix.ui.component.Window.HasWorkArea, io.jmix.ui.component.Window.HasUserIndicator, Window.HasFoldersPane

Legacy base class for a controller of application Main window.

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 static java.lang.String	APP_LOGO_IMAGE
protected FoldersPane	foldersPane
protected io.jmix.ui.Screens	screens
protected io.jmix.ui.ScreenTools	screenTools
protected io.jmix.ui.component.mainwindow.UserIndicator	userIndicator
protected io.jmix.ui.component.AppWorkArea	workArea

Fields inherited from class com.haulmont.cuba.gui.components.AbstractWindow

frame, messages, messageTools, UNKNOWN_CLOSE_ACTION_ID

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
AbstractMainWindow()

Method Summary

Modifier and Type	Method and Description
FoldersPane	getFoldersPane()
io.jmix.ui.component.mainwindow.UserIndicator	getUserIndicator()
io.jmix.ui.component.AppWorkArea	getWorkArea()
protected void	initComponents(io.jmix.ui.screen.Screen.InitEvent e)
protected void	initLogoImage(io.jmix.ui.component.Image logoImage)
void	ready() Hook to be implemented in subclasses.

Methods inherited from class com.haulmont.cuba.gui.components.AbstractWindow

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, afterShow, applyDataLoadingSettings, applySettings, beforeClose, closeWithDiscard, deleteSettings, expand, expand, formatMessage, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMaxHeight, getMaxWidth, getMessage, getMessagesPack, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getScreenHashCode, getSettings, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, hasUnsavedChanges, indexOf, init, init, initEnableEditingActionStub, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, onAfterDetach, postValidate, preClose, remove, removeAction, removeAction, removeAll, removeAllActions, removeBeforeWindowCloseListener, removeFacet, removeStyleName, resetExpanded, saveSettings, setAlignment, setCaption, setCloseable, setCompanion, setContentSwitchMode, setDescription, setDsContext, setEnabled, setExpandRatio, setFocusComponent, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMaxHeight, setMaxWidth, setMessagesPack, setMinHeight, setMinWidth, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWindow, setXmlDescriptor, showValidationErrors, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAdditionalRules, validateAll, withUnwrapped, withUnwrappedComposition

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, addCloseWithCommitListener, 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

APP_LOGO_IMAGE

protected static final java.lang.String APP_LOGO_IMAGE

See Also:

Constant Field Values

screens

@Autowired
protected io.jmix.ui.Screens screens

screenTools

@Autowired
protected io.jmix.ui.ScreenTools screenTools

workArea

protected io.jmix.ui.component.AppWorkArea workArea

userIndicator

protected io.jmix.ui.component.mainwindow.UserIndicator userIndicator

foldersPane

protected FoldersPane foldersPane

Constructor Detail

AbstractMainWindow

public AbstractMainWindow()

Method Detail

initComponents

protected void initComponents(io.jmix.ui.screen.Screen.InitEvent e)

getWorkArea

@Nullable
public io.jmix.ui.component.AppWorkArea getWorkArea()

Specified by:

getWorkArea in interface io.jmix.ui.component.Window.HasWorkArea

getUserIndicator

@Nullable
public io.jmix.ui.component.mainwindow.UserIndicator getUserIndicator()

Specified by:

getUserIndicator in interface io.jmix.ui.component.Window.HasUserIndicator

getFoldersPane

@Nullable
public FoldersPane getFoldersPane()

Specified by:

getFoldersPane in interface Window.HasFoldersPane

Returns:

a folders pane component

initLogoImage

protected void initLogoImage(io.jmix.ui.component.Image logoImage)

ready

public void ready()

Description copied from class: AbstractWindow

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.

Overrides:

ready in class AbstractWindow