Package io.jmix.dynattrflowui.view.category

Class CategoryListView

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

io.jmix.dynattrflowui.view.category.CategoryListView

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, FragmentOwner, LookupView<Category>, MultiSelectLookupView, Serializable

@Route(value="dynat/category",
       layout=DefaultMainViewParent.class)
@ViewController("dynat_CategoryView.list")
@ViewDescriptor("category-list-view.xml")
@DialogMode(width="47.5em")
public class CategoryListView
extends StandardListView<Category>

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.PostReadyEvent, View.QueryParametersChangeEvent, View.ReadyEvent, View.RestoreComponentsStateEvent

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

LookupView.ValidationContext<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected com.vaadin.flow.component.button.Button	applyChangesBtn
protected CollectionContainer<CategoryAttribute>	attributesDc
protected DataGrid<CategoryAttribute>	attributesTable
protected CollectionContainer<Category>	categoriesDc
protected CollectionLoader<Category>	categoriesDl
protected DataGrid<Category>	categoriesGrid
protected Action	createAction
protected CurrentAuthentication	currentAuthentication
protected DataContext	dataContext
protected DataManager	dataManager
protected Downloader	downloader
protected DynAttrMetadata	dynAttrMetadata
protected DynAttrUiHelper	dynAttrUiHelper
protected EntityImportExport	entityImportExport
protected EntityImportPlans	entityImportPlans
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlans	fetchPlans
protected FormatStringsRegistry	formatStringsRegistry
protected FileUploadField	importField
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected MetadataTools	metadataTools
protected Action	moveDownAction
protected Action	moveUpAction
protected Notifications	notifications
protected ReferenceToEntitySupport	referenceToEntitySupport
protected RouteSupport	routeSupport
static final String	SELECTED_CATEGORY_QUERY_PARAMETER
protected UUID	selectedCategoryId
protected UiComponents	uiComponents
protected UrlParamSerializer	urlParamSerializer

Fields inherited from class io.jmix.flowui.view.StandardListView

DISCARD_ACTION_DEFAULT_ID, LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID, SELECT_ACTION_DEFAULT_ID, selectionHandler, selectionValidator

Constructor Summary

Constructors

Constructor	Description
CategoryListView()

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.router.RouteParameters	attributesTableCreateActionRouteParametersProvider()
protected com.vaadin.flow.router.RouteParameters	attributesTableEditActionRouteParametersProvider()
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)
protected FetchPlan	buildExportFetchPlan()
protected com.vaadin.flow.data.renderer.Renderer<Category>	categoriesGridIsDefaultRenderer()
protected boolean	categoryAttrsGridCreateEnabledRule()
protected com.vaadin.flow.component.html.Span	categoryAttrsGridDataTypeComponent()
protected void	categoryAttrsGridDataTypeUpdater(com.vaadin.flow.component.html.Span text, CategoryAttribute categoryAttribute)
protected com.vaadin.flow.component.html.Span	categoryAttrsGridDefaultValueColumnComponent()
protected void	categoryAttrsGridDefaultValueColumnUpdater(com.vaadin.flow.component.html.Span defaultValueLabel, CategoryAttribute attribute)
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute>	categoryAttrsGridIsCollectionRenderer()
protected boolean	categoryAttrsGridMoveDownEnabledRule()
protected boolean	categoryAttrsGridMoveUpEnabledRule()
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute>	categoryAttrsGridRequiredRenderer()
protected boolean	checkOrderNoModificationPermissions()
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute>	createCategoryAttrsGridDataTypeRenderer()
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute>	createCategoryAttrsGridDefaultValueRenderer()
protected com.vaadin.flow.component.icon.Icon	createCheckboxIconByAttributeValue(Boolean attributeValue)
protected EntityImportPlan	createEntityImportPlan()
protected void	export(DownloadFormat downloadFormat)
protected CategoryAttribute	getNextAttribute(Integer orderNo)
protected CategoryAttribute	getPrevAttribute(Integer orderNo)
protected void	onBeforeShow(View.BeforeShowEvent event)
protected void	onCategoriesGridApplyChanges(ActionPerformedEvent event)
protected void	onCategoriesGridSelectionEvent(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Category>,Category> event)
protected void	onCategoryAttrsGridMoveDown(ActionPerformedEvent event)
protected void	onCategoryAttrsGridMoveUp(ActionPerformedEvent event)
protected void	onCategoryGridSelectionChange(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Category>,Category> event)
void	onExportBtnExportJSON(ActionPerformedEvent event)
void	onExportBtnExportZIP(ActionPerformedEvent event)
void	onImportFieldFileUploadSucceed(FileUploadSucceededEvent<FileUploadField> event)
protected void	onReady(View.ReadyEvent event)
protected void	processBeforeEnterInternal(com.vaadin.flow.router.BeforeEnterEvent event)	CAUTION: for internal use only.
protected void	processQueryParameters(com.vaadin.flow.router.BeforeEnterEvent event)
protected void	refreshMoveActionStates()
protected void	setSelectedCategory(String categoryUUid)
protected void	setupFieldsLock()
protected void	setupSelectedCategory()

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

