Package io.jmix.flowui.view

Class StandardListView<E>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<T>

io.jmix.flowui.view.View<ViewLayout>

io.jmix.flowui.view.StandardView

io.jmix.flowui.view.StandardListView<E>

Type Parameters:

E - entity class

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, LookupView<E>, MultiSelectLookupView, Serializable

Direct Known Subclasses:

AddConditionView, AllTasksView, BusinessCalendarListView, CategoryListView, ContentStorageListView, DmnDecisionTableListView, DmnDecisionTableLookupView, EmailAttachmentFragment, EntityAttributesFragment, EntityInspectorListView, EntityLogView, EntityTreeNodeListView, ExecutionListenersFragment, ExtensionPropertiesFragment, FormFieldLookup, InAppNotificationListView, JobModelListView, JpqlParametersFragment, MultiValueSelectDialog, MyTasksListView, ProcessDefinitionLookupView, ProcessInstanceListView, ReportExecutionDialog, ReportExecutionListView, ReportGroupListView, ReportListView, ReportRunView, ResourceRoleModelListView, ResourceRoleModelLookupView, RowLevelRoleModelListView, RowLevelRoleModelLookupView, SendingMessageAttachmentsListView, StartProcessView, TenantListView, UserGroupListView, UserSessionsView, WebdavDocumentListView, WebdavDocumentVersionsLookupView

public class StandardListView<E>
extends StandardView
implements LookupView<E>, MultiSelectLookupView

Base class of entity list views.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.view.View

View.AfterCloseEvent, View.BeforeCloseEvent, View.BeforeShowEvent, View.InitEvent, View.QueryParametersChangeEvent, View.ReadyEvent

Nested classes/interfaces inherited from interface io.jmix.flowui.view.LookupView

LookupView.ValidationContext<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DISCARD_ACTION_DEFAULT_ID
protected static final String	LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID
protected static final String	SELECT_ACTION_DEFAULT_ID
protected Consumer<Collection<E>>	selectionHandler
protected Predicate<LookupView.ValidationContext<E>>	selectionValidator

Constructor Summary

Constructors

Constructor	Description
StandardListView()

Method Summary

Modifier and Type	Method	Description
OperationResult	closeWithDiscard()	Close the view without selection.
protected OperationResult	doSelect(Collection<E> items)
Optional<LookupComponent<E>>	findLookupComponent()
protected Optional<Action>	getDiscardAction()
protected Optional<com.vaadin.flow.component.Component>	getLookupActionsLayout()
LookupComponent<E>	getLookupComponent()
protected Optional<Action>	getSelectAction()
Optional<Consumer<Collection<E>>>	getSelectionHandler()
Optional<Predicate<LookupView.ValidationContext<E>>>	getSelectionValidator()
OperationResult	handleSelection()	Handle selected entities.
void	setLookupComponentMultiSelect(boolean multiSelect)	Informs the view that a lookup component should change its selection mode, if possible.
void	setSelectionHandler(Consumer<Collection<E>> selectionHandler)	Sets selection handler for screen.
void	setSelectionValidator(Predicate<LookupView.ValidationContext<E>> selectionValidator)	Sets selection validator.
protected void	setupLookupComponent()
protected void	setupSaveShortcut()
protected OperationResult	validateSelectedItems(Collection<E> items)

Methods inherited from class io.jmix.flowui.view.StandardView

initContent

Methods inherited from class io.jmix.flowui.view.View

addAfterCloseListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addQueryParametersChangeListener, addReadyListener, afterNavigation, beforeEnter, beforeLeave, close, close, closeWithDefaultAction, getApplicationContext, getId, getPageTitle, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onDetach, setApplicationContext, setId, setPreventBrowserTabClosing, setViewActions, setViewData, setViewFacets

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID

protected static final String LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID

See Also:

• Constant Field Values

SELECT_ACTION_DEFAULT_ID

protected static final String SELECT_ACTION_DEFAULT_ID

See Also:

• Constant Field Values

DISCARD_ACTION_DEFAULT_ID

protected static final String DISCARD_ACTION_DEFAULT_ID

See Also:

• Constant Field Values

selectionHandler

protected Consumer<Collection<E>> selectionHandler

selectionValidator

protected Predicate<LookupView.ValidationContext<E>> selectionValidator

Constructor Details

StandardListView

public StandardListView()

Method Details

setupLookupComponent

protected void setupLookupComponent()

setupSaveShortcut

protected void setupSaveShortcut()

getSelectionHandler

public Optional<Consumer<Collection<E>>> getSelectionHandler()

Specified by:

getSelectionHandler in interface LookupView<E>

Returns:

selection handler

setSelectionHandler

public void setSelectionHandler(@Nullable
 Consumer<Collection<E>> selectionHandler)

Description copied from interface: LookupView

Sets selection handler for screen.

Specified by:

setSelectionHandler in interface LookupView<E>

Parameters:

selectionHandler - selection handler

getLookupActionsLayout

protected Optional<com.vaadin.flow.component.Component> getLookupActionsLayout()

getLookupComponent

public LookupComponent<E> getLookupComponent()

Specified by:

getLookupComponent in interface LookupView<E>

Returns:

a component that is used to select entities of this view

findLookupComponent

public Optional<LookupComponent<E>> findLookupComponent()

Specified by:

findLookupComponent in interface LookupView<E>

Returns:

an optional component that is used to select entities of this view

getSelectionValidator

public Optional<Predicate<LookupView.ValidationContext<E>>> getSelectionValidator()

Specified by:

getSelectionValidator in interface LookupView<E>

Returns:

selection validator

setSelectionValidator

public void setSelectionValidator(@Nullable
 Predicate<LookupView.ValidationContext<E>> selectionValidator)

Description copied from interface: LookupView

Sets selection validator.

Specified by:

setSelectionValidator in interface LookupView<E>

Parameters:

selectionValidator - selection validator

setLookupComponentMultiSelect

public void setLookupComponentMultiSelect(boolean multiSelect)

Description copied from interface: MultiSelectLookupView

Informs the view that a lookup component should change its selection mode, if possible.

Specified by:

setLookupComponentMultiSelect in interface MultiSelectLookupView

Parameters:

multiSelect - true to enable multiple selections, false otherwise

handleSelection

public OperationResult handleSelection()

Description copied from interface: LookupView

Handle selected entities.

Specified by:

handleSelection in interface LookupView<E>

validateSelectedItems

protected OperationResult validateSelectedItems(Collection<E> items)

doSelect

protected OperationResult doSelect(Collection<E> items)

closeWithDiscard

public OperationResult closeWithDiscard()

Description copied from interface: LookupView

Close the view without selection.

Specified by:

closeWithDiscard in interface LookupView<E>

getSelectAction

protected Optional<Action> getSelectAction()

getDiscardAction

protected Optional<Action> getDiscardAction()