WindowImpl (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.component.impl.WindowImpl

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, Window

Direct Known Subclasses:

DialogWindowImpl, RootWindowImpl, TabWindowImpl
```
public abstract class WindowImpl
extends java.lang.Object
implements Window, Component.Wrapper, Component.HasXmlDescriptor, SecuredActionsHolder, Component.HasIcon, FrameImplementation, WindowImplementation
```

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 FrameActionsHolder`	`actionsHolder`
`protected ActionsPermissions`	`actionsPermissions`
`protected java.util.Map<java.lang.String,Component>`	`allComponents`
`protected static java.lang.String`	`C_WINDOW_LAYOUT`
`protected java.lang.String`	`caption`
`protected boolean`	`closeable`
`protected com.vaadin.ui.AbstractOrderedLayout`	`component`
`protected WindowContext`	`context`
`protected boolean`	`defaultScreenWindow`
`protected java.lang.String`	`description`
`protected org.dom4j.Element`	`element`
`protected java.util.Set<Facet>`	`facets`
`protected java.lang.String`	`focusComponentId`
`protected Screen`	`frameOwner`
`protected java.lang.String`	`icon`
`protected Icons`	`icons`
`protected java.lang.String`	`id`
`protected java.util.List<Component>`	`ownComponents`
`protected NavigationState`	`resolvedState`

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

WindowImpl()

Constructors
Constructor and Description
`WindowImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Component childComponent)` Adds a component to this container.
`void`	`add(Component childComponent, int index)`
`void`	`addAction(Action action)` Add an action to the component
`void`	`addAction(Action action, int index)` Add an action to the component with index.
`io.jmix.core.common.event.Subscription`	`addBeforeWindowCloseListener(java.util.function.Consumer<Window.BeforeCloseEvent> listener)` Registers a new before window close listener.
`void`	`addFacet(Facet facet)` Registers the passed non-visual component in the frame.
`void`	`addStyleName(java.lang.String styleName)` Adds one or more style names to this component.
`protected com.vaadin.ui.AbstractOrderedLayout`	`createLayout()`
`protected void`	`disableEventListeners()`
`protected void`	`enableEventListeners()`
`void`	`expand(Component childComponent)` Specifies the component that will be given maximum available space.
`boolean`	`findAndFocusChildComponent()`
`void`	`fireBeforeClose(Window.BeforeCloseEvent event)`
`Action`	`getAction(java.lang.String id)`
`java.util.Collection<Action>`	`getActions()`
`ActionsPermissions`	`getActionsPermissions()`
`Component.Alignment`	`getAlignment()`
`java.lang.String`	`getCaption()`
`com.vaadin.ui.Component`	`getComponent()`
`Component`	`getComponent(int index)` Returns the component at the given position.
`Component`	`getComponent(java.lang.String id)` Gets a component belonging to the whole components tree below this container.
`java.util.Collection<Component>`	`getComponents()` Gets all components belonging to the whole components tree below this container.
`protected Component.Focusable`	`getComponentToFocus(java.util.Iterator<Component> componentsIterator)`
`com.vaadin.ui.Component`	`getComposition()`
`protected com.vaadin.ui.ComponentContainer`	`getContainer()`
`WindowContext`	`getContext()`
`java.lang.String`	`getDescription()`
`protected io.jmix.core.common.event.EventHub`	`getEventHub()`
`ExpandingLayout.ExpandDirection`	`getExpandDirection()`
`float`	`getExpandRatio(Component component)`
`Facet`	`getFacet(java.lang.String id)` Finds registered facet by ID.
`java.util.stream.Stream<Facet>`	`getFacets()`
`java.lang.String`	`getFocusComponent()`
`Frame`	`getFrame()`
`Screen`	`getFrameOwner()`
`float`	`getHeight()` Get component height in `Component.getHeightSizeUnit()`
`SizeUnit`	`getHeightSizeUnit()` Gets the height property units.
`java.lang.String`	`getIcon()` Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
`java.lang.String`	`getId()` Component ID as defined in `id` attribute
`MarginInfo`	`getMargin()`
`java.lang.String`	`getMaxHeight()`
`java.lang.String`	`getMaxWidth()`
`java.lang.String`	`getMinHeight()`
`java.lang.String`	`getMinWidth()`
`Component`	`getOwnComponent(java.lang.String id)` Gets component directly owned by this container.
`java.util.Collection<Component>`	`getOwnComponents()` Gets all components directly owned by this container.
`java.util.stream.Stream<Component>`	`getOwnComponentsStream()` Gets stream of all components directly owned by this container.
`Component`	`getParent()`
`Component`	`getRegisteredComponent(java.lang.String id)` INTERNAL.
`NavigationState`	`getResolvedState()`
`boolean`	`getSpacing()`
`java.lang.String`	`getStyleName()` Styles implementation is client-type-specific.
`float`	`getWidth()` Get component width in `Component.getWidthSizeUnit()`
`SizeUnit`	`getWidthSizeUnit()` Gets the width property units.
`org.dom4j.Element`	`getXmlDescriptor()`
`protected boolean`	`handleValidationErrors(ValidationErrors errors)`
`int`	`indexOf(Component component)`
`void`	`initUiEventListeners()`
`boolean`	`isCloseable()`
`boolean`	`isDefaultScreenWindow()`
`boolean`	`isEnabled()` Is the component enabled? Note that this method only returns the status of the component and does not take parents into account.
`boolean`	`isEnabledRecursive()`
`boolean`	`isExpanded(Component component)` Returns true if the component occupies the maximum available space.
`boolean`	`isResponsive()` Is the component responsive?
`boolean`	`isValid()` Check validity by invoking validators on all components which support them.
`boolean`	`isVisible()` Is the component visible? A component is visible only if all its parents are also visible.
`boolean`	`isVisibleRecursive()`
`protected <E> void`	`publish(java.lang.Class<E> eventType, E event)`
`void`	`registerComponent(Component component)` INTERNAL.
`void`	`remove(Component childComponent)` Removes a component from this container.
`void`	`removeAction(Action action)` Remove the action from the component
`void`	`removeAction(java.lang.String id)` Remove the action by its ID.
`void`	`removeAll()` Removes all components from this container.
`void`	`removeAllActions()` Remove all actions from the component
`void`	`removeFacet(Facet facet)` Removes the non-visual component from the frame.
`void`	`removeStyleName(java.lang.String styleName)` Removes one or more style names from component.
`void`	`resetExpanded()` Resets the expanded component and provides equal space for all nested components.
`void`	`setAlignment(Component.Alignment alignment)`
`void`	`setCaption(java.lang.String caption)` Sets the component's caption.
`void`	`setCloseable(boolean closeable)` Sets the closable status for the window.
`void`	`setContext(FrameContext ctx)` INTERNAL.
`void`	`setDefaultScreenWindow(boolean defaultScreenWindow)`
`void`	`setDescription(java.lang.String description)` Sets the component's description.
`void`	`setEnabled(boolean enabled)` Sets the component enabled state.
`void`	`setExpandRatio(Component component, float ratio)` Sets expand ratio for the component.
`void`	`setFocusComponent(java.lang.String componentId)` Sets a component to be focused after the screen is opened.
`void`	`setFrame(Frame frame)`
`void`	`setFrameOwner(Screen controller)`
`void`	`setHeight(java.lang.String height)` Set component height in `Component.getHeightSizeUnit()`
`void`	`setIcon(java.lang.String icon)` Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
`void`	`setIconFromSet(Icons.Icon icon)` Set an icon from an icon set.
`protected void`	`setIcons(Icons icons)`
`void`	`setId(java.lang.String id)` Set component ID
`void`	`setMargin(MarginInfo marginInfo)`
`void`	`setMaxHeight(java.lang.String maxHeight)` Sets maximum CSS height for window layout.
`void`	`setMaxWidth(java.lang.String maxWidth)` Sets maximum CSS width for window layout.
`void`	`setMinHeight(java.lang.String minHeight)` Sets minimum CSS height for window layout.
`void`	`setMinWidth(java.lang.String minWidth)` Sets minimum CSS width for window layout.
`void`	`setParent(Component parent)` INTERNAL. `ComponentContainer.add(Component)` is normally used for adding components to a parent and the used method will call this method implicitly.
`void`	`setResolvedState(NavigationState resolvedState)`
`void`	`setResponsive(boolean responsive)` Sets component to be responsive by width and height.
`void`	`setSpacing(boolean enabled)`
`void`	`setStyleName(java.lang.String name)` Sets one or more style names of the component, replacing any previous styles.
`void`	`setVisible(boolean visible)` Sets visibility value for the component.
`void`	`setWidth(java.lang.String width)` Set component width in `Component.getWidthSizeUnit()`}
`void`	`setXmlDescriptor(org.dom4j.Element element)`
`void`	`unregisterComponent(Component component)` INTERNAL.
`protected <E> boolean`	`unsubscribe(java.lang.Class<E> eventType, java.util.function.Consumer<E> listener)`
`<X> X`	`unwrap(java.lang.Class<X> internalComponentClass)` Get client specific component instance.
`<X> X`	`unwrapComposition(java.lang.Class<X> internalCompositionClass)` Get the outmost external container of client specific component instance.
`<X> X`	`unwrapCompositionOrNull(java.lang.Class<X> internalCompositionClass)` Get the outmost external container of client specific component instance.
`<X> X`	`unwrapOrNull(java.lang.Class<X> internalComponentClass)` Get client specific component instance.
`void`	`validate()` Check validity by invoking validators on all components which support them.
`boolean`	`validate(java.util.List<Validatable> fields)` Checks validity by invoking validators on specified components which support them and show validation result notification.
`boolean`	`validateAll()` Checks validity by invoking validators on all components which support them and show validation result notification.
`<X> void`	`withUnwrapped(java.lang.Class<X> internalComponentClass, java.util.function.Consumer<X> action)` Performs the given `action` with underlying component if it can be casted to the given `internalComponentClass`.
`<X> void`	`withUnwrappedComposition(java.lang.Class<X> internalCompositionClass, java.util.function.Consumer<X> action)` Get the outmost external container of client specific component instance and performs the given `action`.

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.Frame
getFacetNN

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

Methods inherited from interface io.jmix.ui.component.ComponentContainer
add, remove

Methods inherited from interface io.jmix.ui.component.Component
setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

Methods inherited from interface io.jmix.ui.component.HasComponents
focusFirstComponent, getComponentNN

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

- Field Detail
  - C_WINDOW_LAYOUT
```
protected static final java.lang.String C_WINDOW_LAYOUT
```
    See Also:
    
    Constant Field Values
  - id
```
protected java.lang.String id
```
  - facets
```
protected java.util.Set<Facet> facets
```
  - ownComponents
```
protected java.util.List<Component> ownComponents
```
  - allComponents
```
protected java.util.Map<java.lang.String,Component> allComponents
```
  - focusComponentId
```
protected java.lang.String focusComponentId
```
  - component
```
protected com.vaadin.ui.AbstractOrderedLayout component
```
  - frameOwner
```
protected Screen frameOwner
```
  - element
```
protected org.dom4j.Element element
```
  - context
```
protected WindowContext context
```
  - icon
```
protected java.lang.String icon
```
  - caption
```
protected java.lang.String caption
```
  - description
```
protected java.lang.String description
```
  - actionsHolder
```
protected FrameActionsHolder actionsHolder
```
  - actionsPermissions
```
protected ActionsPermissions actionsPermissions
```
  - icons
```
protected Icons icons
```
  - closeable
```
protected boolean closeable
```
  - resolvedState
```
protected NavigationState resolvedState
```
  - defaultScreenWindow
```
protected boolean defaultScreenWindow
```
- Constructor Detail
  - WindowImpl
```
public WindowImpl()
```
- Method Detail
  - getEventHub
```
protected io.jmix.core.common.event.EventHub getEventHub()
```
  - publish
```
protected <E> void publish(java.lang.Class<E> eventType,
                           E event)
