Packagecom.flexcalendar.components.calendar.core.dataModel
Classpublic class CalendarItemSet
InheritanceCalendarItemSet Inheritance flash.events.EventDispatcher
Implements ICalendarItemSet
Subclasses BaseRemoteCalendarItemSet

Class describing set of items.



Public Properties
 PropertyDefined By
  backgroundProcessing : Boolean
Get information whether remote background processing operation is taking place in CaledarItemSet.
CalendarItemSet
  cache : CalendarItemSetCache
[read-only] Gets this CalendarItemSet cache
CalendarItemSet
  calendarItems : ArrayCollection
[read-only]
CalendarItemSet
  dataProvider : ICalendarDataProvider
CalendarItemSet
  items : ArrayCollection
Deprecated: Deprecated
[read-only] Returns collection of items.
CalendarItemSet
  itemSetColors : IRendererColors
CalendarItemSet
  name : String
CalendarItemSet
  parentCalendarComponent : FlexCalendar
[read-only]
CalendarItemSet
  readOnly : Boolean
Get flag that indicates whether calendar is displayed as readonly or not
CalendarItemSet
  size : int
[read-only] Gets number of items in calendarItemSet.
CalendarItemSet
  visible : Boolean
CalendarItemSet
Protected Properties
 PropertyDefined By
  _cache : CalendarItemSetCache
Cache for for this calendar item set
CalendarItemSet
  _dataProvider : ICalendarDataProvider
Data provider owning this item set
CalendarItemSet
  _items : ArrayCollection
CalendarItemSet
  _itemSetColors : IRendererColors
Colors object.
CalendarItemSet
  _name : String
Name of the item set - can be null
CalendarItemSet
  _readOnly : Boolean = false
Flag that indicates whether calendar is displayed as readonly or not
CalendarItemSet
  _visible : Boolean = true
FLat that indicates whether items are displayed or not
CalendarItemSet
Public Methods
 MethodDefined By
  
CalendarItemSet(readOnly:Boolean = false, name:String = null, itemSetColors:IRendererColors = null)
Crete new calendar item set.
CalendarItemSet
  
Add new item to the item set.
CalendarItemSet
  
addItemAsSpace(item:ICalendarItem, itemType:int):void
Deprecated: Deprecated
Adds item to items collection as space of given type.
CalendarItemSet
  
CalendarItemSet
  
CalendarItemSet
  
CalendarItemSet
  
CalendarItemSet
  
Get index of this CalendarItemSet in dataProvider - counting only visible CalendarItemSets.
CalendarItemSet
  
Invalidate this Calendar Item set's cache.
CalendarItemSet
  
isEditable():Boolean
CalendarItemSet
  
Function called when item in this item set has been added.
CalendarItemSet
  
Function called when item in this item set has been modified.
CalendarItemSet
  
Function called when item in this item set has been removed.
CalendarItemSet
  
Function called when metadata of this item set has been updated.
CalendarItemSet
  
Remove item from the item set.
CalendarItemSet
Property Detail
_cacheproperty
protected var _cache:CalendarItemSetCache

Cache for for this calendar item set

_dataProviderproperty 
protected var _dataProvider:ICalendarDataProvider

Data provider owning this item set

_itemsproperty 
protected var _items:ArrayCollection

_itemSetColorsproperty 
protected var _itemSetColors:IRendererColors

Colors object. Contains colors information describing renderer.

_nameproperty 
protected var _name:String

Name of the item set - can be null

_readOnlyproperty 
protected var _readOnly:Boolean = false

Flag that indicates whether calendar is displayed as readonly or not

_visibleproperty 
protected var _visible:Boolean = true

FLat that indicates whether items are displayed or not

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]


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

This property can be used as the source for data binding.


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

This property can be used as the source for data binding.


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

This property can be used as the source for data binding.


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


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

Get flag that indicates whether calendar is displayed as readonly or not

This property can be used as the source for data binding.


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

This property can be used as the source for data binding.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor Detail
CalendarItemSet()Constructor
public function CalendarItemSet(readOnly:Boolean = false, name:String = null, itemSetColors:IRendererColors = null)

Crete new calendar item set.

Parameters
readOnly:Boolean (default = false)
 
name:String (default = null)
 
itemSetColors:IRendererColors (default = null)
Method Detail
addItem()method
public function addItem(item:ICalendarItem):void

Add new item to the item set.

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

Parameters

dateRange:DateRange

Returns
Array
getItemAt()method 
public function getItemAt(index:int):ICalendarItem

Parameters

index:int

Returns
ICalendarItem
getItemIndex()method 
public function getItemIndex(item:ICalendarItem):int

Parameters

item:ICalendarItem

Returns
int
getItemsCount()method 
public function getItemsCount():int

Returns
int
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

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

Remove item from the item set.

Parameters

item:ICalendarItem — item to remvoe

Returns
ICalendarItem — removed item if success, otherwise null