closeWithDiscard, doSelect, findLookupComponent, getDiscardAction, getLookupActionsLayout, getLookupComponent, getSelectAction, getSelectionHandler, getSelectionValidator, handleSelection, lookupEnterPress, setLookupComponentMultiSelect, setSelectionHandler, setSelectionValidator, setupLookupComponent, setupSaveShortcut, validateSelectedItems

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

initContent

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

addAfterCloseListener, addApplicationListeners, addBeforeCloseListener, addBeforeShowListener, addInitListener, addQueryParametersChangeListener, addReadyListener, addRestoreComponentsStateEventListener, afterNavigation, beforeLeave, close, close, closeWithDefaultAction, configureDialogWindowFooter, configureDialogWindowHeader, getApplicationContext, getEventBus, getId, getPageTitle, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onAttachInternal, onDetach, onDetachInternal, removeApplicationListeners, removeViewAttributes, setAfterNavigationHandler, setApplicationContext, setId, setMeterRegistry, setPageTitle, setPreventBrowserTabClosing, setViewActions, setViewData, setViewFacets, unregisterBackNavigation

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

SELECTED_CATEGORY_QUERY_PARAMETER

public static final String SELECTED_CATEGORY_QUERY_PARAMETER

See Also:

• Constant Field Values

notifications

@Autowired
protected Notifications notifications

messages

@Autowired
protected Messages messages

messageTools

@Autowired
protected MessageTools messageTools

metadataTools

@Autowired
protected MetadataTools metadataTools

dataManager

@Autowired
protected DataManager dataManager

metadata

@Autowired
protected Metadata metadata

dynAttrMetadata

@Autowired
protected DynAttrMetadata dynAttrMetadata

entityImportExport

@Autowired
protected EntityImportExport entityImportExport

fetchPlans

@Autowired
protected FetchPlans fetchPlans

entityImportPlans

@Autowired
protected EntityImportPlans entityImportPlans

downloader

@Autowired
protected Downloader downloader

accessManager

@Autowired
protected AccessManager accessManager

uiComponents

@Autowired
protected UiComponents uiComponents

urlParamSerializer

@Autowired
protected UrlParamSerializer urlParamSerializer

routeSupport

@Autowired
protected RouteSupport routeSupport

dynAttrUiHelper

@Autowired
protected DynAttrUiHelper dynAttrUiHelper

currentAuthentication

@Autowired
protected CurrentAuthentication currentAuthentication

referenceToEntitySupport

@Autowired
protected ReferenceToEntitySupport referenceToEntitySupport

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

formatStringsRegistry

@Autowired
protected FormatStringsRegistry formatStringsRegistry

categoriesGrid

@ViewComponent
protected DataGrid<Category> categoriesGrid

categoriesDc

@ViewComponent
protected CollectionContainer<Category> categoriesDc

categoriesDl

@ViewComponent
protected CollectionLoader<Category> categoriesDl

attributesTable

@ViewComponent
protected DataGrid<CategoryAttribute> attributesTable

attributesDc

@ViewComponent
protected CollectionContainer<CategoryAttribute> attributesDc

createAction

@ViewComponent("attributesTable.create")
protected Action createAction

moveUpAction

@ViewComponent("attributesTable.moveUp")
protected Action moveUpAction

moveDownAction

@ViewComponent("attributesTable.moveDown")
protected Action moveDownAction

importField

@ViewComponent
protected FileUploadField importField

applyChangesBtn

@ViewComponent
protected com.vaadin.flow.component.button.Button applyChangesBtn

dataContext

@ViewComponent
protected DataContext dataContext

selectedCategoryId

protected UUID selectedCategoryId

Constructor Details

CategoryListView

public CategoryListView()

Method Details

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

Overrides:

beforeEnter in class View<ViewLayout>

processBeforeEnterInternal

protected void processBeforeEnterInternal(com.vaadin.flow.router.BeforeEnterEvent event)

Description copied from class: View

CAUTION: for internal use only.

Overrides:

processBeforeEnterInternal in class View<ViewLayout>

Parameters:

event - before navigation event with event details

processQueryParameters

protected void processQueryParameters(com.vaadin.flow.router.BeforeEnterEvent event)

setSelectedCategory

protected void setSelectedCategory(String categoryUUid)

onBeforeShow

@Subscribe
protected void onBeforeShow(View.BeforeShowEvent event)

onReady

@Subscribe
protected void onReady(View.ReadyEvent event)

setupFieldsLock

