Packagecom.flexcalendar.components.calendar.core.dataModel
Interfacepublic interface ICalendarDataProvider extends flash.events.IEventDispatcher
Implementors CalendarDataProvider



Public Properties
 PropertyDefined By
  itemSets : ArrayCollection
Deprecated: Deprecated
[read-only] Returns collection of itemSets.
ICalendarDataProvider
  parentCalendarComponent : FlexCalendar
Reference to Calendar Component itself This value IS set while setting DataProvider to the FlexCalendar instance
ICalendarDataProvider
Public Methods
 MethodDefined By
  
Adds item set to item sets collection
ICalendarDataProvider
  
buildAlarmItemDetails(from:Date, to:Date):Array
Returns array of items, for which alarm should be fired between specified dates If CalendarItem is recurring, multiple instances of ItemDetails are created.
ICalendarDataProvider
  
Builds array of ItemDetails objects in requested period.
ICalendarDataProvider
  
Return item set at the specified index
ICalendarDataProvider
  
Returns index of the item set
ICalendarDataProvider
  
Get number of item sets - collections containing items
ICalendarDataProvider
  
Return item set at the specified index - taking into consideration only visible item sets.
ICalendarDataProvider
  
Get number of currently visible item sets.
ICalendarDataProvider
  
Invalidate cache in all Calendar Item sets.
ICalendarDataProvider
  
Removes item set from item sets collection
ICalendarDataProvider
Property Detail
itemSetsproperty
itemSets:ArrayCollection  [read-only]
Deprecated: Deprecated

Returns collection of itemSets. If you use it, don't modify this collection!! If you want to modify collection use addItemSet and removeItemSet methods.


Implementation
    public function get itemSets():ArrayCollection
parentCalendarComponentproperty 
parentCalendarComponent:FlexCalendar

Reference to Calendar Component itself This value IS set while setting DataProvider to the FlexCalendar instance


Implementation
    public function get parentCalendarComponent():FlexCalendar
    public function set parentCalendarComponent(value:FlexCalendar):void
Method Detail
addItemSet()method
public function addItemSet(itemSet:ICalendarItemSet):void

Adds item set to item sets collection

Parameters

itemSet:ICalendarItemSet — item set to add

buildAlarmItemDetails()method 
public function buildAlarmItemDetails(from:Date, to:Date):Array

Returns array of items, for which alarm should be fired between specified dates If CalendarItem is recurring, multiple instances of ItemDetails are created. If CalendarItem have multiple alarms, multiple instances of ItemDetails are created.

Parameters

from:Date — from date
 
to:Date — to date

Returns
Array — array of items in this period
buildItemDetailsForRequestedPeriodAsync()method 
public function buildItemDetailsForRequestedPeriodAsync(dateRange:DateRange):void

Builds array of ItemDetails objects in requested period. Should dispatch an event {

Parameters

dateRange:DateRange — - date range to build items for.

See also

when succeeded
getItemSetAt()method 
public function getItemSetAt(index:int):ICalendarItemSet

Return item set at the specified index

Parameters

index:int — index of the item set

Returns
ICalendarItemSet — CalendarItemSet if found, null otherwise
getItemSetIndex()method 
public function getItemSetIndex(itemSet:ICalendarItemSet):int

Returns index of the item set

Parameters

itemSet:ICalendarItemSet — item set to find

Returns
int — item set index if found, -1 otherwise
getItemSetsCount()method 
public function getItemSetsCount():int

Get number of item sets - collections containing items

Returns
int — number of item sets.
getVisibleItemSetAt()method 
public function getVisibleItemSetAt(index:int):ICalendarItemSet

Return item set at the specified index - taking into consideration only visible item sets.

Parameters

index:int — index of the visible item set

Returns
ICalendarItemSet — CalendarItemSet if found, null otherwise
getVisibleItemSetsCount()method 
public function getVisibleItemSetsCount():int

Get number of currently visible item sets.

Returns
int
invalidateCache()method 
public function invalidateCache():void

Invalidate cache in all Calendar Item sets.

removeItemSet()method 
public function removeItemSet(itemSet:ICalendarItemSet):ICalendarItemSet

Removes item set from item sets collection

Parameters

itemSet:ICalendarItemSet — item set to remove

Returns
ICalendarItemSet — removed item set, or null if not found