Packagecom.flexcalendar.components.calendar.utils
Classpublic class ItemDetails
InheritanceItemDetails Inheritance Object
Implements flash.events.IEventDispatcher

Class holding CalendarItems and it's item renderers



Public Properties
 PropertyDefined By
  calendarItem : ICalendarItem
Associated item instance
ItemDetails
  dayViewLongRenderers : Array
Array of long renderers for day view
ItemDetails
  dayViewRenderers : Array
Array of renderers for day view
ItemDetails
  end : Date
[read-only] Helper for getting end date, including added offset and time delta.
ItemDetails
  itemType : int
[read-only] Information about item type Some item types may be displayed in different way
ItemDetails
  monthViewLongRenderers : Array
Array of long renderers for month view
ItemDetails
  monthViewRenderers : Array
Array of renderers for month view
ItemDetails
  parentCalendarItemSet : ICalendarItemSet
ItemDetails
  requiredDayViewLongRenderers : int
Number of required long renderers for day view
ItemDetails
  requiredDayViewRenderers : int
Number of required renderers for day view
ItemDetails
  requiredMonthViewLongRenderers : int
Number of required long renderers for month view
ItemDetails
  requiredMonthViewRenderers : int
Number of required renderers for month view
ItemDetails
  start : Date
[read-only] Helper for getting start date, including added offset.
ItemDetails
  visibleEnd : Date
Real visible end of this item.
ItemDetails
  visibleStart : Date
Real visible start of this item.
ItemDetails
Public Methods
 MethodDefined By
  
ItemDetails(parentCalendarItemSet:ICalendarItemSet, calendarItem:ICalendarItem, recurrenceStart:Date = null)
Create instance of ItemDetails, encapsulating CalendarItem
ItemDetails
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
ItemDetails
  
Commit previously selected time offset and time delta to item item details.
ItemDetails
  
Discard previously selected time offset and time delta.
ItemDetails
  
dispatchEvent(event:Event):Boolean
ItemDetails
  
hasEventListener(type:String):Boolean
ItemDetails
  
isEditable():Boolean
Item is considered as editable, when calendar item is not read only.
ItemDetails
  
isLong():Boolean
Determine if item is long or not.
ItemDetails
  
isRecurring():Boolean
Helper function for determining if this associated item is recurring.
ItemDetails
  
isRegularItem():Boolean
Determine if item is regular one or not.
ItemDetails
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
ItemDetails
  
setTimeDelta(value:Number):void
Set time delta, when item is resizing.
ItemDetails
  
setTimeOffset(value:Number):void
Set time offset, when item is moving.
ItemDetails
  
[static] Helper function for sorting itemDetails by start time.
ItemDetails
  
willTrigger(type:String):Boolean
ItemDetails
Property Detail
calendarItemproperty
public var calendarItem:ICalendarItem

Associated item instance

dayViewLongRenderersproperty 
public var dayViewLongRenderers:Array

Array of long renderers for day view

dayViewRenderersproperty 
public var dayViewRenderers:Array

Array of renderers for day view

endproperty 
end:Date  [read-only]

Helper for getting end date, including added offset and time delta.


Implementation
    public function get end():Date
itemTypeproperty 
itemType:int  [read-only]

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


Implementation
    public function get itemType():int

See also

monthViewLongRenderersproperty 
public var monthViewLongRenderers:Array

Array of long renderers for month view

monthViewRenderersproperty 
public var monthViewRenderers:Array

Array of renderers for month view

parentCalendarItemSetproperty 
public var parentCalendarItemSet:ICalendarItemSet

requiredDayViewLongRenderersproperty 
public var requiredDayViewLongRenderers:int

Number of required long renderers for day view

requiredDayViewRenderersproperty 
public var requiredDayViewRenderers:int

Number of required renderers for day view

requiredMonthViewLongRenderersproperty 
public var requiredMonthViewLongRenderers:int

Number of required long renderers for month view

requiredMonthViewRenderersproperty 
public var requiredMonthViewRenderers:int

Number of required renderers for month view

startproperty 
start:Date  [read-only]

Helper for getting start date, including added offset.


Implementation
    public function get start():Date
visibleEndproperty 
visibleEnd:Date

Real visible end of this item. Since it is possible that item start time is before visible range start or end time is after visible range end, item renderer can display some tips that only part of item details is visible. If not set (or set to null), this value is same as end.

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


Implementation
    public function get visibleEnd():Date
    public function set visibleEnd(value:Date):void
visibleStartproperty 
visibleStart:Date

Real visible start of this item. Since it is possible that item start time is before visible range start or end time is after visible range end, item renderer can display some tips that only part of item details is visible. If not set (or set to null), this value is same as start. WARNING!!! This item is set by DayViewHeader - no one else shall use it!

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


Implementation
    public function get visibleStart():Date
    public function set visibleStart(value:Date):void
Constructor Detail
ItemDetails()Constructor
public function ItemDetails(parentCalendarItemSet:ICalendarItemSet, calendarItem:ICalendarItem, recurrenceStart:Date = null)

Create instance of ItemDetails, encapsulating CalendarItem

Parameters
parentCalendarItemSet:ICalendarItemSet — associated CalendarItem instance
 
calendarItem:ICalendarItem — start time of item - useful for recurring items, when this value describes start time of recurrence instance
 
recurrenceStart:Date (default = null)
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

commitChange()method 
public function commitChange():void

Commit previously selected time offset and time delta to item item details.

discardChange()method 
public function discardChange():void

Discard previously selected time offset and time delta.

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

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

Item is considered as editable, when calendar item is not read only.

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

Determine if item is long or not.

Returns
Boolean — true if item is long - has one day length or more
isRecurring()method 
public function isRecurring():Boolean

Helper function for determining if this associated item is recurring.

Returns
Boolean — true or false
isRegularItem()method 
public function isRegularItem():Boolean

Determine if item is regular one or not. Item is considered as regular when it's type == ItemType.REGULAR_ITEM

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

setTimeDelta()method 
public function setTimeDelta(value:Number):void

Set time delta, when item is resizing.

Parameters

value:Number — time delta, in milliseconds

setTimeOffset()method 
public function setTimeOffset(value:Number):void

Set time offset, when item is moving.

Parameters

value:Number — time offset, in milliseconds.

sortComparator()method 
public static function sortComparator(item1:ItemDetails, item2:ItemDetails):Number

Helper function for sorting itemDetails by start time.

Parameters

item1:ItemDetails
 
item2:ItemDetails

Returns
Number
willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean