com.haulmont.cuba.gui.components

Class AbstractMainWindow

java.lang.Object

com.haulmont.cuba.gui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.components.AbstractTopLevelWindow

com.haulmont.cuba.gui.components.AbstractMainWindow

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, Frame.Wrapper, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SecuredActionsHolder, SupportsExpandRatio, Window, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.TopLevelWindow, Window.Wrapper, ChangeTracker, LegacyFrame, FrameOwner

Direct Known Subclasses:

AppMainWindow

public class AbstractMainWindow
extends AbstractTopLevelWindow
implements Window.HasWorkArea, Window.HasUserIndicator, Window.HasFoldersPane

Legacy base class for a controller of application Main window.

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.screen.Screen

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

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

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseOrigin, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor<T extends Entity>, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup<T extends Entity>, Window.TopLevelWindow, Window.Wrapper

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

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

ExpandingLayout.ExpandDirection

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

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	APP_LOGO_IMAGE
protected FoldersPane	foldersPane
protected Screens	screens
protected ScreenTools	screenTools
protected UserIndicator	userIndicator
protected AppWorkArea	workArea

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

frame, messages, UNKNOWN_CLOSE_ACTION_ID

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

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, NAME, SELECT_ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Fields inherited from interface com.haulmont.cuba.gui.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()
UserIndicator	getUserIndicator()
AppWorkArea	getWorkArea()
protected void	initComponents(Screen.InitEvent e)
protected void	initFtsField(FtsField ftsField)
protected void	initLayoutAnalyzerContextMenu(Component contextMenuTarget)
protected void	initLogoImage(Image logoImage)
protected void	onUserRemove(UserRemovedEvent event)
protected void	onUserSubstitutionsChange(UserSubstitutionsChangedEvent event)
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, addTimer, afterShow, 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, getTimer, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, hasUnsavedChanges, indexOf, init, init, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, 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, validate, validate, validateAdditionalRules, validateAll

Methods inherited from class com.haulmont.cuba.gui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, applyDataLoadingSettings, close, closeWithDefaultAction, fireEvent, getBeanLocator, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSaveScreenHistoryOnClose, isSaveSettingsOnClose, setBeanLocator, 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, closeAndRun, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeCloseWithCommitListener, removeListener

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

getFacetNN

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

getComponentNN

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

add, focusFirstComponent, getComponentNN, remove

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

getHeightUnits, getId, getWidthUnits, isEnabledItself, isVisibleItself, requestFocus, setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

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

setMargin, setMargin

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

getActionNN, getSubPart

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

@Inject
protected Screens screens

screenTools

@Inject
protected ScreenTools screenTools

workArea

protected AppWorkArea workArea

userIndicator

protected UserIndicator userIndicator

foldersPane

protected FoldersPane foldersPane

Constructor Detail

AbstractMainWindow

public AbstractMainWindow()

Method Detail

initComponents

protected void initComponents(Screen.InitEvent e)

getWorkArea

@Nullable
public AppWorkArea getWorkArea()

Specified by:

getWorkArea in interface Window.HasWorkArea

getUserIndicator

@Nullable
public UserIndicator getUserIndicator()

Specified by:

getUserIndicator in interface Window.HasUserIndicator

getFoldersPane

@Nullable
public FoldersPane getFoldersPane()

Specified by:

getFoldersPane in interface Window.HasFoldersPane

initLogoImage

protected void initLogoImage(Image logoImage)

initFtsField

protected void initFtsField(FtsField ftsField)

initLayoutAnalyzerContextMenu

protected void initLayoutAnalyzerContextMenu(Component contextMenuTarget)

onUserSubstitutionsChange

@Order(value=900)
 @EventListener
protected void onUserSubstitutionsChange(UserSubstitutionsChangedEvent event)

onUserRemove

@Order(value=900)
 @EventListener
protected void onUserRemove(UserRemovedEvent event)

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