protected void setupFieldsLock()

setupSelectedCategory

protected void setupSelectedCategory()

onCategoriesGridApplyChanges

@Subscribe("categoriesGrid.applyChanges")
protected void onCategoriesGridApplyChanges(ActionPerformedEvent event)

categoriesGridIsDefaultRenderer

@Supply(to="categoriesGrid.isDefault",
        subject="renderer")
protected com.vaadin.flow.data.renderer.Renderer<Category> categoriesGridIsDefaultRenderer()

categoryAttrsGridRequiredRenderer

@Supply(to="attributesTable.required",
        subject="renderer")
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute> categoryAttrsGridRequiredRenderer()

categoryAttrsGridIsCollectionRenderer

@Supply(to="attributesTable.isCollection",
        subject="renderer")
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute> categoryAttrsGridIsCollectionRenderer()

createCheckboxIconByAttributeValue

protected com.vaadin.flow.component.icon.Icon createCheckboxIconByAttributeValue(Boolean attributeValue)

createCategoryAttrsGridDataTypeRenderer

@Supply(to="attributesTable.dataType",
        subject="renderer")
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute> createCategoryAttrsGridDataTypeRenderer()

categoryAttrsGridDataTypeComponent

protected com.vaadin.flow.component.html.Span categoryAttrsGridDataTypeComponent()

categoryAttrsGridDataTypeUpdater

protected void categoryAttrsGridDataTypeUpdater(com.vaadin.flow.component.html.Span text,
 CategoryAttribute categoryAttribute)

createCategoryAttrsGridDefaultValueRenderer

@Supply(to="attributesTable.defaultValue",
        subject="renderer")
protected com.vaadin.flow.data.renderer.Renderer<CategoryAttribute> createCategoryAttrsGridDefaultValueRenderer()

categoryAttrsGridDefaultValueColumnComponent

protected com.vaadin.flow.component.html.Span categoryAttrsGridDefaultValueColumnComponent()

categoryAttrsGridDefaultValueColumnUpdater

protected void categoryAttrsGridDefaultValueColumnUpdater(com.vaadin.flow.component.html.Span defaultValueLabel,
 CategoryAttribute attribute)

onCategoryAttrsGridMoveUp

@Subscribe("attributesTable.moveUp")
protected void onCategoryAttrsGridMoveUp(ActionPerformedEvent event)

categoryAttrsGridMoveUpEnabledRule

@Install(to="attributesTable.moveUp",
         subject="enabledRule")
protected boolean categoryAttrsGridMoveUpEnabledRule()

onCategoryAttrsGridMoveDown

@Subscribe("attributesTable.moveDown")
protected void onCategoryAttrsGridMoveDown(ActionPerformedEvent event)

categoryAttrsGridMoveDownEnabledRule

@Install(to="attributesTable.moveDown",
         subject="enabledRule")
protected boolean categoryAttrsGridMoveDownEnabledRule()

checkOrderNoModificationPermissions

protected boolean checkOrderNoModificationPermissions()

refreshMoveActionStates

protected void refreshMoveActionStates()

getPrevAttribute

protected CategoryAttribute getPrevAttribute(Integer orderNo)

getNextAttribute

protected CategoryAttribute getNextAttribute(Integer orderNo)

categoryAttrsGridCreateEnabledRule

@Install(to="attributesTable.create",
         subject="enabledRule")
protected boolean categoryAttrsGridCreateEnabledRule()

onCategoriesGridSelectionEvent

@Subscribe("categoriesGrid")
protected void onCategoriesGridSelectionEvent(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Category>,Category> event)

onCategoryGridSelectionChange

protected void onCategoryGridSelectionChange(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Category>,Category> event)

attributesTableCreateActionRouteParametersProvider

@Install(to="attributesTable.create",
         subject="routeParametersProvider")
protected com.vaadin.flow.router.RouteParameters attributesTableCreateActionRouteParametersProvider()

attributesTableEditActionRouteParametersProvider

@Install(to="attributesTable.edit",
         subject="routeParametersProvider")
protected com.vaadin.flow.router.RouteParameters attributesTableEditActionRouteParametersProvider()

onExportBtnExportJSON

@Subscribe("categoriesGrid.exportJSON")
public void onExportBtnExportJSON(ActionPerformedEvent event)

onExportBtnExportZIP

@Subscribe("categoriesGrid.exportZIP")
public void onExportBtnExportZIP(ActionPerformedEvent event)

export

protected void export(DownloadFormat downloadFormat)

buildExportFetchPlan

protected FetchPlan buildExportFetchPlan()

onImportFieldFileUploadSucceed

@Subscribe("importField")
public void onImportFieldFileUploadSucceed(FileUploadSucceededEvent<FileUploadField> event)

createEntityImportPlan

protected EntityImportPlan createEntityImportPlan()