Package io.jmix.ui.component

Interface RelatedEntities<E>

All Superinterfaces:

Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasHtmlCaption, HasHtmlDescription

All Known Implementing Classes:

RelatedEntitiesImpl

@StudioComponent(caption="RelatedEntities",
                 category="Components",
                 xmlElement="relatedEntities",
                 icon="io/jmix/ui/icon/component/relatedEntities.svg",
                 canvasTextProperty="caption",
                 canvasBehaviour=POPUP_BUTTON,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/related-entities.html")
public interface RelatedEntities<E>
extends Component, Component.HasCaption, Component.BelongToFrame, Component.HasIcon, Component.Focusable, HasHtmlCaption, HasHtmlDescription

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
void	addPropertyOption(PropertyOption property)
String	getExcludePropertiesRegex()
ListComponent<E>	getListComponent()
OpenMode	getOpenMode()
void	removePropertyOption(String property)
void	setExcludePropertiesRegex(String excludeRegex)
void	setListComponent(ListComponent<E> listComponent)
void	setOpenMode(OpenMode openMode)

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getOpenMode

OpenMode getOpenMode()

setOpenMode

@StudioProperty(type=ENUMERATION,
                defaultValue="THIS_TAB",
                options={"NEW_TAB","THIS_TAB","DIALOG","NEW_WINDOW"})
void setOpenMode(OpenMode openMode)

getExcludePropertiesRegex

@Nullable
String getExcludePropertiesRegex()

setExcludePropertiesRegex

@StudioProperty(name="exclude",
                type=STRING)
void setExcludePropertiesRegex(@Nullable
 String excludeRegex)

addPropertyOption

void addPropertyOption(PropertyOption property)

removePropertyOption

void removePropertyOption(String property)

getListComponent

@Nullable
ListComponent<E> getListComponent()

setListComponent

@StudioProperty(name="for",
                type=COMPONENT_REF,
                required=true,
                options="io.jmix.ui.component.ListComponent")
void setListComponent(@Nullable
 ListComponent<E> listComponent)