Package io.jmix.ui.component.impl

Class AppWorkAreaImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<com.vaadin.ui.CssLayout>

io.jmix.ui.component.impl.AppWorkAreaImpl

All Implemented Interfaces:

AppWorkArea, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInnerComponents

public class AppWorkAreaImpl
extends AbstractComponent<com.vaadin.ui.CssLayout>
implements AppWorkArea, HasInnerComponents

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppWorkAreaImpl.TabSheetReorderingDropHandler
static class	AppWorkAreaImpl.WorkAreaTabChangedEvent	Application event that is sent after selected tab changed in the main TabSheet.

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

AppWorkArea.Mode, AppWorkArea.State, AppWorkArea.StateChangeEvent

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

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INITIAL_LAYOUT_STYLENAME
protected VBoxLayout	initialLayout
protected Messages	messages
protected AppWorkArea.Mode	mode
static final String	MODE_SINGLE_STYLENAME
static final String	MODE_TABBED_STYLENAME
protected boolean	shortcutsInitialized
static final String	SINGLE_CONTAINER_STYLENAME
protected JmixSingleModeContainer	singleContainer
protected AppWorkArea.State	state
static final String	STATE_INITIAL_STYLENAME
static final String	STATE_WINDOWS_STYLENAME
static final String	TABBED_CONTAINER_STYLENAME
protected HasTabSheetBehaviour	tabbedContainer
protected int	urlStateCounter
static final String	WORKAREA_STYLENAME

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
AppWorkAreaImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addStateChangeListener(Consumer<AppWorkArea.StateChangeEvent> listener)	Adds a listener that will be notified when a work area state is changed.
void	attached()	Notifies all listeners that component has been attached.
protected void	closeAllTabWindows(com.vaadin.ui.ComponentContainer container)
protected void	closeOtherTabWindows(com.vaadin.ui.ComponentContainer container)
protected void	closeWindowByShortcut(RootWindow topLevelWindow)
protected boolean	closeWindowStack(Screens.WindowStack windowStack)
protected com.vaadin.event.ShortcutListener	createCloseShortcut(RootWindow topLevelWindow)
protected com.vaadin.ui.CssLayout	createComponent()
protected VBoxLayout	createInitialLayout()
protected com.vaadin.event.ShortcutListener	createNextWindowTabShortcut(RootWindow topLevelWindow)
protected com.vaadin.event.ShortcutListener	createPreviousWindowTabShortcut(RootWindow topLevelWindow)
protected JmixSingleModeContainer	createSingleModeContainer()
protected HasTabSheetBehaviour	createTabbedModeContainer()
protected com.vaadin.event.Action.Handler	createTabSheetActionHandler(HasTabSheetBehaviour tabSheet)
void	detached()	Notifies all listeners that component has been detached.
protected void	fireTabChangedEvent(TabSheetBehaviour tabSheet)
int	generateUrlStateMark()
Stream<Screen>	getActiveWorkAreaScreensStream()	Returns all active screens that are inside the work area.
Collection<Screen>	getCurrentBreadcrumbs()	Returns all screens that are inside the current breadcrumbs.
protected TabWindowContainer	getCurrentWindowContainer()
VBoxLayout	getInitialLayout()
Collection<Component>	getInnerComponents()
AppWorkArea.Mode	getMode()
int	getOpenedTabCount()
Stream<Screen>	getOpenedWorkAreaScreensStream()	Returns all opened screens that are inside the work area.
JmixSingleModeContainer	getSingleWindowContainer()
AppWorkArea.State	getState()
String	getStyleName()	Styles implementation is client-type-specific.
HasTabSheetBehaviour	getTabbedWindowContainer()
protected List<WindowBreadCrumbs>	getWindowStacks()
protected boolean	hasModalWindow()
protected void	initComponent(com.vaadin.ui.CssLayout component)
protected void	initTabShortcuts()
boolean	isNotCloseable(Window window)
protected boolean	isWindowClosePrevented(Window window, Window.CloseOrigin closeOrigin)
protected void	loadModeFromSettings()
protected void	moveFocus(TabSheetBehaviour tabSheet, String tabId)
protected void	reflectTabChangeToUrl(boolean userOriginated)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setFrame(Frame frame)
void	setInitialLayout(VBoxLayout initialLayout)	Sets the initial layout.
void	setMode(AppWorkArea.Mode mode)	Sets a mode.
void	setStyleName(String name)	Sets one or more style names of the component, replacing any previous styles.
void	switchTo(AppWorkArea.State state)	INTERNAL.

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame

