Packagecom.flexcalendar.components.calendar.core.dataModel
Interfacepublic interface ICalendarItem
Implementors CalendarItem



Public Properties
 PropertyDefined By
  data : Object
Data object - useful for storing additional data.
ICalendarItem
  daySpan : int
[read-only] Number of days in single item occurence
ICalendarItem
  description : String
Item description - optional details about this item
ICalendarItem
  duration : Number
[read-only] Duration of this item, in milliseconds
ICalendarItem
  end : Date
End time of this event.
ICalendarItem
  itemColors : IRendererColors
Colors object.
ICalendarItem
  itemId : String
Id of item that may be stored in database.
ICalendarItem
  itemSet : ICalendarItemSet
Owning ICalendarItemSet
ICalendarItem
  itemType : int
Information about item type Some item types may be displayed in different way
ICalendarItem
  readOnly : Boolean
Read only flag.
ICalendarItem
  recur : Recur
Recur instance, describing recurrence rules.
ICalendarItem
  start : Date
Start time of this event.
ICalendarItem
  summary : String
Item summary, for example item title ((accepts html text with basic html formatting tags)
ICalendarItem
  tooltip : String
Tooltip message
ICalendarItem
Public Methods
 MethodDefined By
  
addAlarm(alarm:Alarm):void
Returns number of alarms in the current calendar item
ICalendarItem
  
getAlarmAt(index:int):Alarm
Return alarm at the specified index
ICalendarItem
  
getAlarmIndex(alarm:Alarm):int
Return index of the alarm
ICalendarItem
  
Get number of alarms for this item
ICalendarItem
  
getRecurrenceStartDates(from:Date, to:Date):Array
Ger array of recurring events.
ICalendarItem
  
isEditable():Boolean
Calendar item is considered as editable, when it's not read only.
ICalendarItem
  
isRecurring():Boolean
Determine if item is recurring
ICalendarItem
  
removeAlarm(alarm:Alarm):void
Removes alarm from the alarm list
ICalendarItem
  
setRange(start:Date, end:Date):void
Set new range of event
ICalendarItem
Property Detail
dataproperty
data:Object

Data object - useful for storing additional data. This field is not used by default and can be accessed by


Implementation
    public function get data():Object
    public function set data(value:Object):void
daySpanproperty 
daySpan:int  [read-only]

Number of days in single item occurence


Implementation
    public function get daySpan():int
descriptionproperty 
description:String

Item description - optional details about this item


Implementation
    public function get description():String
    public function set description(value:String):void
durationproperty 
duration:Number  [read-only]

Duration of this item, in milliseconds


Implementation
    public function get duration():Number
endproperty 
end:Date

End time of this event.


Implementation
    public function get end():Date
    public function set end(value:Date):void
itemColorsproperty 
itemColors:IRendererColors

Colors object. Contains colors information describing renderer.


Implementation
    public function get itemColors():IRendererColors
    public function set itemColors(value:IRendererColors):void
itemIdproperty 
itemId:String

Id of item that may be stored in database.


Implementation
    public function get itemId():String
    public function set itemId(value:String):void
itemSetproperty 
itemSet:ICalendarItemSet

Owning ICalendarItemSet


Implementation
    public function get itemSet():ICalendarItemSet
    public function set itemSet(value:ICalendarItemSet):void
itemTypeproperty 
itemType:int

Information about item type Some item types may be displayed in different way


Implementation
    public function get itemType():int
    public function set itemType(value:int):void

See also

readOnlyproperty 
readOnly:Boolean

Read only flag. Indicates whether calendarItem is editable or not.


Implementation
    public function get readOnly():Boolean
    public function set readOnly(value:Boolean):void
recurproperty 
recur:Recur

Recur instance, describing recurrence rules. This value can be null if item is not recurring,


Implementation
    public function get recur():Recur
    public function set recur(value:Recur):void
startproperty 
start:Date

Start time of this event.


Implementation
    public function get start():Date
    public function set start(value:Date):void
summaryproperty 
summary:String

Item summary, for example item title ((accepts html text with basic html formatting tags)


Implementation
    public function get summary():String
    public function set summary(value:String):void
tooltipproperty 
tooltip:String

Tooltip message


Implementation
    public function get tooltip():String
    public function set tooltip(value:String):void
Method Detail
addAlarm()method
public function addAlarm(alarm:Alarm):void

Returns number of alarms in the current calendar item

Parameters

alarm:Alarm

getAlarmAt()method 
public function getAlarmAt(index:int):Alarm

Return alarm at the specified index

Parameters

index:int — index of the alarm

Returns
Alarm — index if found, -1 otherwise
getAlarmIndex()method 
public function getAlarmIndex(alarm:Alarm):int

Return index of the alarm

Parameters

alarm:Alarm — alarm to find

Returns
int — found alarm, null otherwise
getAlarmsCount()method 
public function getAlarmsCount():int

Get number of alarms for this item

Returns
int
getRecurrenceStartDates()method 
public function getRecurrenceStartDates(from:Date, to:Date):Array

Ger array of recurring events.

Parameters

from:Date — start date of requested period
 
to:Date — end date of requested period

Returns
Array — array of start dates
isEditable()method 
public function isEditable():Boolean

Calendar item is considered as editable, when it's not read only.

Returns
Boolean
isRecurring()method 
public function isRecurring():Boolean

Determine if item is recurring

Returns
Boolean — true if item is recurring, otherwise false
removeAlarm()method 
public function removeAlarm(alarm:Alarm):void

Removes alarm from the alarm list

Parameters

alarm:Alarm

setRange()method 
public function setRange(start:Date, end:Date):void

Set new range of event

Parameters

start:Date — start date
 
end:Date — end date