Package io.jmix.ui.component

Interface Frame

All Superinterfaces:

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

All Known Subinterfaces:

DialogWindow, Fragment, FragmentImplementation, RootWindow, TabWindow, Window, WindowImplementation

All Known Implementing Classes:

DialogWindowImpl, FragmentImpl, RootWindowImpl, TabWindowImpl, WindowImpl

public interface Frame
extends ExpandingLayout, OrderedContainer, Component.BelongToFrame, HasSpacing, HasMargin, ActionsHolder, Component.HasIcon, Component.HasCaption, SupportsExpandRatio

Root class of UI components having controller.

See Also:

• Window
• Fragment

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

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
void	addFacet(Facet facet)	Registers the passed non-visual component in the frame.
FrameContext	getContext()
Facet	getFacet(String id)	Finds registered facet by ID.
default Facet	getFacetNN(String id)	Finds registered facet by ID.
Stream<Facet>	getFacets()
FrameOwner	getFrameOwner()
boolean	isValid()	Check validity by invoking validators on all components which support them.
void	removeFacet(Facet facet)	Removes the non-visual component from the frame.
void	validate()	Check validity by invoking validators on all components which support them.
boolean	validate(List<Validatable> fields)	Check validity by invoking validators on specified components which support them and show validation result notification.
boolean	validateAll()	Check validity by invoking validators on all components which support them and show validation result notification.

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

Method Details

getFrameOwner

FrameOwner getFrameOwner()

Returns:

UI controller of the frame

See Also:

• Screen
• ScreenFragment

getContext

FrameContext getContext()

Returns:

current frame context

isValid

boolean isValid()

Check validity by invoking validators on all components which support them.

Returns:

true if all components are in valid state

validate

void validate()
       throws ValidationException

Check validity by invoking validators on all components which support them.

Throws:

ValidationException - if some components are currently in invalid state

validate

boolean validate(List<Validatable> fields)

Check validity by invoking validators on specified components which support them and show validation result notification.

Returns:

true if the validation was successful, false if there were any problems

validateAll

boolean validateAll()

Check validity by invoking validators on all components which support them and show validation result notification.

Returns:

true if the validation was successful, false if there were any problems

addFacet

void addFacet(Facet facet)

Registers the passed non-visual component in the frame.

Parameters:

facet - facet

getFacet

@Nullable
Facet getFacet(String id)

Finds registered facet by ID.

Parameters:

id - facet ID

Returns:

facet instance or null

getFacetNN

default Facet getFacetNN(String id)

Finds registered facet by ID. Throws IllegalArgumentException if not found.

Parameters:

id - facet ID

Returns:

facet instance

removeFacet

void removeFacet(Facet facet)

Removes the non-visual component from the frame.

Parameters:

facet - facet

getFacets

Stream<Facet> getFacets()

Returns:

stream of registered non-visual components