Package io.jmix.kanbanflowui.component.data

Class ContainerKanbanItems<T>

java.lang.Object

io.jmix.kanbanflowui.component.data.ContainerKanbanItems<T>

Type Parameters:

T - type of items contained

All Implemented Interfaces:

ContainerDataUnit<T>, DataUnit, EntityDataUnit, HasType<T>, KanbanItems<T>, JmixKanbanItems<T>, Serializable

public class ContainerKanbanItems<T>
extends Object
implements ContainerDataUnit<T>, KanbanItems<T>

Data provider bound to the CollectionContainer for a Kanban component.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.data.DataUnit

DataUnit.StateChangeEvent

Nested classes/interfaces inherited from interface io.jmix.kanbanflowui.kit.component.data.JmixKanbanItems

JmixKanbanItems.ItemsChangeEvent<T>, JmixKanbanItems.ItemsChangeType

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<T>	container
protected Class<?>	idType

Constructor Summary

Constructors

Constructor	Description
ContainerKanbanItems(CollectionContainer<T> container, Class<?> idType)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addItemsChangeListener(Consumer<JmixKanbanItems.ItemsChangeEvent<T>> listener)	Adds a listener that will be called when the associated collection or the property of an item of this collection changes.
com.vaadin.flow.shared.Registration	addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)	Registers a new state change listener.
protected void	containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)
boolean	containsItem(T item)
protected JmixKanbanItems.ItemsChangeType	convertToItemsChangeType(CollectionChangeType changeType)
protected Object	deserializeId(String stringValue)
CollectionContainer<T>	getContainer()
MetaClass	getEntityMetaClass()
protected EventBus	getEventBus()
T	getItem(Object itemId)	Finds an item by its id.
T	getItem(String stringId)	Finds an item by its string id.
Object	getItemId(T item)
Collection<T>	getItems()
<V> V	getItemValue(T item, String propertyId)
BindingState	getState()
Class<T>	getType()
protected void	initContainer(CollectionContainer<T> container)
void	setItemValue(T item, String propertyPath, Object value)	Sets the value to the item.
void	updateItem(T item)	If the item with the same id exists, it is replaced with the given instance.

Methods inherited from class java.lang.Object

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

Field Details

container

protected CollectionContainer<T> container

idType

protected Class<?> idType

Constructor Details

ContainerKanbanItems

public ContainerKanbanItems(CollectionContainer<T> container,
 Class<?> idType)

Method Details

initContainer

protected void initContainer(CollectionContainer<T> container)

containerCollectionChanged

protected void containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)

addItemsChangeListener

public com.vaadin.flow.shared.Registration addItemsChangeListener(Consumer<JmixKanbanItems.ItemsChangeEvent<T>> listener)

Description copied from interface: JmixKanbanItems

Adds a listener that will be called when the associated collection or the property of an item of this collection changes.

Specified by:

addItemsChangeListener in interface JmixKanbanItems<T>

Parameters:

listener - a listener to add

Returns:

a handle that can be used for removing the listener

getItems

public Collection<T> getItems()

Specified by:

getItems in interface JmixKanbanItems<T>

Returns:

unmodifiable collection of items

getItemValue

@Nullable
public <V> V getItemValue(T item,
 String propertyId)

Specified by:

getItemValue in interface JmixKanbanItems<T>

Parameters:

item - the item

propertyId - the property path

Returns:

the item value

setItemValue

public void setItemValue(T item,
 String propertyPath,
 @Nullable
 Object value)

Description copied from interface: JmixKanbanItems

Sets the value to the item.

Specified by:

setItemValue in interface JmixKanbanItems<T>

Parameters:

item - the item

propertyPath - the property path

value - the value to set

getItemId

@Nullable
public Object getItemId(T item)

Specified by:

getItemId in interface JmixKanbanItems<T>

Parameters:

item - the item

Returns:

the id of the item

getItem

public T getItem(Object itemId)

Description copied from interface: JmixKanbanItems

Finds an item by its id.

Specified by:

getItem in interface JmixKanbanItems<T>

Parameters:

itemId - the item id

Returns:

the item by the given id

getItem

public T getItem(String stringId)

Description copied from interface: JmixKanbanItems

Finds an item by its string id.

Specified by:

getItem in interface JmixKanbanItems<T>

Parameters:

stringId - the item string id

Returns:

the item by the given id

updateItem

public void updateItem(T item)

Description copied from interface: JmixKanbanItems

If the item with the same id exists, it is replaced with the given instance. If not, the given instance is added to the items list.

Specified by:

updateItem in interface JmixKanbanItems<T>

Parameters:

item - item to update

containsItem

public boolean containsItem(T item)

Specified by:

containsItem in interface JmixKanbanItems<T>

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

getType

public Class<T> getType()

Specified by:

getType in interface HasType<T>

Returns:

type of value

getContainer

public CollectionContainer<T> getContainer()

Specified by:

getContainer in interface ContainerDataUnit<T>

getEntityMetaClass

public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

addStateChangeListener

public com.vaadin.flow.shared.Registration addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)

Description copied from interface: DataUnit

Registers a new state change listener.

Specified by:

addStateChangeListener in interface DataUnit

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

deserializeId

protected Object deserializeId(String stringValue)

convertToItemsChangeType

protected JmixKanbanItems.ItemsChangeType convertToItemsChangeType(CollectionChangeType changeType)

getEventBus

protected EventBus getEventBus()