Packagecom.keepcore.calendar.view.renderers
Interfacepublic interface ICalendarItemRenderer extends mx.core.IUIComponent, mx.core.IInvalidating
Implementors CalendarItemRendererAbstract

The ICalendarItemRenderer interface defines the interface for calendar item renderers.



Public Properties
 PropertyDefined By
  backgroundColor : Number
Background color.
ICalendarItemRenderer
  calendarItem : CalendarItem
Parent calendar item.
ICalendarItemRenderer
  dayViewIsEnd : Boolean
Flag used to indicate if the item renderer is the event end.
ICalendarItemRenderer
  dayViewIsStart : Boolean
Flag used to indicate if the item renderer is the event start.
ICalendarItemRenderer
  displayMode : Number
Current display mode (month, week or day).
ICalendarItemRenderer
  doubleClickEnabled : Boolean
Must set the doubleClickEnabled property.
ICalendarItemRenderer
  duration : Number
Item duration.
ICalendarItemRenderer
  isDragged : Boolean
Flag used to indicate if the item is dragged.
ICalendarItemRenderer
  isEnd : Boolean
Flag used to indicate if the item is an end.
ICalendarItemRenderer
  isResized : Boolean
Flag used to indicate if the item is resized.
ICalendarItemRenderer
  isRollOver : Boolean
Indicates if item is rolled over (mouse upon it).
ICalendarItemRenderer
  isSpecialEventSplitOn2Days : Boolean
Special flag to manage event split on 2 days.
ICalendarItemRenderer
  rendererId : Number
The renderer ID.
ICalendarItemRenderer
  resizeButton : ICalendarResizeButtonRenderer
Resize button.
ICalendarItemRenderer
  resourceField : String
Resource field string.
ICalendarItemRenderer
  secondDayPartRenderer : ICalendarItemRenderer
Reference to the second part renderer (event split on 2 days).
ICalendarItemRenderer
  specialEventSplitOn2DaysFirstPartHidden : Boolean
Special flag to manage event split on 2 days.
ICalendarItemRenderer
  specialEventSplitOn2DaysIsOnlySecondDayDisplay : Boolean
Special flag to manage event split on 2 days.
ICalendarItemRenderer
  specialEventSplitOn2DaysSecondDayHeight : Number
Special flag to manage event split on 2 days.
ICalendarItemRenderer
  specialEventSplitOn2DaysSecondNoResize : Boolean
Special flag to manage event split on 2 days.
ICalendarItemRenderer
  text : String
Item text.
ICalendarItemRenderer
  title : String
Item text.
ICalendarItemRenderer
Public Methods
 MethodDefined By
  
clone(cloneCalendarItem:Boolean = true):ICalendarItemRenderer
Returns a clone of the renderer
ICalendarItemRenderer
  
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Return the renderer visible rectangle.
ICalendarItemRenderer
  
setHourToDisplay(date:Date):void
Called while the item is dragged.
ICalendarItemRenderer
Property Detail
backgroundColorproperty
backgroundColor:Number

Background color.


Implementation
    public function get backgroundColor():Number
    public function set backgroundColor(value:Number):void
calendarItemproperty 
calendarItem:CalendarItem

Parent calendar item.


Implementation
    public function get calendarItem():CalendarItem
    public function set calendarItem(value:CalendarItem):void
dayViewIsEndproperty 
dayViewIsEnd:Boolean

Flag used to indicate if the item renderer is the event end.


Implementation
    public function get dayViewIsEnd():Boolean
    public function set dayViewIsEnd(value:Boolean):void
dayViewIsStartproperty 
dayViewIsStart:Boolean

Flag used to indicate if the item renderer is the event start.


Implementation
    public function get dayViewIsStart():Boolean
    public function set dayViewIsStart(value:Boolean):void
displayModeproperty 
displayMode:Number

Current display mode (month, week or day).


Implementation
    public function get displayMode():Number
    public function set displayMode(value:Number):void
doubleClickEnabledproperty 
doubleClickEnabled:Boolean

Must set the doubleClickEnabled property.


Implementation
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
durationproperty 
duration:Number

Item duration.


Implementation
    public function get duration():Number
    public function set duration(value:Number):void