```
  - unsubscribe
```
protected <E> boolean unsubscribe(java.lang.Class<E> eventType,
                                  java.util.function.Consumer<E> listener)
```
  - setIcons
```
@Autowired
protected void setIcons(Icons icons)
```
  - disableEventListeners
```
protected void disableEventListeners()
```
  - enableEventListeners
```
protected void enableEventListeners()
```
  - createLayout
```
protected com.vaadin.ui.AbstractOrderedLayout createLayout()
```
  - getContainer
```
protected com.vaadin.ui.ComponentContainer getContainer()
```
  - addFacet
```
public void addFacet(Facet facet)
```
    Description copied from interface: Frame
    
    Registers the passed non-visual component in the frame.
    
    Specified by:
    
    addFacet in interface Frame
    
    Parameters:
    
    facet - facet
  - getFacet
```
@Nullable
public Facet getFacet(java.lang.String id)
```
    Description copied from interface: Frame
    
    Finds registered facet by ID.
    
    Specified by:
    
    getFacet in interface Frame
    
    Parameters:
    
    id - facet ID
    
    Returns:
    
    facet instance or null
  - removeFacet
```
public void removeFacet(Facet facet)
```
    Description copied from interface: Frame
    
    Removes the non-visual component from the frame.
    
    Specified by:
    
    removeFacet in interface Frame
    
    Parameters:
    
    facet - facet
  - getFacets
```
public java.util.stream.Stream<Facet> getFacets()
```
    Specified by:
    
    getFacets in interface Frame
    
    Returns:
    
    stream of registered non-visual components
  - registerComponent
```
public void registerComponent(Component component)
```
    Description copied from interface: FrameImplementation
    
    INTERNAL. Don't call from application code.
    
    Specified by:
    
    registerComponent in interface FrameImplementation
  - unregisterComponent
```
public void unregisterComponent(Component component)
```
    Description copied from interface: FrameImplementation
    
    INTERNAL. Don't call from application code.
    
    Specified by:
    
    unregisterComponent in interface FrameImplementation
  - getRegisteredComponent
```
@Nullable
public Component getRegisteredComponent(java.lang.String id)
```
    Description copied from interface: FrameImplementation
    
    INTERNAL. Don't call from application code.
    
    Specified by:
    
    getRegisteredComponent in interface FrameImplementation
  - getStyleName
```
public java.lang.String getStyleName()
```
    Description copied from interface: Component
    
    Styles implementation is client-type-specific.
    
    Specified by:
    
    getStyleName in interface Component
    
    Returns:
    
    current style name.
  - setStyleName
```
public void setStyleName(@Nullable
                         java.lang.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
    
    Parameters:
    
    name - one or more style names separated by space.
  - addStyleName
```
public void addStyleName(java.lang.String styleName)
```
    Description copied from interface: Component
    
    Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names.
    
    Specified by:
    
    addStyleName in interface Component
    
    Parameters:
    
    styleName - one or more style names separated by space.
  - removeStyleName
```
public void removeStyleName(java.lang.String styleName)
```
    Description copied from interface: Component
    
    Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.
    
    Specified by:
    
    removeStyleName in interface Component
    
    Parameters:
    
    styleName - one or more style names separated by space.
  - unwrap
```
public <X> X unwrap(java.lang.Class<X> internalComponentClass)
```
    Description copied from interface: Component
    Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
    Example:
```
 com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);
 
```
    Specified by:
    
    unwrap in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalComponentClass - class of underlying component implementation based on Vaadin or Swing
    
    Returns:
    
    internal client specific component
  - unwrapOrNull
```
@Nullable
public <X> X unwrapOrNull(java.lang.Class<X> internalComponentClass)
```
    Description copied from interface: Component
    Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
    Returns null if underlying component cannot be casted to the given internalComponentClass. Example:
```
 com.vaadin.ui.TextField vTextField = textField.unwrapOrNull(com.vaadin.ui.TextField.class);
 
```
    Specified by:
    
    unwrapOrNull in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalComponentClass - class of underlying component implementation based on Vaadin or Swing
    
    Returns:
    
    internal client specific component or null if it cannot be casted to given class
  - withUnwrapped
```
public <X> void withUnwrapped(java.lang.Class<X> internalComponentClass,
                              java.util.function.Consumer<X> action)
```
    Description copied from interface: Component
    Performs the given action with underlying component if it can be casted to the given internalComponentClass. Example:
```
 textField.withUnwrapped(com.vaadin.ui.TextField.class, vTextField -> {
     // do something
 });
 
```
    Specified by:
    
    withUnwrapped in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalComponentClass - class of underlying component implementation based on Vaadin or Swing
    
    action - action to perform if underlying component can be casted to given class
  - unwrapComposition
```
public <X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)
```
    Description copied from interface: Component
    Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
    Example:
```
 com.vaadin.ui.Layout vLayout = table.unwrapComposition(com.vaadin.ui.Layout.class);
 
```
    Specified by:
    
    unwrapComposition in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing
    
    Returns:
    
    internal client specific component
  - unwrapCompositionOrNull
```
@Nullable
public <X> X unwrapCompositionOrNull(java.lang.Class<X> internalCompositionClass)
```
    Description copied from interface: Component
    Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
    Returns null if composition cannot be casted to given internalCompositionClass. Example:
```
 com.vaadin.ui.Layout vLayout = table.unwrapCompositionOrNull(com.vaadin.ui.Layout.class);
 
```
    Specified by:
    
    unwrapCompositionOrNull in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing
    
    Returns:
    
    internal client specific component or null if cannot be casted to given class
  - withUnwrappedComposition
```
public <X> void withUnwrappedComposition(java.lang.Class<X> internalCompositionClass,
                                         java.util.function.Consumer<X> action)
```
    Description copied from interface: Component
    Get the outmost external container of client specific component instance and performs the given action.
    Can be used in client module to simplify invocation of underlying API.
    Example:
```
 table.withUnwrappedComposition(com.vaadin.ui.Layout.class, vLayout -> {
     // do something
 });
 
```
    Specified by:
    
    withUnwrappedComposition in interface Component
    
    Type Parameters:
    
    X - type of internal class
    
    Parameters:
    
    internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing
    
    action - to perform if underlying composition can be casted to given class
  - getSpacing
```
public boolean getSpacing()
```
    Specified by:
    
    getSpacing in interface HasSpacing
  - setSpacing
```
public void setSpacing(boolean enabled)
```
    Specified by:
    
    setSpacing in interface HasSpacing
  - getMargin
```
public MarginInfo getMargin()
```
    Specified by:
    
    getMargin in interface HasMargin
  - setMargin
```
public void setMargin(MarginInfo marginInfo)
```
    Specified by:
    
    setMargin in interface HasMargin
  - setMinWidth
```
public void setMinWidth(java.lang.String minWidth)
```
    Description copied from interface: Window
    
    Sets minimum CSS width for window layout. Examples: "640px", "auto".
    
    Specified by:
    
    setMinWidth in interface Window
    
    Parameters:
    
    minWidth - minimum width
  - getMinWidth
```
@Nullable
public java.lang.String getMinWidth()
```
    Specified by:
    
    getMinWidth in interface Window
    
    Returns:
    
    previously set minimal CSS width or null
  - setMaxWidth
```
public void setMaxWidth(java.lang.String maxWidth)
```
    Description copied from interface: Window
    
    Sets maximum CSS width for window layout. Examples: "640px", "100%".
    
    Specified by:
    
    setMaxWidth in interface Window
    
    Parameters:
    
    maxWidth - maximum width
  - getMaxWidth
```
@Nullable
public java.lang.String getMaxWidth()
```
    Specified by:
    
    getMaxWidth in interface Window
    
    Returns:
    
    previously set maximum CSS width or null
  - setMinHeight
```
public void setMinHeight(java.lang.String minHeight)
```
    Description copied from interface: Window
    
    Sets minimum CSS height for window layout. Examples: "640px", "auto".
    
    Specified by:
    
    setMinHeight in interface Window
    
    Parameters:
    
    minHeight - minimum height
  - getMinHeight
```
@Nullable
public java.lang.String getMinHeight()
```
    Specified by:
    
    getMinHeight in interface Window
    
    Returns:
    
    previously set minimum CSS height or null
  - setMaxHeight
```
public void setMaxHeight(java.lang.String maxHeight)
```
    Description copied from interface: Window
    
    Sets maximum CSS height for window layout. Examples: "640px", "100%".
    
    Specified by:
    
    setMaxHeight in interface Window
    
    Parameters:
    
    maxHeight - maximum height
  - getMaxHeight
```
@Nullable
public java.lang.String getMaxHeight()
```
    Specified by:
    
    getMaxHeight in interface Window
    
    Returns:
    
    previously set maximum CSS height or null
  - addAction
```
public void addAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component
    
    Specified by:
    
    addAction in interface ActionsHolder
  - addAction
```
public void addAction(Action action,
                      int index)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component with index.
    
    Specified by:
    
    addAction in interface ActionsHolder
  - removeAction
```
public void removeAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Remove the action from the component
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAction
```
public void removeAction(java.lang.String id)
```
    Description copied from interface: ActionsHolder
    
    Remove the action by its ID. If there is no action with that ID, nothing happens.
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAllActions
```
public void removeAllActions()
```
    Description copied from interface: ActionsHolder
    
    Remove all actions from the component
    
    Specified by:
    
    removeAllActions in interface ActionsHolder
  - getActions
```
public java.util.Collection<Action> getActions()
```
    Specified by:
    
    getActions in interface ActionsHolder
    
    Returns:
    
    unmodifiable collection of actions
  - getAction
```
@Nullable
public Action getAction(java.lang.String id)
```
    Specified by:
    
    getAction in interface ActionsHolder
    
    Returns:
    
    an action by its ID, or null if not found
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Frame
    
    Check validity by invoking validators on all components which support them.
    
    Specified by:
    
    isValid in interface Frame
    
    Returns:
    
    true if all components are in valid state
  - validate
```
public void validate()
              throws ValidationException
```
    Description copied from interface: Frame
    
    Check validity by invoking validators on all components which support them.
    
    Specified by:
    
    validate in interface Frame
    
    Throws:
    
    ValidationException - if some components are currently in invalid state
  - validate
```
public boolean validate(java.util.List<Validatable> fields)
```
    Description copied from interface: Window
    
    Checks validity by invoking validators on specified components which support them and show validation result notification.
    
    Specified by:
    
    validate in interface Frame
    
    Specified by:
    
    validate in interface Window
    
    Returns:
    
    true if the validation was successful, false if there were any problems
  - validateAll
```
public boolean validateAll()
```
    Description copied from interface: Window
    
    Checks validity by invoking validators on all components which support them and show validation result notification.
    
    Specified by:
    
    validateAll in interface Frame
    
    Specified by:
    
    validateAll in interface Window
    
    Returns:
    
    true if the validation was successful, false if there were any problems
  - handleValidationErrors
```
protected boolean handleValidationErrors(ValidationErrors errors)
```
  - isCloseable
```
public boolean isCloseable()
```
    Specified by:
    
    isCloseable in interface Window
    
    Returns:
    
    true if the window can be closed by user with close button or keyboard shortcut
  - setCloseable
```
public void setCloseable(boolean closeable)
```
    Description copied from interface: Window
    
    Sets the closable status for the window.
    
    Specified by:
    
    setCloseable in interface Window
    
    Parameters:
    
    closeable - closeable flag
  - getFrameOwner
```
public Screen getFrameOwner()
```
    Specified by:
    
    getFrameOwner in interface Frame
    
    Specified by:
    
    getFrameOwner in interface Window
    
    Returns:
    
    UI controller of the window
    
    See Also:
    
    Screen, ScreenFragment
  - setFrameOwner
```
public void setFrameOwner(Screen controller)
```
    Specified by:
    
    setFrameOwner in interface WindowImplementation
  - initUiEventListeners
```
public void initUiEventListeners()
```
    Specified by:
    
    initUiEventListeners in interface WindowImplementation
  - getContext
```
public WindowContext getContext()
```
    Specified by:
    
    getContext in interface Frame
    
    Specified by:
    
    getContext in interface Window
    
    Returns:
    
    current window context
  - setContext
```
public void setContext(FrameContext ctx)
```
    Description copied from interface: FrameImplementation
    
    INTERNAL. Don't call from application code.
    
    Specified by:
    
    setContext in interface FrameImplementation
  - getComponentToFocus
```
@Nullable
protected Component.Focusable getComponentToFocus(java.util.Iterator<Component> componentsIterator)
```
  - getFocusComponent
```
public java.lang.String getFocusComponent()
```
    Specified by:
    
    getFocusComponent in interface Window
    
    Returns:
    
    an ID of the component which is set to be focused after the screen is opened
  - setFocusComponent
```
public void setFocusComponent(@Nullable
                              java.lang.String componentId)
```
    Description copied from interface: Window
    
    Sets a component to be focused after the screen is opened.
    
    Specified by:
    
    setFocusComponent in interface Window
    
    Parameters:
    
    componentId - component's ID in XML. If null, then first focusable component will be focused
  - addBeforeWindowCloseListener
```
public io.jmix.core.common.event.Subscription addBeforeWindowCloseListener(java.util.function.Consumer<Window.BeforeCloseEvent> listener)
```
    Description copied from interface: Window
    
    Registers a new before window close listener.
    
    Specified by:
    
    addBeforeWindowCloseListener in interface Window
    
    Parameters:
    
    listener - the listener to register
    
    Returns:
    
    a registration object for removing an event listener added to a window
  - fireBeforeClose
```
public void fireBeforeClose(Window.BeforeCloseEvent event)
```
  - getXmlDescriptor
```
@Nullable
public org.dom4j.Element getXmlDescriptor()
```
    Specified by:
    
    getXmlDescriptor in interface Component.HasXmlDescriptor
  - setXmlDescriptor
```
public void setXmlDescriptor(@Nullable
                             org.dom4j.Element element)
```
    Specified by:
    
    setXmlDescriptor in interface Component.HasXmlDescriptor
  - add
```
public void add(Component childComponent)
```
    Description copied from interface: ComponentContainer
    
    Adds a component to this container.
    
    Specified by:
    
    add in interface ComponentContainer
    
    Parameters:
    
    childComponent - a component to add
  - add
```
public void add(Component childComponent,
                int index)
```
    Specified by:
    
    add in interface OrderedContainer
  - indexOf
```
public int indexOf(Component component)
```
    Specified by:
    
    indexOf in interface OrderedContainer
  - getComponent
```
@Nullable
public Component getComponent(int index)
```
    Description copied from interface: OrderedContainer
    
    Returns the component at the given position.
    
    Specified by:
    
    getComponent in interface OrderedContainer
    
    Parameters:
    
    index - component index
    
    Returns:
    
    the component at the given index or null.
  - remove
```
public void remove(Component childComponent)
```
    Description copied from interface: ComponentContainer
    
    Removes a component from this container.
    
    Specified by:
    
    remove in interface ComponentContainer
    
    Parameters:
    
    childComponent - a component to remove
  - removeAll
```
public void removeAll()
```
    Description copied from interface: ComponentContainer
    
    Removes all components from this container.
    
    Specified by:
    
    removeAll in interface ComponentContainer
  - getOwnComponents
```
public java.util.Collection<Component> getOwnComponents()
```
    Description copied from interface: HasComponents
    
    Gets all components directly owned by this container.
    
    Specified by:
    
    getOwnComponents in interface HasComponents
    
    Returns:
    
    all components directly owned by this container
  - getOwnComponentsStream
```
public java.util.stream.Stream<Component> getOwnComponentsStream()
```
    Description copied from interface: HasComponents
    
    Gets stream of all components directly owned by this container.
    
    Specified by:
    
    getOwnComponentsStream in interface HasComponents
    
    Returns:
    
    stream of all components directly owned by this container
  - getComponents
```
public java.util.Collection<Component> getComponents()
```
    Description copied from interface: HasComponents
    
    Gets all components belonging to the whole components tree below this container.
    
    Specified by:
    
    getComponents in interface HasComponents
    
    Returns:
    
    all components belonging to the whole components tree below this container
  - getId
```
@Nullable
public java.lang.String getId()
```
    Description copied from interface: Component
    
    Component ID as defined in id attribute
    
    Specified by:
    
    getId in interface Component
  - setId
```
public void setId(@Nullable
                  java.lang.String id)
```
    Description copied from interface: Component
    
    Set component ID
    
    Specified by:
    
    setId in interface Component
  - getParent
```
@Nullable
public Component getParent()
```
    Specified by:
    
    getParent in interface Component
    
    Returns:
    
    parent of component.
  - setParent
```
public void setParent(@Nullable
                      Component parent)
```
    Description copied from interface: Component
    
    INTERNAL.
    ComponentContainer.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
    
    Specified by:
    
    setParent in interface Component
    
    Parameters:
    
    parent - Parent component
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Component
    
    Is the component enabled?
    Note that this method only returns the status of the component and does not take parents into account. Even though this method returns true the component can be disabled to the user if a parent is disabled.
    
    Specified by:
    
    isEnabled in interface Component
    
    Returns:
    
    true if the component enabled flag is set to true
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: Component
    
    Sets the component enabled state.
    The user can not interact with disabled components, which are shown with a style that indicates the status. Components are enabled by default.
    
    Specified by:
    
    setEnabled in interface Component
    
    Parameters:
    
    enabled - enabled flag
  - isResponsive
```
public boolean isResponsive()
```
    Description copied from interface: Component
    
    Is the component responsive?
    
    Specified by:
    
    isResponsive in interface Component
    
    Returns:
    
    true if the component applies conditional CSS rules for width / height sizes.
  - setResponsive
```
public void setResponsive(boolean responsive)
```
    Description copied from interface: Component
    
    Sets component to be responsive by width and height.
    If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.
    
    Specified by:
    
    setResponsive in interface Component
    
    Parameters:
    
    responsive - responsive flag
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: Component
    
    Is the component visible?
    A component is visible only if all its parents are also visible. This is not checked by this method though, so even if this method returns true, the component can be hidden from the user because a parent is set to invisible.
    
    Specified by:
    
    isVisible in interface Component
    
    Returns:
    
    true if the component visibility is set to true
  - setVisible
```
public void setVisible(boolean visible)
```
    Description copied from interface: Component
    
    Sets visibility value for the component.
    Visible components are drawn in the user interface, while invisible ones are not. The effect is not a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent.
    
    Specified by:
    
    setVisible in interface Component
    
    Parameters:
    
    visible - visible flag
  - isVisibleRecursive
```
public boolean isVisibleRecursive()
```
    Specified by:
    
    isVisibleRecursive in interface Component
    
    Returns:
    
    true if the component and all its parent components are visible
  - isEnabledRecursive
```
public boolean isEnabledRecursive()
```
    Specified by:
    
    isEnabledRecursive in interface Component
    
    Returns:
    
    true if the component and all its parent components are enabled
  - getHeight
```
public float getHeight()
```
    Description copied from interface: Component
    
    Get component height in Component.getHeightSizeUnit()
    
    Specified by:
    
    getHeight in interface Component
  - setHeight
```
public void setHeight(@Nullable
                      java.lang.String height)
```
    Description copied from interface: Component
    
    Set component height in Component.getHeightSizeUnit()
    
    Specified by:
    
    setHeight in interface Component
  - getHeightSizeUnit
```
public SizeUnit getHeightSizeUnit()
```
    Description copied from interface: Component
    
    Gets the height property units.
    
    Specified by:
    
    getHeightSizeUnit in interface Component
    
    Returns:
    
    units used in height property.
  - getWidth
```
public float getWidth()
```
    Description copied from interface: Component
    
    Get component width in Component.getWidthSizeUnit()
    
    Specified by:
    
    getWidth in interface Component
  - setWidth
```
public void setWidth(@Nullable
                     java.lang.String width)
```
    Description copied from interface: Component
    
    Set component width in Component.getWidthSizeUnit()}
    
    Specified by:
    
    setWidth in interface Component
  - getWidthSizeUnit
```
public SizeUnit getWidthSizeUnit()
```
    Description copied from interface: Component
    
    Gets the width property units.
    
    Specified by:
    
    getWidthSizeUnit in interface Component
    
    Returns:
    
    units used in the width property.
  - getOwnComponent
```
@Nullable
public Component getOwnComponent(java.lang.String id)
```
    Description copied from interface: HasComponents
    
    Gets component directly owned by this container.
    
    Specified by:
    
    getOwnComponent in interface HasComponents
    
    Returns:
    
    component or null if not found
  - getComponent
```
@Nullable
public Component getComponent(java.lang.String id)
```
    Description copied from interface: HasComponents
    
    Gets a component belonging to the whole components tree below this container.
    
    Specified by:
    
    getComponent in interface HasComponents
    
    Returns:
    
    component or null if not found
  - getAlignment
```
public Component.Alignment getAlignment()
```
    Specified by:
    
    getAlignment in interface Component
  - setAlignment
```
public void setAlignment(Component.Alignment alignment)
```
    Specified by:
    
    setAlignment in interface Component
  - expand
```
public void expand(Component childComponent)
```
    Description copied from interface: ExpandingLayout
    
    Specifies the component that will be given maximum available space.
    
    Specified by:
    
    expand in interface ExpandingLayout
    
    Parameters:
    
    childComponent - the component
  - resetExpanded
```
public void resetExpanded()
```
    Description copied from interface: ExpandingLayout
    
    Resets the expanded component and provides equal space for all nested components.
    
    Specified by:
    
    resetExpanded in interface ExpandingLayout
  - isExpanded
```
public boolean isExpanded(Component component)
```
    Description copied from interface: ExpandingLayout
    
    Returns true if the component occupies the maximum available space.
    
    Specified by:
    
    isExpanded in interface ExpandingLayout
    
    Parameters:
    
    component - component to check
    
    Returns:
    
    true if the component occupies the maximum available space
  - getExpandDirection
```
public ExpandingLayout.ExpandDirection getExpandDirection()
```
    Specified by:
    
    getExpandDirection in interface ExpandingLayout
    
    Returns:
    
    expand direction
    
    See Also:
    
    ExpandingLayout.ExpandDirection
  - getComponent
```
public com.vaadin.ui.Component getComponent()
```
    Specified by:
    
    getComponent in interface Component.Wrapper
  - getComposition
```
public com.vaadin.ui.Component getComposition()
```
    Specified by:
    
    getComposition in interface Component.Wrapper
  - findAndFocusChildComponent
```
public boolean findAndFocusChildComponent()
```
  - getCaption
```
@Nullable
public java.lang.String getCaption()
```
    Specified by:
    
    getCaption in interface Component.HasCaption
    
    Returns:
    
    the caption of the component
  - 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
    
    Parameters:
    
    caption - the new component's caption
  - getDescription
```
@Nullable
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface Component.HasDescription
    
    Returns:
    
    the components description, used in tooltips
  - 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
    
    Parameters:
    
    description - the new description to set
  - getFrame
```
@Nullable
public Frame getFrame()
```
    Specified by:
    
    getFrame in interface Component.BelongToFrame
  - setFrame
```
public void setFrame(@Nullable
                     Frame frame)
```
    Specified by:
    
    setFrame in interface Component.BelongToFrame
  - getActionsPermissions
```
public ActionsPermissions getActionsPermissions()
```
    Specified by:
    
    getActionsPermissions in interface SecuredActionsHolder
    
    Returns:
    
    permissions container
  - getIcon
```
@Nullable
public java.lang.String getIcon()
```
    Description copied from interface: Component.HasIcon
    
    Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
    
    Specified by:
    
    getIcon in interface Component.HasIcon
  - 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
  - setIconFromSet
```
public void setIconFromSet(@Nullable
                           Icons.Icon icon)
```
    Description copied from interface: Component.HasIcon
    
    Set an icon from an icon set.
    
    Specified by:
    
    setIconFromSet in interface Component.HasIcon
  - setExpandRatio
```
public void setExpandRatio(Component component,
                           float ratio)
```
    Description copied from interface: SupportsExpandRatio
    
    Sets expand ratio for the component. The ratio must be greater than or equal to 0.
    
    Specified by:
    
    setExpandRatio in interface SupportsExpandRatio
    
    Parameters:
    
    component - component to expand with ratio
    
    ratio - ratio
  - getExpandRatio
```
public float getExpandRatio(Component component)
```
    Specified by:
    
    getExpandRatio in interface SupportsExpandRatio
    
    Parameters:
    
    component - component for which returns ratio
    
    Returns:
    
    ratio for the component, 0.0f by default
  - getResolvedState
```
@Nullable
public NavigationState getResolvedState()
```
  - setResolvedState
```
public void setResolvedState(NavigationState resolvedState)
```
  - isDefaultScreenWindow
```
public boolean isDefaultScreenWindow()
```
  - setDefaultScreenWindow
```
public void setDefaultScreenWindow(boolean defaultScreenWindow)
```

Class WindowImpl

Nested Class Summary

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

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

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

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Field Detail

C_WINDOW_LAYOUT

id

facets

ownComponents

allComponents

focusComponentId

component

frameOwner

element

context

icon

caption

description

actionsHolder

actionsPermissions

icons

closeable

resolvedState

defaultScreenWindow

Constructor Detail

WindowImpl

Method Detail

getEventHub

publish

unsubscribe

setIcons

disableEventListeners

enableEventListeners

createLayout

getContainer

addFacet

getFacet

removeFacet

getFacets

registerComponent

unregisterComponent

getRegisteredComponent

getStyleName

setStyleName

addStyleName

removeStyleName

unwrap

unwrapOrNull

withUnwrapped

unwrapComposition

unwrapCompositionOrNull

withUnwrappedComposition

getSpacing

setSpacing

getMargin

setMargin

setMinWidth

getMinWidth

setMaxWidth

getMaxWidth

setMinHeight

getMinHeight

setMaxHeight

getMaxHeight

addAction

addAction

removeAction