io.jmix.ui.component.impl

Class TabWindowImpl

java.lang.Object

io.jmix.ui.component.impl.WindowImpl

io.jmix.ui.component.impl.TabWindowImpl

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, HasComponents, HasMargin, HasSpacing, HasSubParts, FrameImplementation, WindowImplementation, OrderedContainer, SecuredActionsHolder, SupportsExpandRatio, TabWindow, Window

public class TabWindowImpl
extends WindowImpl
implements TabWindow

Nested Class Summary

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

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

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

ExpandingLayout.ExpandDirection

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 and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected Window.ContentSwitchMode	contentSwitchMode

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

actionsHolder, actionsPermissions, allComponents, C_WINDOW_LAYOUT, caption, closeable, component, context, defaultScreenWindow, description, element, facets, focusComponentId, frameOwner, icon, icons, id, ownComponents, resolvedState

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

NAME

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

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
TabWindowImpl()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.Layout	asSingleWindow()
protected com.vaadin.ui.TabSheet.Tab	asTabWindow()
protected com.vaadin.ui.TabSheet.Tab	findTab()
java.lang.String	formatTabCaption()
java.lang.String	formatTabDescription()
Window.ContentSwitchMode	getContentSwitchMode() Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCaption(java.lang.String caption) Sets the component's caption.
void	setCloseable(boolean closeable) Sets the closable status for the window.
void	setContentSwitchMode(Window.ContentSwitchMode mode) Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setDescription(java.lang.String description) Sets the component's description.
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
protected void	updateCaptionAndDescription()

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

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, createLayout, disableEventListeners, enableEventListeners, expand, findAndFocusChildComponent, fireBeforeClose, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getComponent, getComponent, getComponent, getComponents, getComponentToFocus, getComposition, getContainer, getContext, getDescription, getEventHub, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getId, getMargin, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getRegisteredComponent, getResolvedState, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getXmlDescriptor, handleValidationErrors, indexOf, initUiEventListeners, isCloseable, isDefaultScreenWindow, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isValid, isVisible, isVisibleRecursive, publish, registerComponent, remove, removeAction, removeAction, removeAll, removeAllActions, removeFacet, removeStyleName, resetExpanded, setAlignment, setContext, setDefaultScreenWindow, setEnabled, setExpandRatio, setFocusComponent, setFrame, setFrameOwner, setHeight, setIconFromSet, setIcons, setId, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setResolvedState, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setXmlDescriptor, unregisterComponent, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAll, 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.Window

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

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

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

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

expand, getExpandDirection, isExpanded, resetExpanded

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

add, getComponent, getComponentNN, indexOf

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

add, add, remove, remove, removeAll

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

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

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

getFrame, setFrame

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

getSpacing, setSpacing

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

getMargin, setMargin, setMargin, setMargin

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

getIcon, setIconFromSet

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

getCaption

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

getDescription

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

getExpandRatio, setExpandRatio

Field Detail

contentSwitchMode

protected Window.ContentSwitchMode contentSwitchMode

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Detail

TabWindowImpl

public TabWindowImpl()

Method Detail

setApplicationContext

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

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

Overrides:

setIcon in class WindowImpl

setCloseable

public void setCloseable(boolean closeable)

Description copied from interface: Window

Sets the closable status for the window.

Specified by:

setCloseable in interface Window

Overrides:

setCloseable in class WindowImpl

Parameters:

closeable - closeable flag

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Overrides:

setCaption in class WindowImpl

Parameters:

caption - the new component's caption

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Overrides:

setDescription in class WindowImpl

Parameters:

description - the new description to set

updateCaptionAndDescription

protected void updateCaptionAndDescription()

asTabWindow

@Nullable
protected com.vaadin.ui.TabSheet.Tab asTabWindow()

asSingleWindow

@Nullable
protected com.vaadin.ui.Layout asSingleWindow()

findTab

@Nullable
protected com.vaadin.ui.TabSheet.Tab findTab()

formatTabCaption

public java.lang.String formatTabCaption()

Specified by:

formatTabCaption in interface TabWindow

Returns:

formatted tab caption

formatTabDescription

public java.lang.String formatTabDescription()

Specified by:

formatTabDescription in interface TabWindow

Returns:

formatted tab tooltip text

getContentSwitchMode

public Window.ContentSwitchMode getContentSwitchMode()

Description copied from interface: TabWindow

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

Specified by:

getContentSwitchMode in interface TabWindow

Returns:

one of the ContentSwitchMode enum values

setContentSwitchMode

public void setContentSwitchMode(Window.ContentSwitchMode mode)

Description copied from interface: TabWindow

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

Specified by:

setContentSwitchMode in interface TabWindow

Parameters:

mode - one of the ContentSwitchMode enum values