Field Details

WORKAREA_STYLENAME

public static final String WORKAREA_STYLENAME

See Also:

• Constant Field Values

MODE_TABBED_STYLENAME

public static final String MODE_TABBED_STYLENAME

See Also:

• Constant Field Values

MODE_SINGLE_STYLENAME

public static final String MODE_SINGLE_STYLENAME

See Also:

• Constant Field Values

STATE_INITIAL_STYLENAME

public static final String STATE_INITIAL_STYLENAME

See Also:

• Constant Field Values

STATE_WINDOWS_STYLENAME

public static final String STATE_WINDOWS_STYLENAME

See Also:

• Constant Field Values

SINGLE_CONTAINER_STYLENAME

public static final String SINGLE_CONTAINER_STYLENAME

See Also:

• Constant Field Values

TABBED_CONTAINER_STYLENAME

public static final String TABBED_CONTAINER_STYLENAME

See Also:

• Constant Field Values

INITIAL_LAYOUT_STYLENAME

public static final String INITIAL_LAYOUT_STYLENAME

See Also:

• Constant Field Values

mode

protected AppWorkArea.Mode mode

state

protected AppWorkArea.State state

initialLayout

protected VBoxLayout initialLayout

tabbedContainer

protected HasTabSheetBehaviour tabbedContainer

singleContainer

protected JmixSingleModeContainer singleContainer

shortcutsInitialized

protected boolean shortcutsInitialized

urlStateCounter

protected int urlStateCounter

messages

protected Messages messages

Constructor Details

AppWorkAreaImpl

public AppWorkAreaImpl()

Method Details

initComponent

protected void initComponent(com.vaadin.ui.CssLayout component)

createComponent

protected com.vaadin.ui.CssLayout createComponent()

setApplicationContext

@Autowired
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Overrides:

setApplicationContext in class AbstractComponent<com.vaadin.ui.CssLayout>

createInitialLayout

protected VBoxLayout createInitialLayout()

setStyleName

public void setStyleName(@Nullable
 String name)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Overrides:

setStyleName in class AbstractComponent<com.vaadin.ui.CssLayout>

Parameters:

name - one or more style names separated by space.

getStyleName

public String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class AbstractComponent<com.vaadin.ui.CssLayout>

Returns:

current style name.

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<com.vaadin.ui.CssLayout>

getInitialLayout

@Nullable
public VBoxLayout getInitialLayout()

Specified by:

getInitialLayout in interface AppWorkArea

Returns:

an initial layout

setInitialLayout

public void setInitialLayout(VBoxLayout initialLayout)

Description copied from interface: AppWorkArea

Sets the initial layout.

Unable to change initial layout in AppWorkArea.State.WINDOW_CONTAINER state.

Specified by:

setInitialLayout in interface AppWorkArea

Parameters:

initialLayout - an initial layout

See Also:

• VBoxLayout

addStateChangeListener

public Subscription addStateChangeListener(Consumer<AppWorkArea.StateChangeEvent> listener)

Description copied from interface: AppWorkArea

Adds a listener that will be notified when a work area state is changed.

Specified by:

addStateChangeListener in interface AppWorkArea

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

getMode

public AppWorkArea.Mode getMode()

Specified by:

getMode in interface AppWorkArea

Returns:

a mode

setMode

public void setMode(AppWorkArea.Mode mode)

Description copied from interface: AppWorkArea

Sets a mode. The default value is AppWorkArea.Mode.TABBED.

Unable to change a mode in AppWorkArea.State.WINDOW_CONTAINER state.

Specified by:

setMode in interface AppWorkArea

Parameters:

mode - a mode

createTabbedModeContainer

