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 java.lang.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 and Description
protected java.lang.String	allDayProperty
protected java.lang.String	captionProperty
protected io.jmix.core.common.event.Subscription	collectionChangeListener
protected CollectionContainer<E>	container
protected java.lang.String	descriptionProperty
protected java.lang.String	endDateProperty
protected io.jmix.core.common.event.EventHub	events
protected java.util.List<CalendarEvent>	itemsCache
protected io.jmix.core.common.event.Subscription	propertyChangeListener
protected java.lang.String	startDateProperty
protected java.lang.String	styleNameProperty

Constructor Summary

Constructors

Constructor and Description
ContainerCalendarEventProvider(CollectionContainer<E> container)

Method Summary

Modifier and Type	Method and Description
void	addEvent(CalendarEvent event) Adds CalendarEvent to the event provider list.
io.jmix.core.common.event.Subscription	addEventSetChangeListener(java.util.function.Consumer<CalendarEventProvider.EventSetChangeEvent> listener)
java.lang.String	getCaptionProperty()
CollectionContainer<E>	getContainer()
java.lang.String	getDescriptionProperty()
java.lang.String	getEndDateProperty()
java.util.List<CalendarEvent>	getEvents()
java.lang.String	getIsAllDayProperty()
java.lang.String	getStartDateProperty()
java.lang.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(java.util.function.Consumer<CalendarEventProvider.EventSetChangeEvent> listener)
void	setAllDayProperty(java.lang.String allDayProperty) Sets the name of the property that represents whether event is an all-day event.
void	setCaptionProperty(java.lang.String captionProperty) Sets the name of the property that represents caption of event.
void	setDescriptionProperty(java.lang.String descriptionProperty) Sets the name of the property that represents description of event.
void	setEndDateProperty(java.lang.String endDateProperty) Sets the name of the property that represents end date of event.
void	setStartDateProperty(java.lang.String startDateProperty) Sets the name of the property that represents start date of event.
void	setStyleNameProperty(java.lang.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 Detail

itemsCache

protected java.util.List<CalendarEvent> itemsCache

container

protected CollectionContainer<E> container

startDateProperty

protected java.lang.String startDateProperty

endDateProperty

protected java.lang.String endDateProperty

captionProperty

protected java.lang.String captionProperty

descriptionProperty

protected java.lang.String descriptionProperty

styleNameProperty

protected java.lang.String styleNameProperty

allDayProperty

protected java.lang.String allDayProperty

events

protected io.jmix.core.common.event.EventHub events

collectionChangeListener

protected io.jmix.core.common.event.Subscription collectionChangeListener

propertyChangeListener

protected io.jmix.core.common.event.Subscription propertyChangeListener

Constructor Detail

ContainerCalendarEventProvider

public ContainerCalendarEventProvider(CollectionContainer<E> container)

Method Detail

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 io.jmix.core.common.event.Subscription addEventSetChangeListener(java.util.function.Consumer<CalendarEventProvider.EventSetChangeEvent> listener)

Specified by:

addEventSetChangeListener in interface CalendarEventProvider

removeEventSetChangeListener

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

Specified by:

removeEventSetChangeListener in interface CalendarEventProvider

Parameters:

listener - a listener to remove

getEvents

public java.util.List<CalendarEvent> getEvents()

Specified by:

getEvents in interface CalendarEventProvider

setStartDateProperty

public void setStartDateProperty(java.lang.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 java.lang.String getStartDateProperty()

Specified by:

getStartDateProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents start date of event

setEndDateProperty

public void setEndDateProperty(java.lang.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 java.lang.String getEndDateProperty()

Specified by:

getEndDateProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents end date of event

setCaptionProperty

public void setCaptionProperty(java.lang.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 java.lang.String getCaptionProperty()

Specified by:

getCaptionProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents caption of event

setDescriptionProperty

public void setDescriptionProperty(java.lang.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 java.lang.String getDescriptionProperty()

Specified by:

getDescriptionProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents description of event

setStyleNameProperty

public void setStyleNameProperty(java.lang.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 java.lang.String getStyleNameProperty()

Specified by:

getStyleNameProperty in interface EntityCalendarEventProvider

Returns:

the name of the property that represents style name of event

setAllDayProperty

public void setAllDayProperty(java.lang.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 java.lang.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