Package io.jmix.ui.component

Interface TabWindow

All Superinterfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, ExpandingLayout, Frame, HasComponents, HasMargin, HasSpacing, HasSubParts, OrderedContainer, SupportsExpandRatio, Window

All Known Implementing Classes:

TabWindowImpl

public interface TabWindow
extends Window

Tab window UI component.

Nested Class Summary

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.ExpandingLayout

ExpandingLayout.ExpandDirection

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

Window.BeforeCloseEvent, Window.CloseOrigin, Window.Committable, Window.ContentSwitchMode, Window.HasUserIndicator, Window.HasWorkArea

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Name that is used to register a client type specific screen implementation in UiComponents

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

Method Summary

Modifier and Type	Method	Description
String	formatTabCaption()
String	formatTabDescription()
Window.ContentSwitchMode	getContentSwitchMode()	Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setContentSwitchMode(Window.ContentSwitchMode mode)	Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.

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

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

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

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

getCaption, setCaption

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

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

add, add, remove, remove, removeAll

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

expand, getExpandDirection, isExpanded, resetExpanded

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

addFacet, getFacet, getFacetNN, getFacets, isValid, removeFacet, validate

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

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

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

getMargin, setMargin, setMargin, setMargin

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

getSpacing, setSpacing

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

add, getComponent, getComponentNN, indexOf

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

getExpandRatio, setExpandRatio

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

addBeforeWindowCloseListener, getContext, getFocusComponent, getFrameOwner, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, isCloseable, setCloseable, setFocusComponent, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, validate, validateAll

Field Details

NAME

static final String NAME

Name that is used to register a client type specific screen implementation in UiComponents

See Also:

• Constant Field Values

Method Details

formatTabCaption

String formatTabCaption()

Returns:

formatted tab caption

formatTabDescription

String formatTabDescription()

Returns:

formatted tab tooltip text

getContentSwitchMode

Window.ContentSwitchMode getContentSwitchMode()

Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.

Returns:

one of the Window.ContentSwitchMode enum values

setContentSwitchMode

void setContentSwitchMode(Window.ContentSwitchMode mode)

Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.

Note that: a method invocation will take effect only if jmix.ui.component.mainTabSheetMode property is set to 'MANAGED'.

Parameters:

mode - one of the Window.ContentSwitchMode enum values