Package io.jmix.ui.component.calendar

Class ContainerCalendarEventProvider<E>

java.lang.Object

io.jmix.ui.component.calendar.ContainerCalendarEventProvider<E>

All Implemented Interfaces:

CalendarEventProvider, EntityCalendarEventProvider

public class ContainerCalendarEventProvider<E>
extends Object
implements CalendarEventProvider, EntityCalendarEventProvider

Nested Class Summary

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

CalendarEventProvider.EventSetChangeEvent, CalendarEventProvider.EventSetChangeListener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	allDayProperty
protected String	captionProperty
protected Subscription	collectionChangeListener
protected CollectionContainer<E>	container
protected String	descriptionProperty
protected String	endDateProperty
protected EventHub	events
protected List<CalendarEvent>	itemsCache
protected Subscription	propertyChangeListener
protected String	startDateProperty
protected String	styleNameProperty

Constructor Summary

Constructors

Constructor	Description
ContainerCalendarEventProvider(CollectionContainer<E> container)

Method Summary

Modifier and Type	Method	Description
void	addEvent(CalendarEvent event)	Adds CalendarEvent to the event provider list.
Subscription	addEventSetChangeListener(Consumer<CalendarEventProvider.EventSetChangeEvent> listener)
String	getCaptionProperty()
CollectionContainer<E>	getContainer()
String	getDescriptionProperty()
String	getEndDateProperty()
List<CalendarEvent>	getEvents()
String	getIsAllDayProperty()
String	getStartDateProperty()
String	getStyleNameProperty()
protected void	onCollectionChanged(CollectionContainer.CollectionChangeEvent<E> event)
protected void	onItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> event)
void	removeAllEvents()	Removes all CalendarEvent in the event provider list.
void	removeEvent(CalendarEvent event)	Removes CalendarEvent from the event provider list.
void	removeEventSetChangeListener(Consumer<CalendarEventProvider.EventSetChangeEvent> listener)
void	setAllDayProperty(String allDayProperty)	Sets the name of the property that represents whether event is an all-day event.
void	setCaptionProperty(String captionProperty)	Sets the name of the property that represents caption of event.
void	setDescriptionProperty(String descriptionProperty)	Sets the name of the property that represents description of event.
void	setEndDateProperty(String endDateProperty)	Sets the name of the property that represents end date of event.
void	setStartDateProperty(String startDateProperty)	Sets the name of the property that represents start date of event.
void	setStyleNameProperty(String styleNameProperty)	Sets the name of the property that represents style name of event.
void	unbind()

Methods inherited from class java.lang.Object

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

Field Details

itemsCache

protected List<CalendarEvent> itemsCache

container

protected CollectionContainer<E> container

startDateProperty

protected String startDateProperty

endDateProperty

protected String endDateProperty

captionProperty

protected String captionProperty

descriptionProperty

protected String descriptionProperty

styleNameProperty

protected String styleNameProperty

allDayProperty

protected String allDayProperty

events

protected EventHub events

collectionChangeListener

protected Subscription collectionChangeListener

propertyChangeListener

protected Subscription propertyChangeListener

Constructor Details

ContainerCalendarEventProvider

public ContainerCalendarEventProvider(CollectionContainer<E> container)

Method Details

onCollectionChanged

protected void onCollectionChanged(CollectionContainer.CollectionChangeEvent<E> event)

onItemPropertyChanged

protected void onItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> event)

getContainer

public CollectionContainer<E> getContainer()

addEvent

public void addEvent(CalendarEvent event)

Description copied from interface: CalendarEventProvider

Adds CalendarEvent to the event provider list.

Not supported by EntityCalendarEventProvider, use datasource for changing data items.

Specified by:

addEvent in interface CalendarEventProvider

Parameters:

event - calendar event

removeEvent

public void removeEvent(CalendarEvent event)

Description copied from interface: CalendarEventProvider

Removes CalendarEvent from the event provider list.

Not supported by EntityCalendarEventProvider, use datasource for changing data items.

Specified by:

removeEvent in interface CalendarEventProvider

Parameters:

event - calendar event

removeAllEvents

public void removeAllEvents()

Description copied from interface: CalendarEventProvider

Removes all CalendarEvent in the event provider list.

Not supported by EntityCalendarEventProvider, use datasource for changing data items.

Specified by:

removeAllEvents in interface CalendarEventProvider

addEventSetChangeListener

public Subscription addEventSetChangeListener(Consumer<CalendarEventProvider.EventSetChangeEvent> listener)

Specified by:

addEventSetChangeListener in interface CalendarEventProvider

removeEventSetChangeListener

public void removeEventSetChangeListener(Consumer<CalendarEventProvider.EventSetChangeEvent> listener)

Specified by:

removeEventSetChangeListener in interface CalendarEventProvider

Parameters:

listener - a listener to remove

getEvents

public List<CalendarEvent> getEvents()

Specified by:

getEvents in interface CalendarEventProvider

setStartDateProperty

public void setStartDateProperty(String startDateProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents start date of event.

Specified by:

setStartDateProperty in interface EntityCalendarEventProvider

Parameters:

startDateProperty - the name of the property that represents start date of event

getStartDateProperty

@Nullable
public String getStartDateProperty()

Specified by:

getStartDateProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents start date of event

setEndDateProperty

public void setEndDateProperty(String endDateProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents end date of event.

Specified by:

setEndDateProperty in interface EntityCalendarEventProvider

Parameters:

endDateProperty - the name of the property that represents end date of event

getEndDateProperty

@Nullable
public String getEndDateProperty()

Specified by:

getEndDateProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents end date of event

setCaptionProperty

public void setCaptionProperty(String captionProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents caption of event.

Specified by:

setCaptionProperty in interface EntityCalendarEventProvider

Parameters:

captionProperty - the name of the property that represents caption of event

getCaptionProperty

@Nullable
public String getCaptionProperty()

Specified by:

getCaptionProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents caption of event

setDescriptionProperty

public void setDescriptionProperty(String descriptionProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents description of event.

Specified by:

setDescriptionProperty in interface EntityCalendarEventProvider

Parameters:

descriptionProperty - the name of the property that represents description of event

getDescriptionProperty

@Nullable
public String getDescriptionProperty()

Specified by:

getDescriptionProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents description of event

setStyleNameProperty

public void setStyleNameProperty(String styleNameProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents style name of event.

Specified by:

setStyleNameProperty in interface EntityCalendarEventProvider

Parameters:

styleNameProperty - the name of the property that represents style name of event

getStyleNameProperty

@Nullable
public String getStyleNameProperty()

Specified by:

getStyleNameProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents style name of event

setAllDayProperty

public void setAllDayProperty(String allDayProperty)

Description copied from interface: EntityCalendarEventProvider

Sets the name of the property that represents whether event is an all-day event.

Specified by:

setAllDayProperty in interface EntityCalendarEventProvider

Parameters:

allDayProperty - true if this event is an all-day event, false otherwise

getIsAllDayProperty

@Nullable
public String getIsAllDayProperty()

Specified by:

getIsAllDayProperty in interface EntityCalendarEventProvider

Returns:

true if this event is an all-day event, false otherwise

unbind

public void unbind()

Specified by:

unbind in interface EntityCalendarEventProvider