Packagecom.flexcalendar.components.calendar.core.dataModel
Interfacepublic interface ICalendarItemSet extends flash.events.IEventDispatcher
Implementors CalendarItemSet



Public Properties
 PropertyDefined By
  backgroundProcessing : Boolean
Get information whether remote background processing operation is taking place in CaledarItemSet.
ICalendarItemSet
  cache : CalendarItemSetCache
[read-only] Gets this CalendarItemSet cache
ICalendarItemSet
  calendarItems : ArrayCollection
[read-only] Returns all calendar items in this calendar item set.
ICalendarItemSet
  dataProvider : ICalendarDataProvider
Owning ICalendarDataProvider
ICalendarItemSet
  items : ArrayCollection
Deprecated: Deprecated
[read-only] Returns collection of items.
ICalendarItemSet
  itemSetColors : IRendererColors
Default color of this item set - can be null
ICalendarItemSet
  name : String
Name of the item set - can be null
ICalendarItemSet
  parentCalendarComponent : FlexCalendar
[read-only] Reference to Calendar Component itself
ICalendarItemSet
  readOnly : Boolean
Flag that indicates whether calendar is displayed as readonly or not
ICalendarItemSet
  size : int
[read-only] Gets number of items in calendarItemSet.
ICalendarItemSet
  visible : Boolean
Control ItemSet visibility
ICalendarItemSet
Public Methods
 MethodDefined By
  
Adds item to items collection
ICalendarItemSet
  
addItemAsSpace(item:ICalendarItem, itemType:int):void
Deprecated: Deprecated
Adds item to items collection as space of given type.
ICalendarItemSet
  
Returns calendar items for given date range.
ICalendarItemSet
  
Get index of this CalendarItemSet in dataProvider - counting only visible CalendarItemSets.
ICalendarItemSet
  
Invalidate this Calendar Item set's cache.
ICalendarItemSet
  
isEditable():Boolean
True if item set can be edited - it is editable itself and it's parent calendar is editable
ICalendarItemSet
  
Function called when item in this item set has been added.
ICalendarItemSet
  
Function called when item in this item set has been modified.
ICalendarItemSet
  
Function called when item in this item set has been removed.
ICalendarItemSet
  
Function called when metadata of this item set has been updated.
ICalendarItemSet
  
Removes item from items collection
ICalendarItemSet
Property Detail
backgroundProcessingproperty
backgroundProcessing:Boolean

Get information whether remote background processing operation is taking place in CaledarItemSet.


Implementation
    public function get backgroundProcessing():Boolean
    public function set backgroundProcessing(value:Boolean):void
cacheproperty 
cache:CalendarItemSetCache  [read-only]

Gets this CalendarItemSet cache


Implementation
    public function get cache():CalendarItemSetCache
calendarItemsproperty 
calendarItems:ArrayCollection  [read-only]

Returns all calendar items in this calendar item set.


Implementation
    public function get calendarItems():ArrayCollection
dataProviderproperty 
dataProvider:ICalendarDataProvider

Owning ICalendarDataProvider


Implementation
    public function get dataProvider():ICalendarDataProvider
    public function set dataProvider(value:ICalendarDataProvider):void
itemsproperty 
items:ArrayCollection  [read-only]
Deprecated: Deprecated

Returns collection of items. Use get calendarItems instead.


Implementation
    public function get items():ArrayCollection
itemSetColorsproperty 
itemSetColors:IRendererColors

Default color of this item set - can be null


Implementation
    public function get itemSetColors():IRendererColors
    public function set itemSetColors(value:IRendererColors):void
nameproperty 
name:String

Name of the item set - can be null


Implementation
    public function get name():String
    public function set name(value:String):void
parentCalendarComponentproperty 
parentCalendarComponent:FlexCalendar  [read-only]

Reference to Calendar Component itself


Implementation
    public function get parentCalendarComponent():FlexCalendar
readOnlyproperty 
readOnly:Boolean

Flag that indicates whether calendar is displayed as readonly or not


Implementation
    public function get readOnly():Boolean
    public function set readOnly(value:Boolean):void
sizeproperty 
size:int  [read-only]

Gets number of items in calendarItemSet.


Implementation
    public function get size():int
visibleproperty 
visible:Boolean

Control ItemSet visibility


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method Detail
addItem()method
public function addItem(item:ICalendarItem):void

Adds item to items collection

Parameters

item:ICalendarItem — item to add

addItemAsSpace()method 
public function addItemAsSpace(item:ICalendarItem, itemType:int):void
Deprecated: Deprecated

Adds item to items collection as space of given type. This method is deprecated, please use addItem instead. If you want do add item as space, set itemType as ItemType.UNAVAILABLE_SPACE or ItemType.AVAILABLE_SPACE.

Parameters

item:ICalendarItem — - item to be added
 
itemType:int — - type of item space ItemType.UNAVAILABLE_SPACE or ItemType.AVAILABLE_SPACE

getEventsForRequestedPeriod()method 
public function getEventsForRequestedPeriod(dateRange:DateRange):Array

Returns calendar items for given date range.

Parameters

dateRange:DateRange

Returns
Array
getVisibleIndex()method 
public function getVisibleIndex():int

Get index of this CalendarItemSet in dataProvider - counting only visible CalendarItemSets.

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

Invalidate this Calendar Item set's cache.

isEditable()method 
public function isEditable():Boolean

True if item set can be edited - it is editable itself and it's parent calendar is editable

Returns
Boolean
onCalendarItemAdded()method 
public function onCalendarItemAdded(event:CalendarItemAddedEvent):void

Function called when item in this item set has been added.

Parameters

event:CalendarItemAddedEvent

onCalendarItemModified()method 
public function onCalendarItemModified(event:CalendarItemModificationEvent):void

Function called when item in this item set has been modified.

Parameters

event:CalendarItemModificationEvent

onCalendarItemRemoved()method 
public function onCalendarItemRemoved(event:CalendarItemRemovedEvent):void

Function called when item in this item set has been removed.

Parameters

event:CalendarItemRemovedEvent

onCalendarItemSetMetadataUpdated()method 
public function onCalendarItemSetMetadataUpdated(event:CalendarItemSetMetadataUpdatedEvent):void

Function called when metadata of this item set has been updated.

Parameters

event:CalendarItemSetMetadataUpdatedEvent

removeItem()method 
public function removeItem(item:ICalendarItem):ICalendarItem

Removes item from items collection

Parameters

item:ICalendarItem — item to remove

Returns
ICalendarItem — removed item, or null if not found