@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
Modifier and Type | Interface and Description |
---|---|
static class |
AppWorkArea.Mode
Work area mode
|
static class |
AppWorkArea.State
Work area state
|
static class |
AppWorkArea.StateChangeEvent
Event that is fired when work area changed its state.
|
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
io.jmix.core.common.event.Subscription |
addStateChangeListener(java.util.function.Consumer<AppWorkArea.StateChangeEvent> listener)
Adds a listener that will be notified when a work area state is changed.
|
java.util.stream.Stream<Screen> |
getActiveWorkAreaScreensStream()
Returns all active screens that are inside the work area.
|
java.util.Collection<Screen> |
getCurrentBreadcrumbs()
Returns all screens that are inside the current breadcrumbs.
|
VBoxLayout |
getInitialLayout() |
AppWorkArea.Mode |
getMode() |
java.util.stream.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.
|
getFrame, setFrame
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
static final java.lang.String NAME
AppWorkArea.Mode getMode()
void setMode(AppWorkArea.Mode mode)
AppWorkArea.Mode.TABBED
.
Unable to change a mode in AppWorkArea.State.WINDOW_CONTAINER
state.
mode
- a modeAppWorkArea.State getState()
void switchTo(AppWorkArea.State state)
Screens
.
Sets a new state. The default value is AppWorkArea.State.INITIAL_LAYOUT
.
state
- new state@Nullable VBoxLayout getInitialLayout()
void setInitialLayout(VBoxLayout initialLayout)
Unable to change initial layout in AppWorkArea.State.WINDOW_CONTAINER
state.
initialLayout
- an initial layoutVBoxLayout
io.jmix.core.common.event.Subscription addStateChangeListener(java.util.function.Consumer<AppWorkArea.StateChangeEvent> listener)
listener
- a listener to addjava.util.stream.Stream<Screen> getOpenedWorkAreaScreensStream()
java.util.stream.Stream<Screen> getActiveWorkAreaScreensStream()
java.util.Collection<Screen> getCurrentBreadcrumbs()