Packagecom.keepcore.calendar.view.renderers
Classpublic class CalendarMonthCellRendererAbstract
InheritanceCalendarMonthCellRendererAbstract Inheritance CalendarMonthDisplayer Inheritance CalendarPartDisplayer Inheritance mx.core.UIComponent
Implements ICalendarMonthCellRenderer
Subclasses CalendarMonthCellRenderer

The CalendarMonthCellRendererAbstract class defines the abstract class that calendar month cell renderer classes (used in year view) such as CalendarMonthCellRenderer could extend.



Public Properties
 PropertyDefined By
  calendarMonth : CalendarMonth
[override]
CalendarMonthCellRendererAbstract
 InheritedcalendarPart : CalendarPart
Calendar part reference.
CalendarPartDisplayer
 InheriteddrawToolTip : Boolean
Indicates if the part handles the tool tip drawing.
CalendarPartDisplayer
 InheritedfullDayToolTip : Boolean
Indicates if the displayed tooltip is always full day (used by day headers as example).
CalendarPartDisplayer
  manageCellBackground : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
  manageCellHighlight : Boolean
Indicates if the cell highlight display is managed.
CalendarMonthCellRendererAbstract
  manageDayColorFunction : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
  manageDayGrid : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
  manageDayLabels : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
  manageEndOfWeeks : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
  manageWeekLabels : Boolean
Indicates if the cell background display is managed.
CalendarMonthCellRendererAbstract
 InheritedmouseOverDate : Date
Indicates the current mouse over date.
CalendarPartDisplayer
 InheritedmouseOverDateColumn : int
Indicates the current mouse over date column (if column mode is enabled).
CalendarPartDisplayer
Protected Properties
 PropertyDefined By
  backgroundColor : Number
[read-only] Get the cell background color.
CalendarMonthCellRendererAbstract
Public Methods
 MethodDefined By
  
Contructor.
CalendarMonthCellRendererAbstract
 Inherited
In column mode, return the column width (takes in account the item margins).
CalendarPartDisplayer
 Inherited
If column mode is enabled, return the column index according to mouse X position.
CalendarPartDisplayer
  
localToDateTime(coordX:Number = -1, coordY:Number = -1, onlyCurrentDayTime:Boolean = false, eventTimeStepMultiple:Boolean = true):Date
[override] Return the date specified by mouse position in the current cell.
CalendarMonthCellRendererAbstract
 Inherited
refreshMouseTooltip(event:MouseEvent):void
Create or update the cell mouse tooltip.
CalendarPartDisplayer
Protected Methods
 MethodDefined By
  
[override]
CalendarMonthCellRendererAbstract
 Inherited
createMouseToolTip(date:Date, x:Number, y:Number):void
CalendarPartDisplayer
  
dayLabelClickHandler(event:MouseEvent):void
Day label click handler: if calendarLinksEnabled property is true, update the view else dispatch a DateClickEvent.DATE_CLICK event.
CalendarMonthCellRendererAbstract
 Inherited
CalendarPartDisplayer
 Inherited
drawHighlight(unscaledWidth:Number, columnWidth:Number, stepStartY:Number, stepHeight:Number, highlightAlpha:Number, rangeSelection:Boolean, noBorder:Boolean = false):void
CalendarPartDisplayer
 Inherited
drawRanges(ranges:ArrayCollection, aX:Number, aWidth:Number, bkgColor:uint, alpha:Number):void
Draw ranges.
CalendarPartDisplayer
 Inherited
getRangesRect(ranges:ArrayCollection, aX:Number, aWidth:Number):Array
Return array of Rectangle objects that defines the ranges coordinates.
CalendarPartDisplayer
  
measure():void
[override] Restrict minimum height.
CalendarMonthCellRendererAbstract
  
[override] Overriden resourcesChanged method.
CalendarMonthCellRendererAbstract
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Manage the month cell display: according to properties manages the day grid, days & weeks labels, background color & cell highlight.
CalendarMonthCellRendererAbstract
 Inherited
updateMouseToolTip(date:Date, x:Number, y:Number):void
CalendarPartDisplayer
  
weekLabelClickHandler(event:MouseEvent):void
Week label click handler: if calendarLinksEnabled property is true, update the view else dispatch a DateClickEvent.DATE_CLICK event.
CalendarMonthCellRendererAbstract
Property Detail
backgroundColorproperty
backgroundColor:Number  [read-only]

Get the cell background color.


Implementation
    protected function get backgroundColor():Number
calendarMonthproperty 
calendarMonth:CalendarMonth[override]


Implementation
    public function get calendarMonth():CalendarMonth
    public function set calendarMonth(value:CalendarMonth):void
manageCellBackgroundproperty 
manageCellBackground:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageCellBackground():Boolean
    public function set manageCellBackground(value:Boolean):void
manageCellHighlightproperty 
manageCellHighlight:Boolean

Indicates if the cell highlight display is managed.

The default value is true.


Implementation
    public function get manageCellHighlight():Boolean
    public function set manageCellHighlight(value:Boolean):void
manageDayColorFunctionproperty 
manageDayColorFunction:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageDayColorFunction():Boolean
    public function set manageDayColorFunction(value:Boolean):void
manageDayGridproperty 
manageDayGrid:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageDayGrid():Boolean
    public function set manageDayGrid(value:Boolean):void
manageDayLabelsproperty 
manageDayLabels:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageDayLabels():Boolean
    public function set manageDayLabels(value:Boolean):void
manageEndOfWeeksproperty 
manageEndOfWeeks:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageEndOfWeeks():Boolean
    public function set manageEndOfWeeks(value:Boolean):void
manageWeekLabelsproperty 
manageWeekLabels:Boolean

Indicates if the cell background display is managed.

The default value is true.


Implementation
    public function get manageWeekLabels():Boolean
    public function set manageWeekLabels(value:Boolean):void
Constructor Detail
CalendarMonthCellRendererAbstract()Constructor
public function CalendarMonthCellRendererAbstract(calendarMonth:CalendarMonth = null)

Contructor.

Parameters
calendarMonth:CalendarMonth (default = null) — CalendarMonth object
Method Detail
createChildren()method
override protected function createChildren():void

dayLabelClickHandler()method 
protected function dayLabelClickHandler(event:MouseEvent):void

Day label click handler: if calendarLinksEnabled property is true, update the view else dispatch a DateClickEvent.DATE_CLICK event.

Parameters

event:MouseEvent

localToDateTime()method 
override public function localToDateTime(coordX:Number = -1, coordY:Number = -1, onlyCurrentDayTime:Boolean = false, eventTimeStepMultiple:Boolean = true):Date

Return the date specified by mouse position in the current cell.

Parameters

coordX:Number (default = -1) — X coordinate
 
coordY:Number (default = -1) — Y coordinate
 
onlyCurrentDayTime:Boolean (default = false) — unused.
 
eventTimeStepMultiple:Boolean (default = true) — unused

Returns
Date — date time corresponding to coordinates
measure()method 
override protected function measure():void

Restrict minimum height.

resourcesChanged()method 
override protected function resourcesChanged():void

Overriden resourcesChanged method. Update day labels language on the fly.

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Manage the month cell display: according to properties manages the day grid, days & weeks labels, background color & cell highlight.

Parameters

unscaledWidth:Number
 
unscaledHeight:Number

weekLabelClickHandler()method 
protected function weekLabelClickHandler(event:MouseEvent):void

Week label click handler: if calendarLinksEnabled property is true, update the view else dispatch a DateClickEvent.DATE_CLICK event.

Parameters

event:MouseEvent