io.jmix.ui.component

Interface ExpandingLayout

All Superinterfaces:

Component, ComponentContainer, HasComponents

All Known Subinterfaces:

BoxLayout, DialogWindow, Fragment, FragmentImplementation, Frame, GroupBoxLayout, HBoxLayout, RootWindow, TabWindow, VBoxLayout, Window, WindowImplementation

All Known Implementing Classes:

AbstractBox, DialogWindowImpl, FragmentImpl, GroupBoxImpl, HBoxLayoutImpl, RootWindowImpl, TabWindowImpl, VBoxLayoutImpl, WindowImpl

public interface ExpandingLayout
extends ComponentContainer

Component container which can expand enclosing components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExpandingLayout.ExpandDirection Expand direction

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 inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
void	expand(Component component) Specifies the component that will be given maximum available space.
ExpandingLayout.ExpandDirection	getExpandDirection()
boolean	isExpanded(Component component) Returns true if the component occupies the maximum available space.
void	resetExpanded() Resets the expanded component and provides equal space for all nested components.

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

Method Detail

expand

void expand(Component component)

Specifies the component that will be given maximum available space.

Parameters:

component - the component

resetExpanded

void resetExpanded()

Resets the expanded component and provides equal space for all nested components.

isExpanded

boolean isExpanded(Component component)

Returns true if the component occupies the maximum available space.

Parameters:

component - component to check

Returns:

true if the component occupies the maximum available space

getExpandDirection

ExpandingLayout.ExpandDirection getExpandDirection()

Returns:

expand direction

See Also:

ExpandingLayout.ExpandDirection