Package io.jmix.ui.component.impl

Class RelatedEntitiesImpl<E>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixPopupButton>

io.jmix.ui.component.impl.PopupButtonImpl

io.jmix.ui.component.impl.RelatedEntitiesImpl<E>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasSubParts, PopupButton, RelatedEntities<E>, SecuredActionsHolder

public class RelatedEntitiesImpl<E>
extends PopupButtonImpl
implements RelatedEntities<E>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.PopupButtonImpl

PopupButtonImpl.PopupMenuButton

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

HasContextHelp.ContextHelpIconClickEvent

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

PopupButton.PopupOpenDirection, PopupButton.PopupVisibilityEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected Actions	actions
protected String	excludeRegex
protected ListComponent<E>	listComponent
protected Messages	messages
protected MessageTools	messageTools
protected MetadataTools	metadataTools
protected OpenMode	openMode
protected Map<String,PropertyOption>	propertyOptions
protected ScreensHelper	screensHelper

Fields inherited from class io.jmix.ui.component.impl.PopupButtonImpl

actionButtons, actionOrder, actionPropertyChangeListener, actionsPermissions, CONTEXT_MENU_BUTTON_STYLENAME, popupComponent, popupVisibilityListenerRegistration, showActionIcons, vActionsContainer, vPopupComponent

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

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

NAME

Constructor Summary

Constructors

Constructor	Description
RelatedEntitiesImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addNavigationAction(MetaProperty metaProperty)
void	addPropertyOption(PropertyOption propertyOption)
protected Action	createRelatedAction(MetaProperty metaProperty, WindowInfo defaultScreen, PropertyOption propertyOption)
String	getExcludePropertiesRegex()
ListComponent<E>	getListComponent()
protected MetaClass	getMetaClass(ListComponent<E> listComponent)
OpenMode	getOpenMode()
protected boolean	isSuitableProperty(MetaClass metaClass, MetaProperty metaProperty, Pattern excludePattern)
protected void	refreshNavigationActions()
void	removePropertyOption(String property)
void	setAccessManager(AccessManager accessManager)
void	setActions(Actions actions)
void	setExcludePropertiesRegex(String excludeRegex)
void	setListComponent(ListComponent<E> listComponent)
void	setMessages(Messages messages)
void	setMessageTools(MessageTools messageTools)
void	setMetadataTools(MetadataTools metadataTools)
void	setOpenMode(OpenMode openMode)
void	setScreensHelper(ScreensHelper screensHelper)

Methods inherited from class io.jmix.ui.component.impl.PopupButtonImpl

actionPropertyChanged, addAction, addAction, addPopupVisibilityListener, createActionButton, createActionsContainer, createComponent, focus, getAction, getActions, getActionsPermissions, getMenuWidth, getMenuWidthSizeUnit, getPopupContent, getPopupOpenDirection, getTabIndex, hasVisibleActions, internalRemovePopupVisibilityListener, isAutoClose, isClosePopupOnOutsideClick, isPopupVisible, isShowActionIcons, isTogglePopupVisibilityOnClick, removeAction, removeAction, removeAllActions, setAutoClose, setClosePopupOnOutsideClick, setDebugId, setMenuWidth, setPopupButtonAction, setPopupButtonIcon, setPopupContent, setPopupOpenDirection, setPopupVisible, setShowActionIcons, setTabIndex, setThemeConstantsManager, setTogglePopupVisibilityOnClick, updateActionsIcons

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

getActionNN, getSubPart

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

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

actions

protected Actions actions

messages

protected Messages messages

messageTools

protected MessageTools messageTools

accessManager

protected AccessManager accessManager

metadataTools

protected MetadataTools metadataTools

screensHelper

protected ScreensHelper screensHelper

listComponent

protected ListComponent<E> listComponent

openMode

protected OpenMode openMode

propertyOptions

protected Map<String,PropertyOption> propertyOptions

excludeRegex

protected String excludeRegex

Constructor Details

RelatedEntitiesImpl

public RelatedEntitiesImpl()

Method Details

setActions

@Autowired
public void setActions(Actions actions)

setMessages

@Autowired
public void setMessages(Messages messages)

setAccessManager

@Autowired
public void setAccessManager(AccessManager accessManager)

setMessageTools

@Autowired
public void setMessageTools(MessageTools messageTools)

setMetadataTools

@Autowired
public void setMetadataTools(MetadataTools metadataTools)

setScreensHelper

@Autowired
public void setScreensHelper(ScreensHelper screensHelper)

getOpenMode

public OpenMode getOpenMode()

Specified by:

getOpenMode in interface RelatedEntities<E>

setOpenMode

public void setOpenMode(OpenMode openMode)

Specified by:

setOpenMode in interface RelatedEntities<E>

getExcludePropertiesRegex

@Nullable
public String getExcludePropertiesRegex()

Specified by:

getExcludePropertiesRegex in interface RelatedEntities<E>

setExcludePropertiesRegex

public void setExcludePropertiesRegex(@Nullable
 String excludeRegex)

Specified by:

setExcludePropertiesRegex in interface RelatedEntities<E>

addPropertyOption

public void addPropertyOption(PropertyOption propertyOption)

Specified by:

addPropertyOption in interface RelatedEntities<E>

removePropertyOption

public void removePropertyOption(String property)

Specified by:

removePropertyOption in interface RelatedEntities<E>

getListComponent

@Nullable
public ListComponent<E> getListComponent()

Specified by:

getListComponent in interface RelatedEntities<E>

setListComponent

public void setListComponent(@Nullable
 ListComponent<E> listComponent)

Specified by:

setListComponent in interface RelatedEntities<E>

refreshNavigationActions

protected void refreshNavigationActions()

isSuitableProperty

protected boolean isSuitableProperty(MetaClass metaClass,
 MetaProperty metaProperty,
 @Nullable
 Pattern excludePattern)

getMetaClass

protected MetaClass getMetaClass(ListComponent<E> listComponent)

addNavigationAction

protected void addNavigationAction(MetaProperty metaProperty)

createRelatedAction

protected Action createRelatedAction(MetaProperty metaProperty,
 @Nullable
 WindowInfo defaultScreen,
 @Nullable
 PropertyOption propertyOption)