protected HasTabSheetBehaviour createTabbedModeContainer()

reflectTabChangeToUrl

protected void reflectTabChangeToUrl(boolean userOriginated)

createTabSheetActionHandler

protected com.vaadin.event.Action.Handler createTabSheetActionHandler(HasTabSheetBehaviour tabSheet)

createSingleModeContainer

protected JmixSingleModeContainer createSingleModeContainer()

getTabbedWindowContainer

public HasTabSheetBehaviour getTabbedWindowContainer()

getSingleWindowContainer

public JmixSingleModeContainer getSingleWindowContainer()

switchTo

public void switchTo(AppWorkArea.State state)

Description copied from interface: AppWorkArea

INTERNAL. Managed by the screen control mechanism Screens.

Sets a new state. The default value is AppWorkArea.State.INITIAL_LAYOUT.

Specified by:

switchTo in interface AppWorkArea

Parameters:

state - new state

getState

public AppWorkArea.State getState()

Specified by:

getState in interface AppWorkArea

Returns:

a state

getInnerComponents

public Collection<Component> getInnerComponents()

Specified by:

getInnerComponents in interface HasInnerComponents

attached

public void attached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been attached.

Specified by:

attached in interface AttachNotifier

Overrides:

attached in class AbstractComponent<com.vaadin.ui.CssLayout>

detached

public void detached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been detached.

Specified by:

detached in interface AttachNotifier

Overrides:

detached in class AbstractComponent<com.vaadin.ui.CssLayout>

getOpenedTabCount

public int getOpenedTabCount()

getOpenedWorkAreaScreensStream

public Stream<Screen> getOpenedWorkAreaScreensStream()

Description copied from interface: AppWorkArea

Returns all opened screens that are inside the work area.

Specified by:

getOpenedWorkAreaScreensStream in interface AppWorkArea

Returns:

opened screens stream

getActiveWorkAreaScreensStream

public Stream<Screen> getActiveWorkAreaScreensStream()

Description copied from interface: AppWorkArea

Returns all active screens that are inside the work area.

Specified by:

getActiveWorkAreaScreensStream in interface AppWorkArea

Returns:

active screens stream

getCurrentBreadcrumbs

public Collection<Screen> getCurrentBreadcrumbs()

Description copied from interface: AppWorkArea

Returns all screens that are inside the current breadcrumbs.

Specified by:

getCurrentBreadcrumbs in interface AppWorkArea

Returns:

screens that are inside the current breadcrumbs

isWindowClosePrevented

protected boolean isWindowClosePrevented(Window window,
 Window.CloseOrigin closeOrigin)

closeAllTabWindows

protected void closeAllTabWindows(com.vaadin.ui.ComponentContainer container)

closeOtherTabWindows

protected void closeOtherTabWindows(com.vaadin.ui.ComponentContainer container)

closeWindowStack

protected boolean closeWindowStack(Screens.WindowStack windowStack)

initTabShortcuts

protected void initTabShortcuts()

createCloseShortcut

protected com.vaadin.event.ShortcutListener createCloseShortcut(RootWindow topLevelWindow)

createNextWindowTabShortcut

protected com.vaadin.event.ShortcutListener createNextWindowTabShortcut(RootWindow topLevelWindow)

createPreviousWindowTabShortcut

protected com.vaadin.event.ShortcutListener createPreviousWindowTabShortcut(RootWindow topLevelWindow)

closeWindowByShortcut

protected void closeWindowByShortcut(RootWindow topLevelWindow)

getWindowStacks

protected List<WindowBreadCrumbs> getWindowStacks()

moveFocus

protected void moveFocus(TabSheetBehaviour tabSheet,
 String tabId)

isNotCloseable

public boolean isNotCloseable(Window window)

hasModalWindow

protected boolean hasModalWindow()

getCurrentWindowContainer

@Nullable
protected TabWindowContainer getCurrentWindowContainer()

loadModeFromSettings

protected void loadModeFromSettings()

generateUrlStateMark

public int generateUrlStateMark()

fireTabChangedEvent

protected void fireTabChangedEvent(TabSheetBehaviour tabSheet)