Package io.jmix.ui.component

Interface AppWorkArea

All Superinterfaces:

Component, Component.BelongToFrame

All Known Implementing Classes:

AppWorkAreaImpl

@StudioComponent(caption="WorkArea",
                 category="Main window",
                 xmlElement="workArea",
                 icon="io/jmix/ui/icon/mainwindow/workArea.svg",
                 canvasBehaviour=CONTAINER,
                 containerType=VERTICAL,
                 unsupportedProperties={"box.expandRatio","css","expand","responsive"})
public interface AppWorkArea
extends Component.BelongToFrame

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AppWorkArea.Mode	Work area mode
static enum	AppWorkArea.State	Work area state
static class	AppWorkArea.StateChangeEvent	Event that is fired when work area changed its state.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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.
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.
VBoxLayout	getInitialLayout()
AppWorkArea.Mode	getMode()
Stream<Screen>	getOpenedWorkAreaScreensStream()	Returns all opened screens that are inside the work area.
AppWorkArea.State	getState()
void	setInitialLayout(VBoxLayout initialLayout)	Sets the initial layout.
void	setMode(AppWorkArea.Mode mode)	Sets a mode.
void	switchTo(AppWorkArea.State state)	INTERNAL.

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

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

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

getFrame, setFrame

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getMode

AppWorkArea.Mode getMode()

Returns:

a mode

setMode

void setMode(AppWorkArea.Mode mode)

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

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

Parameters:

mode - a mode

getState

AppWorkArea.State getState()

Returns:

a state

switchTo

void switchTo(AppWorkArea.State state)

INTERNAL. Managed by the screen control mechanism Screens.

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

Parameters:

state - new state

getInitialLayout

@Nullable
VBoxLayout getInitialLayout()

Returns:

an initial layout

setInitialLayout

void setInitialLayout(VBoxLayout initialLayout)

Sets the initial layout.

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

Parameters:

initialLayout - an initial layout

See Also:

• VBoxLayout

addStateChangeListener

Subscription addStateChangeListener(Consumer<AppWorkArea.StateChangeEvent> listener)

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

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

getOpenedWorkAreaScreensStream

Stream<Screen> getOpenedWorkAreaScreensStream()

Returns all opened screens that are inside the work area.

Returns:

opened screens stream

getActiveWorkAreaScreensStream

Stream<Screen> getActiveWorkAreaScreensStream()

Returns all active screens that are inside the work area.

Returns:

active screens stream

getCurrentBreadcrumbs

Collection<Screen> getCurrentBreadcrumbs()

Returns all screens that are inside the current breadcrumbs.

Returns:

screens that are inside the current breadcrumbs