io.jmix.ui.component

Interface Fragment

All Superinterfaces:

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

All Known Subinterfaces:

FragmentImplementation

All Known Implementing Classes:

FragmentImpl

@StudioComponent(caption="Fragment",
                 category="Containers",
                 xmlElement="fragment",
                 icon="io/jmix/ui/icon/container/fragment.svg",
                 canvasBehaviour=BOX,
                 canvasIconSize=LARGE,
                 unsupportedProperties={"spacing","margin"},
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/screens.html")
public interface Fragment
extends Frame

Reusable part of Window with separate UI controller.

See Also:

ScreenFragment

Nested Class Summary

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
static java.lang.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

Method Summary

Modifier and Type	Method and Description
FrameContext	getContext()
ScreenFragment	getFrameOwner()

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

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

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, setIcon, setIconFromSet

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

getExpandRatio, setExpandRatio

Field Detail

NAME

static final java.lang.String NAME

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

See Also:

Constant Field Values

Method Detail

getFrameOwner

ScreenFragment getFrameOwner()

Specified by:

getFrameOwner in interface Frame

Returns:

UI controller of the frame

See Also:

Screen, ScreenFragment

getContext

@StudioElementsGroup(caption="Properties",
                     xmlElement="properties",
                     elementClass="io.jmix.ui.sys.UiControllerProperty",
                     icon="io/jmix/ui/icon/element/properties.svg")
FrameContext getContext()

Specified by:

getContext in interface Frame

Returns:

current frame context