com.imagine.component.calendar.events
Class CalendarEvent

java.lang.Object
  com.imagine.component.calendar.events.CalendarEvent

Direct Known Subclasses:

CalendarEventCalendarMetricsProviderChanged, CalendarEventCalendarNavigationControllerChanged, CalendarEventCalendarRendererProviderChanged, CalendarEventDateSelectedByKey, CalendarEventDateSelectedByMouse, CalendarEventEmptySelectionAllowedChanged, CalendarEventExtraMonthDaysVisibleStatusChanged, CalendarEventFirstDayOfWeekChanged, CalendarEventGridVisibleStatusChanged, CalendarEventHeaderCellSelectedByMouse, CalendarEventHoverEffectStatusChanged, CalendarEventInputAction, CalendarEventInterColumnsSpacingChanged, CalendarEventInterRowsSpacingChanged, CalendarEventLocaleChanged, CalendarEventMaxMonthsNamesLengthChanged, CalendarEventMaxWeekDaysNamesLengthChanged, CalendarEventMonthViewCurrentDateChanged, CalendarEventSelectionModelChanged, CalendarEventSkinPropertyChanged, CalendarEventSkinStyleChanged, CalendarEventStatusPanelNoneLabelChanged, CalendarEventStatusPanelTodayLabelChanged, CalendarEventStatusPanelVisibleValueChanged, CalendarEventWeekCellSelectedByMouse, CalendarEventWeekVisibleStatusChanged

public abstract class CalendarEvent

extends java.lang.Object

This class will be extended by all the calendar events.

Constructor Summary

CalendarEvent(CalendarComponent calendarComponent)
Create a CalendarEvent event.

Method Summary

void	consume() Consume the event.
CalendarComponent	getCalendarComponent() Get the parent CalendarComponent.
boolean	isConsumed() Returns true if the event is consumed, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarEvent

public CalendarEvent(CalendarComponent calendarComponent)

Create a CalendarEvent event.

Parameters:

calendarComponent - The parent CalendarComponent object.

Method Detail

getCalendarComponent

public CalendarComponent getCalendarComponent()

Get the parent CalendarComponent.

Returns:

The parent CalendarComponent.

isConsumed

public boolean isConsumed()

Returns true if the event is consumed, false otherwise.
If the event is consumed then the event will no longer be sent to the listeners.

Returns:

true if the event is consumed, false otherwise.

consume

public void consume()

Consume the event. After this function call the event will no longer be sent to the listeners.