isDraggedproperty 
isDragged:Boolean

Flag used to indicate if the item is dragged.


Implementation
    public function get isDragged():Boolean
    public function set isDragged(value:Boolean):void
isEndproperty 
isEnd:Boolean

Flag used to indicate if the item is an end.


Implementation
    public function get isEnd():Boolean
    public function set isEnd(value:Boolean):void
isResizedproperty 
isResized:Boolean

Flag used to indicate if the item is resized.


Implementation
    public function get isResized():Boolean
    public function set isResized(value:Boolean):void
isRollOverproperty 
isRollOver:Boolean

Indicates if item is rolled over (mouse upon it).


Implementation
    public function get isRollOver():Boolean
    public function set isRollOver(value:Boolean):void
isSpecialEventSplitOn2Daysproperty 
isSpecialEventSplitOn2Days:Boolean

Special flag to manage event split on 2 days.


Implementation
    public function get isSpecialEventSplitOn2Days():Boolean
    public function set isSpecialEventSplitOn2Days(value:Boolean):void
rendererIdproperty 
rendererId:Number

The renderer ID. Calendar item can have multiple renderers if it is accross several weeks.


Implementation
    public function get rendererId():Number
    public function set rendererId(value:Number):void
resizeButtonproperty 
resizeButton:ICalendarResizeButtonRenderer

Resize button.


Implementation
    public function get resizeButton():ICalendarResizeButtonRenderer
    public function set resizeButton(value:ICalendarResizeButtonRenderer):void
resourceFieldproperty 
resourceField:String

Resource field string.


Implementation
    public function get resourceField():String
    public function set resourceField(value:String):void
secondDayPartRendererproperty 
secondDayPartRenderer:ICalendarItemRenderer

Reference to the second part renderer (event split on 2 days).


Implementation
    public function get secondDayPartRenderer():ICalendarItemRenderer
    public function set secondDayPartRenderer(value:ICalendarItemRenderer):void
specialEventSplitOn2DaysFirstPartHiddenproperty 
specialEventSplitOn2DaysFirstPartHidden:Boolean

Special flag to manage event split on 2 days.


Implementation
    public function get specialEventSplitOn2DaysFirstPartHidden():Boolean
    public function set specialEventSplitOn2DaysFirstPartHidden(value:Boolean):void
specialEventSplitOn2DaysIsOnlySecondDayDisplayproperty 
specialEventSplitOn2DaysIsOnlySecondDayDisplay:Boolean

Special flag to manage event split on 2 days.


Implementation
    public function get specialEventSplitOn2DaysIsOnlySecondDayDisplay():Boolean
    public function set specialEventSplitOn2DaysIsOnlySecondDayDisplay(value:Boolean):void
specialEventSplitOn2DaysSecondDayHeightproperty 
specialEventSplitOn2DaysSecondDayHeight:Number

Special flag to manage event split on 2 days.


Implementation
    public function get specialEventSplitOn2DaysSecondDayHeight():Number
    public function set specialEventSplitOn2DaysSecondDayHeight(value:Number):void
specialEventSplitOn2DaysSecondNoResizeproperty 
specialEventSplitOn2DaysSecondNoResize:Boolean

Special flag to manage event split on 2 days.


Implementation
    public function get specialEventSplitOn2DaysSecondNoResize():Boolean
    public function set specialEventSplitOn2DaysSecondNoResize(value:Boolean):void
textproperty 
text:String

Item text.


Implementation
    public function get text():String
    public function set text(value:String):void
titleproperty 
title:String

Item text.


Implementation
    public function get title():String
    public function set title(value:String):void
Method Detail
clone()method
public function clone(cloneCalendarItem:Boolean = true):ICalendarItemRenderer

Returns a clone of the renderer

Parameters

cloneCalendarItem:Boolean (default = true) — indicates if the corresponding item has to be cloned.

Returns
ICalendarItemRenderer
getVisibleRect()method 
public function getVisibleRect(targetParent:DisplayObject = null):Rectangle

Return the renderer visible rectangle.

Parameters

targetParent:DisplayObject (default = null)

Returns
Rectangle
setHourToDisplay()method 
public function setHourToDisplay(date:Date):void

Called while the item is dragged.

Parameters

date:Date