org.thshsh.vaadin.entity

Class EntityGrid<T,ID extends Serializable>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.orderedlayout.VerticalLayout

org.thshsh.vaadin.entity.EntityGrid<T,ID>

Type Parameters:

T -

ID -

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.orderedlayout.FlexComponent, com.vaadin.flow.component.orderedlayout.ThemableLayout, Serializable

@CssImport(value="entity-grid.css") @CssImport(value="entity-grid-vaadin-grid.css",themeFor="vaadin-grid") @CssImport(value="entity-grid-vcf-toggle-button.css",themeFor="vcf-toggle-button")
public abstract class EntityGrid<T,ID extends Serializable>
extends com.vaadin.flow.component.orderedlayout.VerticalLayout

This is a component that can list entities in a table with a button column for operations It needs a "Provider" implementation to be passed to it to to delegate parts of the component

Author:

daniel.watson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityGrid.FilterMode

Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

com.vaadin.flow.component.orderedlayout.FlexComponent.Alignment, com.vaadin.flow.component.orderedlayout.FlexComponent.JustifyContentMode

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.flow.component.button.Button	addButton
protected com.vaadin.componentfactory.ToggleButton	advancedButton
protected Collection<com.vaadin.flow.component.grid.Grid.Column<T>>	advancedColumns
protected org.springframework.context.ApplicationContext	appCtx
protected com.vaadin.flow.component.grid.Grid.Column<?>	buttonColumn
protected Boolean	caseSensitive
protected Boolean	columnsResizable
protected com.vaadin.flow.component.html.Span	count
protected com.vaadin.flow.component.html.Span	countAndAdvanced
protected String	createText
protected com.vaadin.flow.data.provider.DataProvider<T,?>	dataProvider
protected Boolean	defaultSortAsc
protected String	defaultSortOrderProperty
protected com.vaadin.flow.component.button.Button	deleteButton
protected com.vaadin.flow.component.button.Button	editButton
protected Boolean	emptyFilter
protected Class<T>	entityClass
protected String	entityName
protected String	entityNamePlural
protected Class<? extends com.vaadin.flow.component.Component>	entityView
protected com.vaadin.flow.component.textfield.TextField	filter
protected T	filterEntity
protected EntityGrid.FilterMode	filterMode
protected com.vaadin.flow.component.grid.Grid<T>	grid
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	header
static org.slf4j.Logger	LOGGER
protected EntityGridRefreshThread	refreshThread
protected org.springframework.data.repository.PagingAndSortingRepository<T,ID>	repository
protected Boolean	showButtonColumn
protected Boolean	showCount
protected Boolean	showCreateButton
protected Boolean	showDeleteButton
protected Boolean	showEditButton
protected Boolean	showFilter
protected Boolean	showHeader

Constructor Summary

Constructors

Constructor and Description
EntityGrid(Class<T> c, Class<? extends com.vaadin.flow.component.Component> ev, EntityGrid.FilterMode fm, String sortProp)

Method Summary

Modifier and Type	Method and Description
void	addButtonColumn(com.vaadin.flow.component.orderedlayout.HorizontalLayout buttons, T e)
void	changeFilter(String text)
void	clearFilter()
void	clickDelete(T e)
void	clickEdit(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> click, T entity)
void	clickNew(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> click)
com.vaadin.flow.data.provider.DataProvider<T,?>	createDataProvider()
com.vaadin.flow.component.dialog.Dialog	createDialog(T entity)
T	createFilterEntity()
void	delete(T e)
void	delete(T e, ConfirmDialog d, ConfirmDialog.ButtonConfig bc)
Long	getCountAll()
List<com.vaadin.flow.data.provider.QuerySortOrder>	getDefaultSortOrder()
ID	getEntityId(T entity)
String	getEntityName()
String	getEntityName(T t)
String	getEntityNamePlural()
com.vaadin.flow.component.grid.Grid<T>	getGrid()
com.vaadin.flow.component.orderedlayout.HorizontalLayout	getHeader()
abstract org.springframework.data.repository.PagingAndSortingRepository<T,ID>	getRepository()
void	postConstruct()
void	refresh()
void	refresh(T entity)
void	refreshEvery(Long ms)
void	setFilter(String text)
void	setupAdvancedColumns(com.vaadin.flow.component.grid.Grid<T> grid, Collection<com.vaadin.flow.component.grid.Grid.Column<T>> coll)
abstract void	setupColumns(com.vaadin.flow.component.grid.Grid<T> grid)
void	shortcutDetails(T e)
void	showAdvanced(boolean show)
void	updateCount()

Methods inherited from class com.vaadin.flow.component.orderedlayout.VerticalLayout

addAndExpand, getAlignItems, getAlignSelf, getDefaultHorizontalComponentAlignment, getHorizontalComponentAlignment, setAlignItems, setAlignSelf, setDefaultHorizontalComponentAlignment, setHorizontalComponentAlignment, setPadding, setSpacing

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, 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.orderedlayout.ThemableLayout

getBoxSizing, getThemeList, isMargin, isPadding, isSpacing, setBoxSizing, setMargin

Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

expand, getFlexGrow, getJustifyContentMode, replace, setFlexGrow, setJustifyContentMode

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

getChildren, getComponentAt, getComponentCount, indexOf

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

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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

isEnabled, setEnabled

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

getElement

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

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

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

getCssSize, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

addClickListener, addClickShortcut

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

addAttachListener

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

addDetachListener

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

appCtx

@Autowired
protected org.springframework.context.ApplicationContext appCtx

repository

protected org.springframework.data.repository.PagingAndSortingRepository<T,ID extends Serializable> repository

dataProvider

protected com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider

filterEntity

protected T filterEntity

entityView

protected Class<? extends com.vaadin.flow.component.Component> entityView

entityClass

protected Class<T> entityClass

grid

protected com.vaadin.flow.component.grid.Grid<T> grid

defaultSortAsc

protected Boolean defaultSortAsc

defaultSortOrderProperty

protected String defaultSortOrderProperty

entityName

protected String entityName

entityNamePlural

protected String entityNamePlural

showButtonColumn

protected Boolean showButtonColumn

showEditButton

protected Boolean showEditButton

showDeleteButton

protected Boolean showDeleteButton

showCreateButton

protected Boolean showCreateButton

showHeader

protected Boolean showHeader

showCount

protected Boolean showCount

showFilter

protected Boolean showFilter

columnsResizable

protected Boolean columnsResizable

count

protected com.vaadin.flow.component.html.Span count

filter

protected com.vaadin.flow.component.textfield.TextField filter

buttonColumn

protected com.vaadin.flow.component.grid.Grid.Column<?> buttonColumn

createText

protected String createText

header

protected com.vaadin.flow.component.orderedlayout.HorizontalLayout header

countAndAdvanced

protected com.vaadin.flow.component.html.Span countAndAdvanced

editButton

protected com.vaadin.flow.component.button.Button editButton

deleteButton

protected com.vaadin.flow.component.button.Button deleteButton

addButton

protected com.vaadin.flow.component.button.Button addButton

advancedButton

protected com.vaadin.componentfactory.ToggleButton advancedButton

advancedColumns

protected Collection<com.vaadin.flow.component.grid.Grid.Column<T>> advancedColumns

filterMode

protected EntityGrid.FilterMode filterMode

caseSensitive

protected Boolean caseSensitive

emptyFilter

protected Boolean emptyFilter

refreshThread

protected EntityGridRefreshThread refreshThread

Constructor Detail

EntityGrid

public EntityGrid(Class<T> c,
                  Class<? extends com.vaadin.flow.component.Component> ev,
                  EntityGrid.FilterMode fm,
                  String sortProp)

Method Detail

postConstruct

@PostConstruct
public void postConstruct()

refresh

public void refresh()

refresh

public void refresh(T entity)

addButtonColumn

public void addButtonColumn(com.vaadin.flow.component.orderedlayout.HorizontalLayout buttons,
                            T e)

shortcutDetails

public void shortcutDetails(T e)

clickDelete

public void clickDelete(T e)

delete

public void delete(T e,
                   ConfirmDialog d,
                   ConfirmDialog.ButtonConfig bc)

delete

public void delete(T e)

clickEdit

public void clickEdit(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> click,
                      T entity)

createDataProvider

public com.vaadin.flow.data.provider.DataProvider<T,?> createDataProvider()

getDefaultSortOrder

public List<com.vaadin.flow.data.provider.QuerySortOrder> getDefaultSortOrder()

createFilterEntity

public T createFilterEntity()

updateCount

public void updateCount()

getCountAll

public Long getCountAll()

changeFilter

public void changeFilter(String text)

clickNew

public void clickNew(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> click)

createDialog

public com.vaadin.flow.component.dialog.Dialog createDialog(T entity)

refreshEvery

public void refreshEvery(Long ms)

getEntityName

public String getEntityName()

getEntityNamePlural

public String getEntityNamePlural()

showAdvanced

public void showAdvanced(boolean show)

getRepository

public abstract org.springframework.data.repository.PagingAndSortingRepository<T,ID> getRepository()

setupColumns

public abstract void setupColumns(com.vaadin.flow.component.grid.Grid<T> grid)

setupAdvancedColumns

public void setupAdvancedColumns(com.vaadin.flow.component.grid.Grid<T> grid,
                                 Collection<com.vaadin.flow.component.grid.Grid.Column<T>> coll)

getEntityName

public String getEntityName(T t)

getEntityId

public ID getEntityId(T entity)

setFilter

public void setFilter(String text)

clearFilter

public void clearFilter()

getGrid

public com.vaadin.flow.component.grid.Grid<T> getGrid()

getHeader

public com.vaadin.flow.component.orderedlayout.HorizontalLayout getHeader()