Packagecom.keepcore.calendar
Classpublic class KCCalendar
InheritanceKCCalendar Inheritance mx.core.Container

The KCCalendar class handles calendar mangement and calendar display.

Samples & additional information on KCCalendar on Flex-component.com website. Version 1.6.0 beta

Note: in the evaluation version, KeepCore logo is displayed as a watermark on each screen and an icon is displayed on each event providing a link to the Flex-component.com website.



Public Properties
 PropertyDefined By
  additionalImageField : String
The property name where is stored the additional image source.
KCCalendar
  additionalImageFunction : Function
The function used to define the additional image.
KCCalendar
  alwaysApplyStartHourDisplay : Boolean
Indicates if the first hour displayed on day & week view is always the startHourDisplay.
KCCalendar
  calendarControlBar : CalendarControlBar
[read-only] Calendar control bar.
KCCalendar
  calendarDayBarRenderer : IFactory
Specify the renderer class to be used as day bar renderer.
KCCalendar
  calendarDayCellRenderer : IFactory
Specify the renderer class to be used as day cell renderer.
KCCalendar
  calendarDayHeaderRenderer : IFactory
Specify the renderer class to be used as day cell renderer.
KCCalendar
  calendarHoursGridRenderer : IFactory
Specify the renderer class to be used as hour grid renderer.
KCCalendar
  calendarInvalidImage : Class
[static]
KCCalendar
  calendarItemRenderer : IFactory
Specify the calendar item renderer class.
KCCalendar
  calendarLinksEnabled : Boolean
Determines whether or not the user can click the calendar links (day/week/month/...).
KCCalendar
  calendarMonthCellRenderer : IFactory
Specify the renderer class to be used as month cell renderer (used in year view).
KCCalendar
  calendarMonthHeaderRenderer : IFactory
Specify the renderer class to be used as month header renderer (used in year view).
KCCalendar
  calendarWeekLabelRenderer : IFactory
Specify the renderer class to be used as week label renderer (used in month view).
KCCalendar
  calendarYearRenderer : IFactory
Specify the renderer class to be used in year view.
KCCalendar
  classicResourceImage : Class
[static]
KCCalendar
  classicResourceUndefinedImage : Class
[static]
KCCalendar
  colorField : String
The property name where is stored the event color.
KCCalendar
  colorFunction : Function
The function used to define the event color.
KCCalendar
  columnConcurrentEventDisplayMode : Number
Item concurrency display mode in column mode.
KCCalendar
  columnCount : int
Specify number of columns used when columnModeEnabled is true (no effect if columnModeEnabled is false).
KCCalendar
  columnField : String
The property name where is stored the event column (allowed range is 0 to columnCount-1).
KCCalendar
  columnFunction : Function
The function used to define the event column.
KCCalendar
  columnHeaderFunction : Function
The function used to define columns header when column mode is enabled.
KCCalendar
  columnHeaderHeight : Number
Column header height (column mode).
KCCalendar
  columnHeaderRenderer : IFactory
Specify the renderer class to be used as column header renderer (used in column mode).
KCCalendar
  columnModeEnabled : Boolean
Specify if column mode is enabled (disabled by default).
KCCalendar
  concurrentEventDisplayMode : Number
Item concurrency display mode.
KCCalendar
  controlBarVisible : Boolean
Controls the visibility of the control bar used to navigate.
KCCalendar
  currentDate : Date
Current calendar date.
KCCalendar
  dataProvider : ArrayCollection
Set of data to be viewed.
KCCalendar
  dayBarHeight : Number
Day bar height.
KCCalendar
  dayCellBorderVisible : Boolean
Determines if day cell border is displayed.
KCCalendar
  dayColorFunction : Function
The function used to define day color in year view.
KCCalendar
  dayDoubleSeparatorVisible : Boolean
Determines if a double bar is displayed to separate days in week view.
KCCalendar
  dayHeaderAllDayEventsHeightGap : Number
Horizontal gap between day cell header and all day events.
KCCalendar
  dayHeaderHeight : Number
Day cell header height.
KCCalendar
  dayHeaderVisible : Boolean
Specify if the day header is visible in week/day view.
KCCalendar
  dayOffset : int
Specify the week starting day.
KCCalendar
  diffTimeZone : int
Specify the difference between the client system time zone and the time zone to use
KCCalendar
  displayAllItemsNumberInMonthView : Boolean
Specify if number of all items is displayed in month view
KCCalendar
  displayCurrentHourBar : Boolean
Specify if current hour bar must be displayed on week & day views.
KCCalendar
  displayFullDayEvents : Boolean
Specify if the full days are displayed in week/day view.
KCCalendar
  displayItemsInFullSizeInMonthView : Boolean
Specify if items in month view are displayed in full size (fit day cell size).
KCCalendar
  displayMode : Number
Current display mode.
KCCalendar
  displayMonthNamesInAllDays : Boolean
Specify if month names are displayed on all days cells.
KCCalendar
  dragAndDropOriginalItemVisible : Boolean
Indicates if the original item is visible during a drag & drop operation.
KCCalendar
  dragOverDayRangeEnabled : Boolean
Determines if user can drag an event after midnight and split events on 2 days in day/week view.
KCCalendar
  endHour : int
Indicates the end hour for day & week view.
KCCalendar
  endTimeField : String
The property name where is stored the event end time.
KCCalendar
  endTimeFunction : Function
The function used to define the event end time.
KCCalendar
  errorItems : ArrayCollection
[read-only]
KCCalendar
  eventMultiSelectEnabled : Boolean
Specify if event multi selection is enabled.
KCCalendar
  eventMultiSelectionLassoModeEnabled : Boolean
Specify if event multi selection is enabled in lasso mode.
KCCalendar
  eventsHeight : Number
Events height.
KCCalendar
  eventTimeStep : int
Indicates the event time steps in minutes.
KCCalendar
  eventTimeStepInMs : int
[read-only]
KCCalendar
  hiddenDays : Array
Contains day numbers to be hidden in month & week views.
KCCalendar
  hideInactiveDaysInDayView : Boolean
Specify if inactive days (different that the current displayed one) in day view are displayed.
KCCalendar
  highlightDayRangeColumnFunction : Function
The function used to define some highlight range in a day (used in week & day views) when column mode is enabled.
KCCalendar
  highlightDayRangeFunction : Function
The function used to define some highlight range in a day (used in week & day views).
KCCalendar
  hourBarStep : Number
Determines the step of hour bar (week & day view).
KCCalendar
  hourHalfBarVisible : Boolean
Determines if a half hour bar is displayed.
KCCalendar
  hourHeight : int
Specify the hour height in pixels (used for hours grid in week & day views).
KCCalendar
  hoursBarVisible : Boolean
Specify if the hours bar is visible.
KCCalendar
  hoursCount : int
[read-only] Returns number of displayed hours.
KCCalendar
  hoursGridWidth : Number
Hours grid width.
KCCalendar
  iconCalendarInvalid : Class
Current calendar icon.
KCCalendar
  iconResource : Class
Current resource icon.
KCCalendar
  iconResourceUndefined : Class
Current resource undefined icon.
KCCalendar
  invalidDayRangeColumnFunction : Function
The function used to define some invalid range in a day (used in week & day views) when column mode is enabled.
KCCalendar
  invalidDayRangeFunction : Function
The function used to define some invalid range in a day (used in week & day views).
KCCalendar
  isLassoSelectionInProgress : Boolean
[read-only]
KCCalendar
  itemCornerRadius : Number
Item corner radius.
KCCalendar
  itemLeftMargin : Number
Item left margin.
KCCalendar
  itemMargin : Number
Item margin.
KCCalendar
  itemRightMargin : Number
Item right margin.
KCCalendar
  items : ArrayCollection
[read-only] List of CalendarItem (one for each dataProvider objects)
KCCalendar
  keepRangeSelectionVisible : Boolean
Indicates if the range selection should remain visible upon mouse up.
KCCalendar
  labelField : String
The property name of objects where the event label is stored.
KCCalendar
  labelFunction : Function
The function used to define the event label.
KCCalendar
  lassoSelectionEnabled : Boolean
Indicates if lasso selection is enabled (controlled by CRTL key).
KCCalendar
  monthHeaderHeight : Number
Month header height (year view).
KCCalendar
  mouseSelectionColumnToolTipFunction : Function
The function used to define the cell column selection tooltip.
KCCalendar
  mouseSelectionFullHour : Boolean
Determines the selected range highlighted upon mouse over (active only if mouseSelectionVisibleChanged is enabled).
KCCalendar
  mouseSelectionStep : int
Determines the selected range highlighted upon mouse over (active only if mouseSelectionVisibleChanged is enabled & mouseSelectionFullHour is false).
KCCalendar
  mouseSelectionToolTipFunction : Function
The function used to define the cell selection tooltip.
KCCalendar
  mouseSelectionToolTipVisible : Boolean
Indicates if a tooltip is displayed upon mouse over (active even if mouseSelectionVisibleChanged is false).
KCCalendar
  mouseSelectionVisible : Boolean
Determines if step over user mouse is displayed (if enabled, color used is defined by the mouseSelectionBackgroundColor style (day & week views).
KCCalendar
  mouseWheelNavigationEnabled : Boolean
Determines if mouse wheel navigation is enabled.
KCCalendar
  multipleDaysForYearRenderer : Boolean
Specify if an event that is accross several days is taken in account for each day (true) or only for its first day (false), in year view.
KCCalendar
  notDisplayedItemsIndicatorVisible : Boolean
Specify if indicators (yellow arrows in day/week view) of not displayed items must be visible.
KCCalendar
  otherColumnDragEnabled : Boolean
Specify if drag is enabled on other columns than the original event one.
KCCalendar
  rangeSelection : DateRange
Gives the selected range.
KCCalendar
  rangeSelectionEnabled : Boolean
Indicates if range selection is enabled on cells.
KCCalendar
  rangeSelectionInProgress : Boolean
Indicates if a range selection is in progress.
KCCalendar
  readOnlyField : String
The property name where is stored the event readOnly.
KCCalendar
  readOnlyFunction : Function
The function used to define the event readOnly.
KCCalendar
  resizeBottomImage : Class
[static]
KCCalendar
  resizeButtonHeight : int
Specify the event resize button heigth (vertical events).
KCCalendar
  resizeButtonWidth : int
Specify the event resize button width (horizontal events).
KCCalendar
  resizeOverDayRangeEnabled : Boolean
Determines if user can resize an event on multiple days in day/week view.
KCCalendar
  resizeRightImage : Class
[static]
KCCalendar
  resourceField : String
The property name where is stored the event resource.
KCCalendar
  resourceFunction : Function
The function used to define the event resource.
KCCalendar
  selectableField : String
The property name where is stored the event selectable.
KCCalendar
  selectableFunction : Function
The function used to define the event selectable.
KCCalendar
  selectedItem : CalendarItem
Currently selected item.
KCCalendar
  selectedItems : ArrayCollection
Currently selected items.
KCCalendar
  showEventHours : Boolean
Specify if event hours must be displayed in items.
KCCalendar
  stackedEventGapHeight : int
Specify the gap height in pixels between each stacked event (used if stacked events enabled).
KCCalendar
  stackedEventHeight : int
Specify the stacked event height in pixels (used if stacked events enabled).
KCCalendar
  stackedEventsEnabled : Boolean
Specify whether the events should not be positioned at the right time, if true events are stacked from the first hour of the day.
KCCalendar
  startHour : int
Indicates the start hour for day & week view.
KCCalendar
  startHourDisplay : int
Indicates the first hour displayed on day & week view.
KCCalendar
  startTimeField : String
The property name where is stored the event start time.
KCCalendar
  startTimeFunction : Function
The function used to define the event start time.
KCCalendar
  staticEventDispatcher : IEventDispatcher
[static] [read-only]
KCCalendar
  statusField : String
The property name where is stored the event status.
KCCalendar
  statusFunction : Function
The function used to define the event status.
KCCalendar
  titleField : String
The property name of objects where the event title is stored.
KCCalendar
  titleFunction : Function
The function used to define the event title.
KCCalendar
  todayButtonVisible : Boolean
Controls the visibility of the today button in the control bar.
KCCalendar
  toolTipFunction : Function
The function used to define the event tooltip.
KCCalendar
  transitionConfig : TransitionConfig
Specify the transition configuration.
KCCalendar
  transitionEnabled : Boolean
Specify if transitions are enabled (animated transitions).
KCCalendar
  useGradientInItemRenderers : Boolean
Specify if event renderers use gradient fills.
KCCalendar
  useRollOverInItemRenderers : Boolean
Specify if event renderer alpha changes upon mouse roll over.
KCCalendar
  visibleEventCount : int
[read-only] Number of visible items in the current view.
KCCalendar
  visibleItems : ArrayCollection
[read-only] List of visible CalendarItem in the current view (one for each displayed dataProvider object)
KCCalendar
  visibleRange : DateRange
[read-only]
KCCalendar
  weekDayHeadersVisible : Boolean
Determines if day headers are visible in week view.
KCCalendar
  weekDayViewCellsItems : ArrayCollection
[read-only] Get the CalendarItem objects that are displayed in cells (not full days events) in day/week view.
KCCalendar
  weekDayViewHeaderItems : ArrayCollection
[read-only] Get the CalendarItem objects that are displayed in header (full days events) in day/week view.
KCCalendar
  weekNumberVisible : Boolean
Determines if week number is visible in all views.
KCCalendar
  weekNumberVisibleForMonthView : Boolean
Determines if week number is visible in all views.
KCCalendar
  weekNumberVisibleForWeekAndDayView : Boolean
Determines if week number is visible in all views.
KCCalendar
  weekNumberVisibleForYearView : Boolean
Determines if week number is visible in all views.
KCCalendar
  weeksBarWidth : Number
Weeks bar width (month view).
KCCalendar
  yearToolTipFunction : Function
The function used to define the year events tooltip.
KCCalendar
  yearViewVisible : Boolean
Controls the visibility of the year view.
KCCalendar
Public Methods
 MethodDefined By
  
Class constructor The constructor manages the component creation and initialization. In order to specify your own labels for control bar buttons, tooltips and calendar Today button, you have to define a Calendar.properties file (ResourceBundle). This file must contains: "Previous" "Next" "Day" "Week" "Month" "Year" "Now" "Today" (for the mini-calendar) You can also provide: your own hour format by setting the "hourFormat".
KCCalendar
  
Internal usage.
KCCalendar
  
KCCalendar
  
Empty the current selection.
KCCalendar
  
Force a full update as if resource have been changed (could be useful when you use runtime localization)
KCCalendar
  
generateCode():String
This function is used by the test application and allows developper to easily generate MXML code of the KCCalendar component.
KCCalendar
  
Get the event additional image.
KCCalendar
  
getCalendarEventColor(item:Object):Number
Get the color of an event.
KCCalendar
  
getCalendarEventColumn(item:Object, checkRange:Boolean = true):int
Get the event column.
KCCalendar
  
getCalendarEventEndTime(item:Object):Date
Get the EndTime of an event
KCCalendar
  
getCalendarEventLabel(item:Object):String
Get the label of an event
KCCalendar
  
getCalendarEventReadOnly(item:Object, readOnlyForStackedEventsEnabled:Boolean = true):Boolean
Get the read-only state of an event.
KCCalendar
  
getCalendarEventResource(item:Object):String
Get the ressource of an event
KCCalendar
  
getCalendarEventSelectable(item:Object):Boolean
Get the event selectable state.
KCCalendar
  
getCalendarEventStartTime(item:Object):Date
Get the StartTime of an event
KCCalendar
  
getCalendarEventStatus(item:Object):int
Get the status of an event.
KCCalendar
  
getCalendarEventTitle(item:Object):String
Get the title of an event
KCCalendar
  
Return the current date range according to current display mode and current locale.
KCCalendar
  
KCCalendar
  
Returns the date index according to hidden days (from 0 to 6).
KCCalendar
  
getDurationAccordingToHiddenDays(dateIndex:int, duration:Number):Number
Returns the duration according to hidden days.
KCCalendar
  
KCCalendar
  
Returns the hiddenDays array with index updated according to the dayOffset setting.
KCCalendar
  
Reverse getDayIndexAccordingToHiddenDays function.
KCCalendar
  
Returns the original date index according to hidden days (from 0 to 6) for the month view.
KCCalendar
  
getPendingCalendarItems():ArrayCollection
Retrieves the CalendarItems that contains some pending modifications (start or end dates).
KCCalendar
  
KCCalendar
  
KCCalendar
  
isDayView():Boolean
KCCalendar
  
isMonthView():Boolean
KCCalendar
  
isPV():Boolean
KCCalendar
  
isWeekOrDayView():Boolean
KCCalendar
  
isWeekView():Boolean
KCCalendar
  
isYearView():Boolean
KCCalendar
  
Retrieves the CalendarItem managing the given data provider item.
KCCalendar
  
loadDataFromSharedObject(name:String, itemObjectClass:Class):void
Loads data provider objects from a shared object.
KCCalendar
  
Load data provider objects from a binary file.
KCCalendar
  
Set calendar to its maximum size in order for all cells to be displayed
KCCalendar
  
next():void
Change current date, set it to next: Year view: current date is set to the 1st January of next year Month view: current date is set to the 1st of next month Week view: current date is set to current date plus 7 days Day view: current date is set to the next day Note: if in day view, previous date is hidden by hiddenDays properties, the first next day not hidden will de displayed
KCCalendar
  
previous():void
Change current date, set it to previous: Year view: current date is set to the 1st January of previous year Month view: current date is set to the 1st of previous month Week view: current date is set to current date minus 7 days Day view: current date is set to the previous day Note: if in day view, previous date is hidden by hiddenDays properties, the first previous day not hidden will de displayed
KCCalendar
  
printCurrentView(doNotPrint:Boolean = false):Image
Prints an image capture of the calendar's current view
KCCalendar
  
saveDataToSharedObject(name:String, itemObjectClass:Class):void
Save data provider objects in a shared object.
KCCalendar
  
saveToFile(fileName:String = KCCalendarData.bin, respectPrivacy:Boolean = true):void
Save data provider objects in a binary file.
KCCalendar
  
In day or week, scroll to allow user to see the first item visible (first means the one with the smaller start hour).
KCCalendar
  
setDayView():void
Set display mode to day view.
KCCalendar
  
setEndHourInternal(value:int):void
Internal function used in stacked event mode.
KCCalendar
  
Set display mode to month view.
KCCalendar
  
setStyle(styleProp:String, newValue:*):void
[override] Overriden setStyle method.
KCCalendar
  
Set display mode to week view.
KCCalendar
  
Set display mode to year view.
KCCalendar
  
KCCalendar
  
traceItems(items:ArrayCollection, prefix:String):void
KCCalendar
  
Internal usage.
KCCalendar
Protected Methods
 MethodDefined By
  
KCCalendar
  
KCCalendar
  
[override] Overriden commitProperties method.
KCCalendar
  
KCCalendar
  
KCCalendar
  
KCCalendar
  
KCCalendar
  
KCCalendar
  
KCCalendar
  
measure():void
[override] Overriden measure method.
KCCalendar
  
[override] Overriden resourcesChanged method.
KCCalendar
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Overriden updateDisplayList method.
KCCalendar
Events
 Event Summary Defined By
  Dispatched when the user clicks on a calendar cell where there is no event.KCCalendar
  Dispatched when the user double-clicks on a calendar cell where there is no event.KCCalendar
  Dispatched when the current date is changed.KCCalendar
  Dispatched when the user clicks on a week number / a day / a month leading to a view change (and only if calendarLinksEnabled is false).KCCalendar
  Dispatched when the display mode is changed.KCCalendar
  Dispatched before the display mode is changed and before views are updated (note that displayMode is already up-to-date when event is trigger).KCCalendar
  Dispatched when an event has been changed.KCCalendar
  Dispatched when an event has been clicked.KCCalendar
  Dispatched when an event has been double-clicked.KCCalendar
  Dispatched when the user rolls the mouse out of an event.KCCalendar
  Dispatched when the user rolls the mouse over an event.KCCalendar
  Dispatched when the user selects an event.KCCalendar
  Dispatched when the visible range changes.KCCalendar
Styles
 Style Description Defined By
  
calendarControlBarBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Control bar background color. The default value is 0xFFFFFF.
KCCalendar
  
columnHeaderFontStyleName
Type: String CSS Inheritance: no
Font style used for column headers (only used if columnMode is endabled and columnHeader function is specified). The default value is "".
KCCalendar
  
currentHourBarColor
Type: uint Format: Color CSS Inheritance: no
Current hour bar color - bar is displayed on week & day views (used if displayCurrentHourBar property is true). The default value is #FF0000.
KCCalendar
  
dayCellBackgroundAlpha
Type: Number Format: Color CSS Inheritance: no
Alpha of the days cells background. The default value is 0.5.
KCCalendar
  
dayCellBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the days cells. The default value is #EEEEEE.
KCCalendar
  
dayCellBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the day cells. The default value is #BBBBBB.
KCCalendar
  
dayCellInactiveBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the inactive days cells. The default value is #D8D8D8.
KCCalendar
  
dayCellTodayBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the today day cell. The default value is #FFF777.
KCCalendar
  
dayColorAlpha
Type: Number CSS Inheritance: no
The alpha used by the dayColorFunction if defined (for year view). The default value is 1.
KCCalendar
  
dayHeaderBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the days header. The default value is #DDDDDD.
KCCalendar
  
dayHeaderBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the days header. The default value is #BBBBBB.
KCCalendar
  
dayHeaderFontStyleName
Type: String CSS Inheritance: no
Font style used for day header labels. The default value is "".
KCCalendar
  
dayHeaderInactiveBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the inactive days header. The default value is #D8D8D8.
KCCalendar
  
dayHeaderTodayBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the today day header. The default value is #FFF777.
KCCalendar
  
daysBarBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the bar displaying days (for month, week & day views). The default value is #CCCCCC.
KCCalendar
  
daysBarBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the bar displaying days. The default value is #BBBBBB.
KCCalendar
  
daysBarFontStyleName
Type: String CSS Inheritance: no
Font style used for day labels display in day bar (for month, week & day views). The default value is "".
KCCalendar
  
defaultItemBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Default event background color (used when item do not specify a color). The default value is #FFA7A7.
KCCalendar
  
highlightDayRangeBackgroundAlpha
Type: Number CSS Inheritance: no
Highlight day range background color (only used if highlightDayRangeFunction is specified). The default value is 0.5.
KCCalendar
  
highlightDayRangeBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Highlight day range background color (only used if highlightDayRangeFunction is specified). The default value is #FF0033.
KCCalendar
  
hourHalfBarBorderAlpha
Type: Number CSS Inheritance: no
Border alpha of the bar displayed for half hour (displayed only if hourHalfBarVisible is true). The default value is 0.5.
KCCalendar
  
hourHalfBarBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the bar displayed for half hour (displayed only if hourHalfBarVisible is true). The default value is #CCCCCC.
KCCalendar
  
hoursBarBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the bar displaying hours in week/day view. The default value is #CCCCCC.
KCCalendar
  
hoursBarBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the bar displaying hours in week/day view. The default value is #BBBBBB.
KCCalendar
  
hoursBarFontStyleName
Type: String CSS Inheritance: no
Font style used for hours labels display in week/day view. The default value is "".
KCCalendar
  
invalidDayRangeBackgroundAlpha
Type: Number CSS Inheritance: no
Invalid day range background color (only used if invalidDayRangeFunction is specified). The default value is 0.5.
KCCalendar
  
invalidDayRangeBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Invalid day range background color (only used if invalidDayRangeFunction is specified). The default value is #777777.
KCCalendar
  
itemHoursFontStyleName
Type: String CSS Inheritance: no
Font style used for item hours. The default value is "".
KCCalendar
  
itemLabelFontStyleName
Type: String CSS Inheritance: no
Font style used for item labels. The default value is "".
KCCalendar
  
itemTitleFontStyleName
Type: String CSS Inheritance: no
Font style used for item titles. The default value is "".
KCCalendar
  
monthHeaderBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Month header background color in year view. The default value is #DDDDDD.
KCCalendar
  
monthHeaderBorderColor
Type: uint Format: Color CSS Inheritance: no
Month header border color in year view. The default value is #999999.
KCCalendar
  
monthHeaderTodayBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Current month header background color in year view. The default value is #FFF777.
KCCalendar
  
mouseSelectionBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the user selection in week/day view. The default value is #ADD8E6.
KCCalendar
  
notDisplayedItemsIndicatorFontStyleName
Type: String CSS Inheritance: no
Font style used for not displayed item indicator (yellow arrow by default) in week/day view. The default value is "".
KCCalendar
  
weekFontStyleName
Type: String CSS Inheritance: no
Font style used for week label in week & day views). The default value is "".
KCCalendar
  
weeksBarBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color of the bar displaying weeks in month view. The default value is #CCCCCC.
KCCalendar
  
weeksBarBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the bar displaying weeks in month view. The default value is #BBBBBB.
KCCalendar
  
yearDayBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the day cells displayed in year view. The default value is #BBBBBB.
KCCalendar
  
yearDayFontStyleName
Type: String CSS Inheritance: no
Font style used for days labels displayed in year view. The default value is "".
KCCalendar
  
yearDayWeekEndBorderColor
Type: uint Format: Color CSS Inheritance: no
Border color of the last day in the week displayed in year view (used to graphically separate weeks). The default value is #444444.
KCCalendar
  
yearMonthHeaderFontStyleName
Type: String CSS Inheritance: no
Font style used for month header labels displayed in year view. The default value is "".
KCCalendar
  
yearRendererFontStyleName
Type: String CSS Inheritance: no
Font style used for event count display in default year renderer. The default value is "".
KCCalendar
  
yearWeekFontStyleName
Type: String CSS Inheritance: no
Font style used for weeks labels displayed in year view. The default value is "".
KCCalendar
Public Constants
 ConstantDefined By
  CALENDAR_CONTROL_BAR_BACKGROUND_COLOR : String = calendarControlBarBackgroundColor
[static]
KCCalendar
  COLUMN_HEADER_FONT_STYLE : String = columnHeaderFontStyleName
[static]
KCCalendar
  CURRENT_HOUR_BAR_COLOR_STYLE : String = currentHourBarColor
[static]
KCCalendar
  DAY_CELL_BACKGROUND_ALPHA_STYLE : String = dayCellBackgroundAlpha
[static]
KCCalendar
  DAY_CELL_BACKGROUND_COLOR_STYLE : String = dayCellBackgroundColor
[static]
KCCalendar
  DAY_CELL_BORDER_COLOR_STYLE : String = dayCellBorderColor
[static]
KCCalendar
  DAY_CELL_INACTIVE_BACKGROUND_COLOR_STYLE : String = dayCellInactiveBackgroundColor
[static]
KCCalendar
  DAY_CELL_TODAY_BACKGROUND_COLOR_STYLE : String = dayCellTodayBackgroundColor
[static]
KCCalendar
  DAY_COLOR_ALPHA : String = dayColorAlpha
[static]
KCCalendar
  DAY_HEADER_BACKGROUND_COLOR_STYLE : String = dayHeaderBackgroundColor
[static]
KCCalendar
  DAY_HEADER_BORDER_COLOR_STYLE : String = dayHeaderBorderColor
[static]
KCCalendar
  DAY_HEADER_FONT_STYLE : String = dayHeaderFontStyleName
[static]
KCCalendar
  DAY_HEADER_INACTIVE_BACKGROUND_COLOR_STYLE : String = dayHeaderInactiveBackgroundColor
[static]
KCCalendar
  DAY_HEADER_TODAY_BACKGROUND_COLOR_STYLE : String = dayHeaderTodayBackgroundColor
[static]
KCCalendar
  DAYS_BAR_BACKGROUND_COLOR_STYLE : String = daysBarBackgroundColor
[static]
KCCalendar
  DAYS_BAR_BORDER_COLOR_STYLE : String = daysBarBorderColor
[static]
KCCalendar
  DAYS_BAR_FONT_STYLE : String = daysBarFontStyleName
[static]
KCCalendar
  DAYS_DOUBLE_BAR_SEPARATOR_SHOWING_STYLE : String = daysDoubleBarSeparatorShowing
[static]
KCCalendar
  DAY_VIEW : Number = 2
[static]
KCCalendar
  DEFAULT_ITEM_BACKGROUND_COLOR : String = defaultItemBackgroundColor
[static]
KCCalendar
  DISPLAY_MODE_CHANGE : String = displayModeChange
[static]
KCCalendar
  DISPLAY_MODE_CHANGING : String = displayModeChanging
[static]
KCCalendar
  FULL_VERSION : String
[static]
KCCalendar
  HIGHLIGHT_DAY_RANGE_BACKGROUND_ALPHA : String = highlightDayRangeBackgroundAlpha
[static]
KCCalendar
  HIGHLIGHT_DAY_RANGE_BACKGROUND_COLOR : String = highlightDayRangeBackgroundColor
[static]
KCCalendar
  HOUR_HALF_BAR_BORDER_ALPHA_STYLE : String = hourHalfBarBorderAlpha
[static]
KCCalendar
  HOUR_HALF_BAR_BORDER_COLOR_STYLE : String = hourHalfBarBorderColor
[static]
KCCalendar
  HOURS_BAR_BACKGROUND_COLOR_STYLE : String = hoursBarBackgroundColor
[static]
KCCalendar
  HOURS_BAR_BORDER_COLOR_STYLE : String = hoursBarBorderColor
[static]
KCCalendar
  HOURS_BAR_FONT_STYLE : String = hoursBarFontStyleName
[static]
KCCalendar
  INVALID_DAY_RANGE_BACKGROUND_ALPHA : String = invalidDayRangeBackgroundAlpha
[static]
KCCalendar
  INVALID_DAY_RANGE_BACKGROUND_COLOR : String = invalidDayRangeBackgroundColor
[static]
KCCalendar
  ITEM_HOURS_FONT_STYLE : String = itemHoursFontStyleName
[static]
KCCalendar
  ITEM_LABEL_FONT_STYLE : String = itemLabelFontStyleName
[static]
KCCalendar
  ITEM_TITLE_FONT_STYLE : String = itemTitleFontStyleName
[static]
KCCalendar
  KC_DEMO_TEXT : String = KCCalendarwww.flex-component.com
[static]
KCCalendar
  KC_WEBSITE : String = http://www.flex-component.com/
[static]
KCCalendar
  MAX_CALENDAR_COUNT : Number = 3
[static]
KCCalendar
  MONTH_HEADER_BACKGROUND_COLOR_STYLE : String = monthHeaderBackgroundColor
[static]
KCCalendar
  MONTH_HEADER_BORDER_COLOR_STYLE : String = monthHeaderBorderColor
[static]
KCCalendar
  MONTH_HEADER_TODAY_BACKGROUND_COLOR_STYLE : String = monthHeaderTodayBackgroundColor
[static]
KCCalendar
  MONTH_VIEW : Number = 0
[static]
KCCalendar
  MOUSE_SELECTION_BACKGROUND_COLOR : String = mouseSelectionBackgroundColor
[static]
KCCalendar
  NOT_DISPLAYED_ITEMS_INDICATOR_FONT_STYLE : String = notDisplayedItemsIndicatorFontStyleName
[static]
KCCalendar
  OVERLAP_MODE : Number = 1
[static]
KCCalendar
  SIDE_MODE : Number = 0
[static]
KCCalendar
  STATUS_UPDATING : int = 1
[static]
KCCalendar
  STATUS_UPDATING_STRING : String
[static]
KCCalendar
  STATUS_UP_TO_DATE : int = 0
[static]
KCCalendar
  STATUS_UP_TO_DATE_STRING : String
[static]
KCCalendar
  VERSION : String = 1.6.0
[static]
KCCalendar
  VISIBLE_RANGE_CHANGE : String = visibleRangeChange
[static]
KCCalendar
  WEEK_FONT_STYLE : String = weekFontStyleName
[static]
KCCalendar
  WEEKS_BAR_BACKGROUND_COLOR_STYLE : String = weeksBarBackgroundColor
[static]
KCCalendar
  WEEKS_BAR_BORDER_COLOR_STYLE : String = weeksBarBorderColor
[static]
KCCalendar
  WEEK_VIEW : Number = 1
[static]
KCCalendar
  YEAR_DAY_BORDER_COLOR_STYLE : String = yearDayBorderColor
[static]
KCCalendar
  YEAR_DAY_FONT_STYLE : String = yearDayFontStyleName
[static]
KCCalendar
  YEAR_DAY_WEEK_END_BORDER_COLOR_STYLE : String = yearDayWeekEndBorderColor
[static]
KCCalendar
  YEAR_MONTH_HEADER_FONT_STYLE : String = yearMonthHeaderFontStyleName
[static]
KCCalendar
  YEAR_RENDERER_FONT_STYLE : String = yearRendererFontStyleName
[static]
KCCalendar
  YEAR_VIEW : Number = 3
[static]
KCCalendar
  YEAR_WEEK_FONT_STYLE : String = yearWeekFontStyleName
[static]
KCCalendar
Property Detail
additionalImageFieldproperty
additionalImageField:String

The property name where is stored the additional image source. Additional image is optional.

The default value is "additionalImage"..


Implementation
    public function get additionalImageField():String
    public function set additionalImageField(value:String):void
additionalImageFunctionproperty 
additionalImageFunction:Function

The function used to define the additional image. If defined, the additionalImageField property is not used. Additional image is optional. The function must have the following signature: additionalImageFunction(item:Object): item is a data provider item. The function returns the image source to be displayed.

The default value is null..

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


Implementation
    public function get additionalImageFunction():Function
    public function set additionalImageFunction(value:Function):void
alwaysApplyStartHourDisplayproperty 
alwaysApplyStartHourDisplay:Boolean

Indicates if the first hour displayed on day & week view is always the startHourDisplay. If true, when user navigates on the same view, displayed start hour is reset to startHourDisplay else current user scroll is kept.

The default value is false..

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


Implementation
    public function get alwaysApplyStartHourDisplay():Boolean
    public function set alwaysApplyStartHourDisplay(value:Boolean):void
calendarControlBarproperty 
calendarControlBar:CalendarControlBar  [read-only]

Calendar control bar.


Implementation
    public function get calendarControlBar():CalendarControlBar
calendarDayBarRendererproperty 
calendarDayBarRenderer:IFactory

Specify the renderer class to be used as day bar renderer. The class must implement the ICalendarDayBarRenderer interface.

The default value is new ClassFactory(CalendarDayBarRenderer)..

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


Implementation
    public function get calendarDayBarRenderer():IFactory
    public function set calendarDayBarRenderer(value:IFactory):void
calendarDayCellRendererproperty 
calendarDayCellRenderer:IFactory

Specify the renderer class to be used as day cell renderer. The class must implement the ICalendarDayCellRenderer interface.

The default value is new ClassFactory(CalendarDayCellRenderer)..

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


Implementation
    public function get calendarDayCellRenderer():IFactory
    public function set calendarDayCellRenderer(value:IFactory):void
calendarDayHeaderRendererproperty 
calendarDayHeaderRenderer:IFactory

Specify the renderer class to be used as day cell renderer. The class must implement the ICalendarDayHeaderRenderer interface.

The default value is new ClassFactory(CalendarDayHeaderRenderer)..

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


Implementation
    public function get calendarDayHeaderRenderer():IFactory
    public function set calendarDayHeaderRenderer(value:IFactory):void
calendarHoursGridRendererproperty 
calendarHoursGridRenderer:IFactory

Specify the renderer class to be used as hour grid renderer. The class must implement the ICalendarHoursGridRenderer interface.

The default value is new ClassFactory(CalendarHoursGridRenderer)..

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


Implementation
    public function get calendarHoursGridRenderer():IFactory
    public function set calendarHoursGridRenderer(value:IFactory):void
calendarInvalidImageproperty 
calendarInvalidImage:Class

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


Implementation
    public static function get calendarInvalidImage():Class
    public static function set calendarInvalidImage(value:Class):void
calendarItemRendererproperty 
calendarItemRenderer:IFactory

Specify the calendar item renderer class. The class must implement the ICalendarItemRenderer interface.

The default value is new ClassFactory(CalendarItemRenderer)..

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


Implementation
    public function get calendarItemRenderer():IFactory
    public function set calendarItemRenderer(value:IFactory):void
calendarLinksEnabledproperty 
calendarLinksEnabled:Boolean

Determines whether or not the user can click the calendar links (day/week/month/...).

The default value is true..

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


Implementation
    public function get calendarLinksEnabled():Boolean
    public function set calendarLinksEnabled(value:Boolean):void
calendarMonthCellRendererproperty 
calendarMonthCellRenderer:IFactory

Specify the renderer class to be used as month cell renderer (used in year view). The class must implement the ICalendarMonthCellRenderer interface.

The default value is new ClassFactory(CalendarMonthCellRenderer)..

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


Implementation
    public function get calendarMonthCellRenderer():IFactory
    public function set calendarMonthCellRenderer(value:IFactory):void
calendarMonthHeaderRendererproperty 
calendarMonthHeaderRenderer:IFactory

Specify the renderer class to be used as month header renderer (used in year view). The class must implement the ICalendarMonthHeaderRenderer interface.

The default value is new ClassFactory(CalendarMonthHeaderRenderer)..

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


Implementation
    public function get calendarMonthHeaderRenderer():IFactory
    public function set calendarMonthHeaderRenderer(value:IFactory):void
calendarWeekLabelRendererproperty 
calendarWeekLabelRenderer:IFactory

Specify the renderer class to be used as week label renderer (used in month view). The class must implement the ICalendarWeekLabelRenderer interface.

The default value is new ClassFactory(CalendarWeekLabelRenderer)..

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


Implementation
    public function get calendarWeekLabelRenderer():IFactory
    public function set calendarWeekLabelRenderer(value:IFactory):void
calendarYearRendererproperty 
calendarYearRenderer:IFactory

Specify the renderer class to be used in year view. The class must implement the ICalendarYearRenderer interface.

The default value is new ClassFactory(CalendarYearRenderer)..

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


Implementation
    public function get calendarYearRenderer():IFactory
    public function set calendarYearRenderer(value:IFactory):void
classicResourceImageproperty 
classicResourceImage:Class

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


Implementation
    public static function get classicResourceImage():Class
    public static function set classicResourceImage(value:Class):void
classicResourceUndefinedImageproperty 
classicResourceUndefinedImage:Class

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


Implementation
    public static function get classicResourceUndefinedImage():Class
    public static function set classicResourceUndefinedImage(value:Class):void
colorFieldproperty 
colorField:String

The property name where is stored the event color. It is only used if no colorFunction is defined.

The default value is "color"..


Implementation
    public function get colorField():String
    public function set colorField(value:String):void
colorFunctionproperty 
colorFunction:Function

The function used to define the event color. If defined, the colorField property is not used. The function must have the following signature: colorFunction(item:Object):Number item is a data provider item. The function returns the event color that will be displayed for the event.

The default value is null..


Implementation
    public function get colorFunction():Function
    public function set colorFunction(value:Function):void
columnConcurrentEventDisplayModeproperty 
columnConcurrentEventDisplayMode:Number

Item concurrency display mode in column mode. Property can be set to change mode. Allowed values are:

  • SIDE_MODE: concurrent events are displayed side to side (event width is adapted)
  • OVERLAP_MODE: concurrent events are displayed at the same location (event width is maximal)
  • The default value is SIDE_MODE..

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


    Implementation
        public function get columnConcurrentEventDisplayMode():Number
        public function set columnConcurrentEventDisplayMode(value:Number):void
    columnCountproperty 
    columnCount:int

    Specify number of columns used when columnModeEnabled is true (no effect if columnModeEnabled is false). When column mode is enabled, items are displayed in week & day views in columns.

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


    Implementation
        public function get columnCount():int
        public function set columnCount(value:int):void
    columnFieldproperty 
    columnField:String

    The property name where is stored the event column (allowed range is 0 to columnCount-1). It is only used if columnModeEnabled is true and no columnFunction is defined.

    The default value is "column". Note that invalid column range (< 0 or >= columnCount) can be used to hide items, it could be used as an optimization to avoid using a filterFunction on the dataProvider..


    Implementation
        public function get columnField():String
        public function set columnField(value:String):void
    columnFunctionproperty 
    columnFunction:Function

    The function used to define the event column. If defined, the columnField property is not used. It is only used if columnModeEnabled is true. The function must have the following signature: columnFunction(item:Object):int item is a data provider item. The function returns the column index where the item should be displayed (allowed range is 0 to columnCount-1).

    The default value is null. Note that invalid column range (< 0 or >= columnCount) can be used to hide items, it could be used as an optimization to avoid using a filterFunction on the dataProvider..


    Implementation
        public function get columnFunction():Function
        public function set columnFunction(value:Function):void
    columnHeaderFunctionproperty 
    columnHeaderFunction:Function

    The function used to define columns header when column mode is enabled. It is only used if columnModeEnabled is true. If undefined, the column won't have any header. The function must have the following signature: columnHeaderFunction(columnIndex:int):IColumnHeader columnIndex is the column index (from 0 to columnCount - 1). The function returns an object that must implement the IColumnHeader interface (label & color accessors).

    The default value is null..


    Implementation
        public function get columnHeaderFunction():Function
        public function set columnHeaderFunction(value:Function):void
    columnHeaderHeightproperty 
    columnHeaderHeight:Number

    Column header height (column mode). Property can be set to change the column header height.

    The default value is 20..

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


    Implementation
        public function get columnHeaderHeight():Number
        public function set columnHeaderHeight(value:Number):void
    columnHeaderRendererproperty 
    columnHeaderRenderer:IFactory

    Specify the renderer class to be used as column header renderer (used in column mode). The class must implement the IColumnHeaderRenderer interface.

    The default value is new ClassFactory(ColumnHeaderRenderer)..

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


    Implementation
        public function get columnHeaderRenderer():IFactory
        public function set columnHeaderRenderer(value:IFactory):void
    columnModeEnabledproperty 
    columnModeEnabled:Boolean

    Specify if column mode is enabled (disabled by default). When column mode is enabled, each data item must specify a display column index (allowed range is 0 to columnCount-1). Items will be displayed in week & day views in columns according to the specified column index.

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


    Implementation
        public function get columnModeEnabled():Boolean
        public function set columnModeEnabled(value:Boolean):void
    concurrentEventDisplayModeproperty 
    concurrentEventDisplayMode:Number

    Item concurrency display mode. Property can be set to change mode. Allowed values are:

  • SIDE_MODE: concurrent events are displayed side to side (event width is adapted)
  • OVERLAP_MODE: concurrent events are displayed at the same location (event width is maximal)
  • The default value is SIDE_MODE..

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


    Implementation
        public function get concurrentEventDisplayMode():Number
        public function set concurrentEventDisplayMode(value:Number):void
    controlBarVisibleproperty 
    controlBarVisible:Boolean

    Controls the visibility of the control bar used to navigate.

    The default value is true..

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


    Implementation
        public function get controlBarVisible():Boolean
        public function set controlBarVisible(value:Boolean):void
    currentDateproperty 
    currentDate:Date

    Current calendar date. Property can be set to change current calendar display. Warning: you have to set a new Date object, you must not modify the currentDate else the component won't detect the change. Note: if display mode is DAY_VIEW and the current date day is hidden by the hiddenDays property, the next day not hidden will be selected as the current date.

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


    Implementation
        public function get currentDate():Date
        public function set currentDate(value:Date):void
    dataProviderproperty 
    dataProvider:ArrayCollection

    Set of data to be viewed. You can use CalendarObjectSample as a base class for objects.

    The default value is null.


    Implementation
        public function get dataProvider():ArrayCollection
        public function set dataProvider(value:ArrayCollection):void
    dayBarHeightproperty 
    dayBarHeight:Number

    Day bar height. Property can be set to change the day bar height.

    The default value is 20..

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


    Implementation
        public function get dayBarHeight():Number
        public function set dayBarHeight(value:Number):void
    dayCellBorderVisibleproperty 
    dayCellBorderVisible:Boolean

    Determines if day cell border is displayed.

    The default value is true..

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


    Implementation
        public function get dayCellBorderVisible():Boolean
        public function set dayCellBorderVisible(value:Boolean):void
    dayColorFunctionproperty 
    dayColorFunction:Function

    The function used to define day color in year view. If not defined, dayCellBackgroundColor is used as day background color. The function must have the following signature: dayColorFunction(date:Date):Number date is the day date. The function returns the color and could return NaN to define no color.

    The default value is null..

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


    Implementation
        public function get dayColorFunction():Function
        public function set dayColorFunction(value:Function):void
    dayDoubleSeparatorVisibleproperty 
    dayDoubleSeparatorVisible:Boolean

    Determines if a double bar is displayed to separate days in week view.

    The default value is false..

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


    Implementation
        public function get dayDoubleSeparatorVisible():Boolean
        public function set dayDoubleSeparatorVisible(value:Boolean):void
    dayHeaderAllDayEventsHeightGapproperty 
    dayHeaderAllDayEventsHeightGap:Number

    Horizontal gap between day cell header and all day events. Property can be set to change the horizontal gap especially when using custom day header renderers.

    The default value is 20..

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


    Implementation
        public function get dayHeaderAllDayEventsHeightGap():Number
        public function set dayHeaderAllDayEventsHeightGap(value:Number):void
    dayHeaderHeightproperty 
    dayHeaderHeight:Number

    Day cell header height. Property can be set to change the height of day cell headers.

    The default value is 20..

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


    Implementation
        public function get dayHeaderHeight():Number
        public function set dayHeaderHeight(value:Number):void
    dayHeaderVisibleproperty 
    dayHeaderVisible:Boolean

    Specify if the day header is visible in week/day view.

    The default value is true..

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


    Implementation
        public function get dayHeaderVisible():Boolean
        public function set dayHeaderVisible(value:Boolean):void
    dayOffsetproperty 
    dayOffset:int

    Specify the week starting day.

    The default value is 1 (Monday)..

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


    Implementation
        public function get dayOffset():int
        public function set dayOffset(value:int):void
    diffTimeZoneproperty 
    diffTimeZone:int

    Specify the difference between the client system time zone and the time zone to use

    The default value is 0..

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


    Implementation
        public function get diffTimeZone():int
        public function set diffTimeZone(value:int):void
    displayAllItemsNumberInMonthViewproperty 
    displayAllItemsNumberInMonthView:Boolean

    Specify if number of all items is displayed in month view

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


    Implementation
        public function get displayAllItemsNumberInMonthView():Boolean
        public function set displayAllItemsNumberInMonthView(value:Boolean):void
    displayCurrentHourBarproperty 
    displayCurrentHourBar:Boolean

    Specify if current hour bar must be displayed on week & day views.

    The default value is true..

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


    Implementation
        public function get displayCurrentHourBar():Boolean
        public function set displayCurrentHourBar(value:Boolean):void
    displayFullDayEventsproperty 
    displayFullDayEvents:Boolean

    Specify if the full days are displayed in week/day view.

    The default value is true..

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


    Implementation
        public function get displayFullDayEvents():Boolean
        public function set displayFullDayEvents(value:Boolean):void
    displayItemsInFullSizeInMonthViewproperty 
    displayItemsInFullSizeInMonthView:Boolean

    Specify if items in month view are displayed in full size (fit day cell size).

    The default value is false..

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


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

    Current display mode. Property can be set to change mode. Allowed values are YEAR_VIEW, MONTH_VIEW, WEEK_VIEW and DAY_VIEW.

    The default value is MONTH_VIEW Note: if display mode is set to DAY_VIEW and the current day is hidden by the hiddenDays property, the next day not hidden will be selected as the current date..


    Implementation
        public function get displayMode():Number
        public function set displayMode(value:Number):void
    displayMonthNamesInAllDaysproperty 
    displayMonthNamesInAllDays:Boolean

    Specify if month names are displayed on all days cells. By default (property set to false), month names are only displayed for first & last day of months in month view and first & last day of current week in week view.

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


    Implementation
        public function get displayMonthNamesInAllDays():Boolean
        public function set displayMonthNamesInAllDays(value:Boolean):void
    dragAndDropOriginalItemVisibleproperty 
    dragAndDropOriginalItemVisible:Boolean

    Indicates if the original item is visible during a drag & drop operation.

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


    Implementation
        public function get dragAndDropOriginalItemVisible():Boolean
        public function set dragAndDropOriginalItemVisible(value:Boolean):void
    dragOverDayRangeEnabledproperty 
    dragOverDayRangeEnabled:Boolean

    Determines if user can drag an event after midnight and split events on 2 days in day/week view.

    The default value is false..

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


    Implementation
        public function get dragOverDayRangeEnabled():Boolean
        public function set dragOverDayRangeEnabled(value:Boolean):void
    endHourproperty 
    endHour:int

    Indicates the end hour for day & week view.

    The default value is 24..

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


    Implementation
        public function get endHour():int
        public function set endHour(value:int):void
    endTimeFieldproperty 
    endTimeField:String

    The property name where is stored the event end time. It is only used if no endTimeFunction is defined.

    The default value is "endTime"..


    Implementation
        public function get endTimeField():String
        public function set endTimeField(value:String):void
    endTimeFunctionproperty 
    endTimeFunction:Function

    The function used to define the event end time. If defined, the endTimeField property is not used. The function must have the following signature: endTimeFunction(item:Object):Date item is a data provider item. The function returns the time that will be used for the event end.

    The default value is null..


    Implementation
        public function get endTimeFunction():Function
        public function set endTimeFunction(value:Function):void
    errorItemsproperty 
    errorItems:ArrayCollection  [read-only]


    Implementation
        public function get errorItems():ArrayCollection
    eventMultiSelectEnabledproperty 
    eventMultiSelectEnabled:Boolean

    Specify if event multi selection is enabled. When it is enabled, you can use the selectedItems property (instead of selectedItem) to get references to selected items. Control & shift keys should be used to select multiple events.

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


    Implementation
        public function get eventMultiSelectEnabled():Boolean
        public function set eventMultiSelectEnabled(value:Boolean):void
    eventMultiSelectionLassoModeEnabledproperty 
    eventMultiSelectionLassoModeEnabled:Boolean

    Specify if event multi selection is enabled in lasso mode. In lasso mode, multiple selection done with shift keys doesn't use time ranges to select items but coordinates of start & end items.

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


    Implementation
        public function get eventMultiSelectionLassoModeEnabled():Boolean
        public function set eventMultiSelectionLassoModeEnabled(value:Boolean):void
    eventsHeightproperty 
    eventsHeight:Number

    Events height. Property can be set to change the event height: month view events & all-day event in day and week views.

    The default value is 20..

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


    Implementation
        public function get eventsHeight():Number
        public function set eventsHeight(value:Number):void
    eventTimeStepproperty 
    eventTimeStep:int

    Indicates the event time steps in minutes. This steps are used for event drag&drop and event resizing. Note: that it must be a divisor of 60: 10, 20, 30...

    The default value is 15..

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


    Implementation
        public function get eventTimeStep():int
        public function set eventTimeStep(value:int):void
    eventTimeStepInMsproperty 
    eventTimeStepInMs:int  [read-only]


    Implementation
        public function get eventTimeStepInMs():int
    hiddenDaysproperty 
    hiddenDays:Array

    Contains day numbers to be hidden in month & week views. It should contains day numbers (0 for Monday, 1 for Tuesday..., 6 for Sunday). Note: days are hidden in month & week views but thay can still be accessible via day view and navigation with control bar. If you don't want this behaviour you have to override the default navigation management by binding currenDate property for example.


    Implementation
        public function get hiddenDays():Array
        public function set hiddenDays(value:Array):void
    hideInactiveDaysInDayViewproperty 
    hideInactiveDaysInDayView:Boolean

    Specify if inactive days (different that the current displayed one) in day view are displayed.

    The default value is false..

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


    Implementation
        public function get hideInactiveDaysInDayView():Boolean
        public function set hideInactiveDaysInDayView(value:Boolean):void
    highlightDayRangeColumnFunctionproperty 
    highlightDayRangeColumnFunction:Function

    The function used to define some highlight range in a day (used in week & day views) when column mode is enabled. The function must have the following signature: highlightDayRangeColumnFunctionChanged(date:Date, column:int):ArrayCollection // of DateRange // date is the day date. column is the column index (starting from 0 to columnCount-1). The function returns an ArrayCollection of DateRange objects that specify the highlighted ranges. The ArrayCollection could be null or empty to specify no highlighted range for this day.

    The default value is null..

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


    Implementation
        public function get highlightDayRangeColumnFunction():Function
        public function set highlightDayRangeColumnFunction(value:Function):void
    highlightDayRangeFunctionproperty 
    highlightDayRangeFunction:Function

    The function used to define some highlight range in a day (used in week & day views). The function must have the following signature: highlightDayRangeFunctionChanged(date:Date):ArrayCollection // of DateRange // date is the day date. The function returns an ArrayCollection of DateRange objects that specify the highlighted ranges. The ArrayCollection could be null or empty to specify no highlighted range for this day.

    The default value is null..

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


    Implementation
        public function get highlightDayRangeFunction():Function
        public function set highlightDayRangeFunction(value:Function):void
    hourBarStepproperty 
    hourBarStep:Number

    Determines the step of hour bar (week & day view). If hourBarStep is NaN (default), no bar is displayed in each hour (only one if hourHalfBarVisible is set to true). Note: that it must be a divisor of 60: 10, 20, 30...

    The default value is NaN..

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


    Implementation
        public function get hourBarStep():Number
        public function set hourBarStep(value:Number):void
    hourHalfBarVisibleproperty 
    hourHalfBarVisible:Boolean

    Determines if a half hour bar is displayed.

    The default value is false..

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


    Implementation
        public function get hourHalfBarVisible():Boolean
        public function set hourHalfBarVisible(value:Boolean):void
    hourHeightproperty 
    hourHeight:int

    Specify the hour height in pixels (used for hours grid in week & day views).

    The default value is 40..

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


    Implementation
        public function get hourHeight():int
        public function set hourHeight(value:int):void
    hoursBarVisibleproperty 
    hoursBarVisible:Boolean

    Specify if the hours bar is visible. Note that if stackedEventsEnabled is set to true, the hours bar is hidden.

    The default value is true..

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


    Implementation
        public function get hoursBarVisible():Boolean
        public function set hoursBarVisible(value:Boolean):void
    hoursCountproperty 
    hoursCount:int  [read-only]

    Returns number of displayed hours.


    Implementation
        public function get hoursCount():int
    hoursGridWidthproperty 
    hoursGridWidth:Number

    Hours grid width. Property can be set to change the hours grid width.

    The default value is 60..

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


    Implementation
        public function get hoursGridWidth():Number
        public function set hoursGridWidth(value:Number):void
    iconCalendarInvalidproperty 
    iconCalendarInvalid:Class

    Current calendar icon. Property can be set to change calendar icon.


    Implementation
        public function get iconCalendarInvalid():Class
        public function set iconCalendarInvalid(value:Class):void
    iconResourceproperty 
    iconResource:Class

    Current resource icon. Property can be set to change resource icon.


    Implementation
        public function get iconResource():Class
        public function set iconResource(value:Class):void

    See also

    iconResourceUndefinedproperty 
    iconResourceUndefined:Class

    Current resource undefined icon. Property can be set to change resource undefined icon.


    Implementation
        public function get iconResourceUndefined():Class
        public function set iconResourceUndefined(value:Class):void

    See also

    invalidDayRangeColumnFunctionproperty 
    invalidDayRangeColumnFunction:Function

    The function used to define some invalid range in a day (used in week & day views) when column mode is enabled. If not defined, all ranges are considered as valid. The function must have the following signature: invalidDayRangeFunction(date:Date, column:int):ArrayCollection // of DateRange // date is the day date. column is the column index (starting from 0 to columnCount-1). The function returns an ArrayCollection of DateRange objects that specify the invalid ranges. The ArrayCollection could be null or empty to specify no invalid range for this day and column. Note that if ranges are the same for all columns, it is better to specify an invalidDayRangeFunction and to not define a invalidDayRangeColumnFunction. Note: at this time, the component does not include a particular management of invalid ranges, it only displays them using the invalidDayRangeBackgroundColor & invalidDayRangeBackgroundAlpha styles

    The default value is null..

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


    Implementation
        public function get invalidDayRangeColumnFunction():Function
        public function set invalidDayRangeColumnFunction(value:Function):void
    invalidDayRangeFunctionproperty 
    invalidDayRangeFunction:Function

    The function used to define some invalid range in a day (used in week & day views). If not defined, all ranges are considered as valid. The function must have the following signature: invalidDayRangeFunction(date:Date):ArrayCollection // of DateRange // date is the day date. The function returns an ArrayCollection of DateRange objects that specify the invalid ranges. The ArrayCollection could be null or empty to specify no invalid range for this day. Note: at this time, the component do not managed invalid range at all, it only display them using the invalidDayRangeBackgroundColor & invalidDayRangeBackgroundAlpha styles

    The default value is null..

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


    Implementation
        public function get invalidDayRangeFunction():Function
        public function set invalidDayRangeFunction(value:Function):void
    isLassoSelectionInProgressproperty 
    isLassoSelectionInProgress:Boolean  [read-only]


    Implementation
        public function get isLassoSelectionInProgress():Boolean
    itemCornerRadiusproperty 
    itemCornerRadius:Number

    Item corner radius. Property can be set to change the corner radius.

    The default value is 10..

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


    Implementation
        public function get itemCornerRadius():Number
        public function set itemCornerRadius(value:Number):void
    itemLeftMarginproperty 
    itemLeftMargin:Number

    Item left margin. Defines the left margin of the calendar items applied on the left side. Note that is it cumulated with itemMargin and is applyied column by column when column mode is enabled.

    The default value is 0..

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


    Implementation
        public function get itemLeftMargin():Number
        public function set itemLeftMargin(value:Number):void
    itemMarginproperty 
    itemMargin:Number

    Item margin. Defines the margin of the calendar items (globally on both right & left sides).

    The default value is 8..

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


    Implementation
        public function get itemMargin():Number
        public function set itemMargin(value:Number):void
    itemRightMarginproperty 
    itemRightMargin:Number

    Item right margin. Defines the right margin of the calendar items applied on the right side. Note that is it cumulated with itemMargin and is applyied column by column when column mode is enabled.

    The default value is 0..

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


    Implementation
        public function get itemRightMargin():Number
        public function set itemRightMargin(value:Number):void
    itemsproperty 
    items:ArrayCollection  [read-only]

    List of CalendarItem (one for each dataProvider objects)


    Implementation
        public function get items():ArrayCollection
    keepRangeSelectionVisibleproperty 
    keepRangeSelectionVisible:Boolean

    Indicates if the range selection should remain visible upon mouse up.

    The default value is false..

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


    Implementation
        public function get keepRangeSelectionVisible():Boolean
        public function set keepRangeSelectionVisible(value:Boolean):void
    labelFieldproperty 
    labelField:String

    The property name of objects where the event label is stored. It is only used if no labelFunction is defined.

    The default value is "label".


    Implementation
        public function get labelField():String
        public function set labelField(value:String):void
    labelFunctionproperty 
    labelFunction:Function

    The function used to define the event label. If defined, the labelField property is not used. The function must have the following signature: labelFunction(item:Object):String item is a data provider item. The function returns the event label that will be displayed for the event.

    The default value is null..


    Implementation
        public function get labelFunction():Function
        public function set labelFunction(value:Function):void
    lassoSelectionEnabledproperty 
    lassoSelectionEnabled:Boolean

    Indicates if lasso selection is enabled (controlled by CRTL key).

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


    Implementation
        public function get lassoSelectionEnabled():Boolean
        public function set lassoSelectionEnabled(value:Boolean):void
    monthHeaderHeightproperty 
    monthHeaderHeight:Number

    Month header height (year view). Property can be set to change the month header height.

    The default value is 20..

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


    Implementation
        public function get monthHeaderHeight():Number
        public function set monthHeaderHeight(value:Number):void
    mouseSelectionColumnToolTipFunctionproperty 
    mouseSelectionColumnToolTipFunction:Function

    The function used to define the cell column selection tooltip. If undefined, a default toolTip is used. The function must have the following signature: mouseSelectionColumnToolTipFunction(dateRange:DateRange, column:int):String dateRange is the selection date range. column is the column index (starting from 0 to columnCount-1). The function returns the event toolTip that will be displayed for the cell selection. If you want to differentiate tooltip from day/week/month views, you have to check the current displayMode state. Note that if tooltips are the same for all columns, it is better to specify an mouseSelectionToolTipFunction and to not define a mouseSelectionColumnToolTipFunction.

    The default value is null..

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


    Implementation
        public function get mouseSelectionColumnToolTipFunction():Function
        public function set mouseSelectionColumnToolTipFunction(value:Function):void
    mouseSelectionFullHourproperty 
    mouseSelectionFullHour:Boolean

    Determines the selected range highlighted upon mouse over (active only if mouseSelectionVisibleChanged is enabled). If true, the full hour is selected, else only the corresponding time step defined by the mouseSelectionStep.

    The default value is true..

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


    Implementation
        public function get mouseSelectionFullHour():Boolean
        public function set mouseSelectionFullHour(value:Boolean):void
    mouseSelectionStepproperty 
    mouseSelectionStep:int

    Determines the selected range highlighted upon mouse over (active only if mouseSelectionVisibleChanged is enabled & mouseSelectionFullHour is false). If set to -1, eventTimeStep is used.

    The default value is -1..

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


    Implementation
        public function get mouseSelectionStep():int
        public function set mouseSelectionStep(value:int):void
    mouseSelectionToolTipFunctionproperty 
    mouseSelectionToolTipFunction:Function

    The function used to define the cell selection tooltip. If undefined, a default toolTip is used. The function must have the following signature: mouseSelectionToolTipFunction(dateRange:DateRange):String dateRange is the selection date range. The function returns the event toolTip that will be displayed for the cell selection. If you want to differentiate tooltip from day/week/month views, you have to check the current displayMode state.

    The default value is null..

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


    Implementation
        public function get mouseSelectionToolTipFunction():Function
        public function set mouseSelectionToolTipFunction(value:Function):void
    mouseSelectionToolTipVisibleproperty 
    mouseSelectionToolTipVisible:Boolean

    Indicates if a tooltip is displayed upon mouse over (active even if mouseSelectionVisibleChanged is false).

    The default value is true..

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


    Implementation
        public function get mouseSelectionToolTipVisible():Boolean
        public function set mouseSelectionToolTipVisible(value:Boolean):void
    mouseSelectionVisibleproperty 
    mouseSelectionVisible:Boolean

    Determines if step over user mouse is displayed (if enabled, color used is defined by the mouseSelectionBackgroundColor style (day & week views). If mouseSelectionFullHour is false, selection range is event time step else it is the full hour.

    The default value is true..

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


    Implementation
        public function get mouseSelectionVisible():Boolean
        public function set mouseSelectionVisible(value:Boolean):void
    mouseWheelNavigationEnabledproperty 
    mouseWheelNavigationEnabled:Boolean

    Determines if mouse wheel navigation is enabled. Mouse wheel navigation allows user to change display mode according to mouse position.

    The default value is true..

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


    Implementation
        public function get mouseWheelNavigationEnabled():Boolean
        public function set mouseWheelNavigationEnabled(value:Boolean):void
    multipleDaysForYearRendererproperty 
    multipleDaysForYearRenderer:Boolean

    Specify if an event that is accross several days is taken in account for each day (true) or only for its first day (false), in year view.

    The default value is true..

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


    Implementation
        public function get multipleDaysForYearRenderer():Boolean
        public function set multipleDaysForYearRenderer(value:Boolean):void
    notDisplayedItemsIndicatorVisibleproperty 
    notDisplayedItemsIndicatorVisible:Boolean

    Specify if indicators (yellow arrows in day/week view) of not displayed items must be visible.

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


    Implementation
        public function get notDisplayedItemsIndicatorVisible():Boolean
        public function set notDisplayedItemsIndicatorVisible(value:Boolean):void
    otherColumnDragEnabledproperty 
    otherColumnDragEnabled:Boolean

    Specify if drag is enabled on other columns than the original event one. Used only if column mode is enabled. This typically allows your application to change event resource / event type upon Drag&Drop.

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


    Implementation
        public function get otherColumnDragEnabled():Boolean
        public function set otherColumnDragEnabled(value:Boolean):void
    rangeSelectionproperty 
    rangeSelection:DateRange

    Gives the selected range.

    The default value is null..

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


    Implementation
        public function get rangeSelection():DateRange
        public function set rangeSelection(value:DateRange):void
    rangeSelectionEnabledproperty 
    rangeSelectionEnabled:Boolean

    Indicates if range selection is enabled on cells.

    The default value is true..

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


    Implementation
        public function get rangeSelectionEnabled():Boolean
        public function set rangeSelectionEnabled(value:Boolean):void
    rangeSelectionInProgressproperty 
    rangeSelectionInProgress:Boolean

    Indicates if a range selection is in progress.

    The default value is false..

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


    Implementation
        public function get rangeSelectionInProgress():Boolean
        public function set rangeSelectionInProgress(value:Boolean):void
    readOnlyFieldproperty 
    readOnlyField:String

    The property name where is stored the event readOnly. It is only used if no readOnlyFunction is defined.

    The default value is "readOnly"..


    Implementation
        public function get readOnlyField():String
        public function set readOnlyField(value:String):void
    readOnlyFunctionproperty 
    readOnlyFunction:Function

    The function used to define the event readOnly. If defined, the readOnlyField property is not used. The function must have the following signature: readOnlyFunction(item:Object):Boolean item is a data provider item. The function returns if the event is in read-only mode.

    The default value is null..


    Implementation
        public function get readOnlyFunction():Function
        public function set readOnlyFunction(value:Function):void
    resizeBottomImageproperty 
    resizeBottomImage:Class

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


    Implementation
        public static function get resizeBottomImage():Class
        public static function set resizeBottomImage(value:Class):void
    resizeButtonHeightproperty 
    resizeButtonHeight:int

    Specify the event resize button heigth (vertical events).

    The default value is 10..

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


    Implementation
        public function get resizeButtonHeight():int
        public function set resizeButtonHeight(value:int):void
    resizeButtonWidthproperty 
    resizeButtonWidth:int

    Specify the event resize button width (horizontal events).

    The default value is 10..

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


    Implementation
        public function get resizeButtonWidth():int
        public function set resizeButtonWidth(value:int):void
    resizeOverDayRangeEnabledproperty 
    resizeOverDayRangeEnabled:Boolean

    Determines if user can resize an event on multiple days in day/week view.

    The default value is true..

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


    Implementation
        public function get resizeOverDayRangeEnabled():Boolean
        public function set resizeOverDayRangeEnabled(value:Boolean):void
    resizeRightImageproperty 
    resizeRightImage:Class

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


    Implementation
        public static function get resizeRightImage():Class
        public static function set resizeRightImage(value:Class):void
    resourceFieldproperty 
    resourceField:String

    The property name where is stored the event resource. If the event resource is defined (!= empty string) the iconResource will be displayed in the default event renderer and the event resource string will be displayed as tooltip. If undefined (= empty string), the iconResourceUndefined will be displayed instead. Note: it is only used if no resourceFunction is defined.

    The default value is "resource"..


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

    See also

    resourceFunctionproperty 
    resourceFunction:Function

    The function used to define the event resource. If defined, the resourceField property is not used. The function must have the following signature: resourceFunction(item:Object):String item is a data provider item. The function returns the event resource that will be displayed for the event. If the event resource is defined (!= empty string) the iconResource will be displayed in the default event renderer and the event resource string will be displayed as tooltip. If undefined (= empty string), the iconResourceUndefined will be displayed instead.

    The default value is null..


    Implementation
        public function get resourceFunction():Function
        public function set resourceFunction(value:Function):void

    See also

    selectableFieldproperty 
    selectableField:String

    The property name where is stored the event selectable. It is only used if no selectableFunction is defined. Selectable is optional. If an item is selectable (false by default), hand cursor is shown when mouse is over the item.

    The default value is "selectable"..


    Implementation
        public function get selectableField():String
        public function set selectableField(value:String):void
    selectableFunctionproperty 
    selectableFunction:Function

    The function used to define the event selectable. If defined, the selectableField property is not used. The function must have the following signature: selectableFunction(item:Object):Boolean item is a data provider item. The function returns if the event is selectable. If an item is selectable (false by default), hand cursor is shown when mouse is over the item.

    The default value is null..

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


    Implementation
        public function get selectableFunction():Function
        public function set selectableFunction(value:Function):void
    selectedItemproperty 
    selectedItem:CalendarItem

    Currently selected item. If no selection is done, selectedItem is null. Note: if eventMultiSelectEnabled is enabled, you should use the selectedItems property, selectedItem will return the last selected item

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


    Implementation
        public function get selectedItem():CalendarItem
        public function set selectedItem(value:CalendarItem):void
    selectedItemsproperty 
    selectedItems:ArrayCollection

    Currently selected items. If no selection is done, selectedItems is empty. Note: if eventMultiSelectEnabled is not enabled, you should use the selectedItem property

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


    Implementation
        public function get selectedItems():ArrayCollection
        public function set selectedItems(value:ArrayCollection):void
    showEventHoursproperty 
    showEventHours:Boolean

    Specify if event hours must be displayed in items.

    The default value is true..

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


    Implementation
        public function get showEventHours():Boolean
        public function set showEventHours(value:Boolean):void
    stackedEventGapHeightproperty 
    stackedEventGapHeight:int

    Specify the gap height in pixels between each stacked event (used if stacked events enabled).

    The default value is 8..

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


    Implementation
        public function get stackedEventGapHeight():int
        public function set stackedEventGapHeight(value:int):void
    stackedEventHeightproperty 
    stackedEventHeight:int

    Specify the stacked event height in pixels (used if stacked events enabled).

    The default value is 40..

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


    Implementation
        public function get stackedEventHeight():int
        public function set stackedEventHeight(value:int):void
    stackedEventsEnabledproperty 
    stackedEventsEnabled:Boolean

    Specify whether the events should not be positioned at the right time, if true events are stacked from the first hour of the day. If enabled all events will be in read only.

    The default value is false..

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


    Implementation
        public function get stackedEventsEnabled():Boolean
        public function set stackedEventsEnabled(value:Boolean):void
    startHourproperty 
    startHour:int

    Indicates the start hour for day & week view.

    The default value is 0..

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


    Implementation
        public function get startHour():int
        public function set startHour(value:int):void
    startHourDisplayproperty 
    startHourDisplay:int

    Indicates the first hour displayed on day & week view.

    The default value is 8..

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


    Implementation
        public function get startHourDisplay():int
        public function set startHourDisplay(value:int):void
    startTimeFieldproperty 
    startTimeField:String

    The property name where is stored the event start time. It is only used if no startTimeFunction is defined.

    The default value is "startTime"..


    Implementation
        public function get startTimeField():String
        public function set startTimeField(value:String):void
    startTimeFunctionproperty 
    startTimeFunction:Function

    The function used to define the event start time. If defined, the startTimeField property is not used. The function must have the following signature: startTimeFunction(item:Object):Date item is a data provider item. The function returns the time that will be used for the event start.

    The default value is null..


    Implementation
        public function get startTimeFunction():Function
        public function set startTimeFunction(value:Function):void
    staticEventDispatcherproperty 
    staticEventDispatcher:IEventDispatcher  [read-only]


    Implementation
        public static function get staticEventDispatcher():IEventDispatcher
    statusFieldproperty 
    statusField:String

    The property name where is stored the event status. It is only used if no statusFunction is defined.

    The default value is "status"..


    Implementation
        public function get statusField():String
        public function set statusField(value:String):void
    statusFunctionproperty 
    statusFunction:Function

    The function used to define the event status. If defined, the statusField property is not used. The function must have the following signature: statusFunction(item:Object):int item is a data provider item. The function returns the event status that will be displayed for the event.

    The default value is null..


    Implementation
        public function get statusFunction():Function
        public function set statusFunction(value:Function):void
    titleFieldproperty 
    titleField:String

    The property name of objects where the event title is stored. It is only used if no titleFunction is defined.

    The default value is "title" Note: If title and titleFunction are not defined, the label will be displayed on event title if the item has to be displayed on several days.


    Implementation
        public function get titleField():String
        public function set titleField(value:String):void
    titleFunctionproperty 
    titleFunction:Function

    The function used to define the event title. If defined, the titleField property is not used. The function must have the following signature: titleFunction(item:Object):String item is a data provider item. The function returns the event title that will be displayed for the event.

    The default value is null. Note: If title and titleFunction are not defined, the label will be displayed on event title if the item has to be displayed on several days.

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


    Implementation
        public function get titleFunction():Function
        public function set titleFunction(value:Function):void
    todayButtonVisibleproperty 
    todayButtonVisible:Boolean

    Controls the visibility of the today button in the control bar. If false, today button is hidden in control bar but can be programatically done by setting the currentDate to the current date.

    The default value is false..

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


    Implementation
        public function get todayButtonVisible():Boolean
        public function set todayButtonVisible(value:Boolean):void
    toolTipFunctionproperty 
    toolTipFunction:Function

    The function used to define the event tooltip. If undefined, a default toolTip is used. The function must have the following signature: toolTipFunction(item:Object):String item is a data provider item. The function returns the event toolTip that will be displayed for the event.

    The default value is null..

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


    Implementation
        public function get toolTipFunction():Function
        public function set toolTipFunction(value:Function):void
    transitionConfigproperty 
    transitionConfig:TransitionConfig

    Specify the transition configuration. If none is specified, default transition will be used (if transitionEnabled is true).

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


    Implementation
        public function get transitionConfig():TransitionConfig
        public function set transitionConfig(value:TransitionConfig):void
    transitionEnabledproperty 
    transitionEnabled:Boolean

    Specify if transitions are enabled (animated transitions).

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


    Implementation
        public function get transitionEnabled():Boolean
        public function set transitionEnabled(value:Boolean):void
    useGradientInItemRenderersproperty 
    useGradientInItemRenderers:Boolean

    Specify if event renderers use gradient fills. Note: only used if default item renderer is used.

    The default value is true..

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


    Implementation
        public function get useGradientInItemRenderers():Boolean
        public function set useGradientInItemRenderers(value:Boolean):void
    useRollOverInItemRenderersproperty 
    useRollOverInItemRenderers:Boolean

    Specify if event renderer alpha changes upon mouse roll over. Note: only used if default item renderer is used.

    The default value is true..

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


    Implementation
        public function get useRollOverInItemRenderers():Boolean
        public function set useRollOverInItemRenderers(value:Boolean):void
    visibleEventCountproperty 
    visibleEventCount:int  [read-only]

    Number of visible items in the current view.

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


    Implementation
        public function get visibleEventCount():int
    visibleItemsproperty 
    visibleItems:ArrayCollection  [read-only]

    List of visible CalendarItem in the current view (one for each displayed dataProvider object)


    Implementation
        public function get visibleItems():ArrayCollection
    visibleRangeproperty 
    visibleRange:DateRange  [read-only]


    Implementation
        public function get visibleRange():DateRange
    weekDayHeadersVisibleproperty 
    weekDayHeadersVisible:Boolean

    Determines if day headers are visible in week view.

    The default value is true..

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


    Implementation
        public function get weekDayHeadersVisible():Boolean
        public function set weekDayHeadersVisible(value:Boolean):void
    weekDayViewCellsItemsproperty 
    weekDayViewCellsItems:ArrayCollection  [read-only]

    Get the CalendarItem objects that are displayed in cells (not full days events) in day/week view. Returns null if week/day view is not created yet.


    Implementation
        public function get weekDayViewCellsItems():ArrayCollection
    weekDayViewHeaderItemsproperty 
    weekDayViewHeaderItems:ArrayCollection  [read-only]

    Get the CalendarItem objects that are displayed in header (full days events) in day/week view. Returns null if week/day view is not created yet.


    Implementation
        public function get weekDayViewHeaderItems():ArrayCollection
    weekNumberVisibleproperty 
    weekNumberVisible:Boolean

    Determines if week number is visible in all views.

    The default value is true..

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


    Implementation
        public function get weekNumberVisible():Boolean
        public function set weekNumberVisible(value:Boolean):void
    weekNumberVisibleForMonthViewproperty 
    weekNumberVisibleForMonthView:Boolean

    Determines if week number is visible in all views.

    The default value is true..

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


    Implementation
        public function get weekNumberVisibleForMonthView():Boolean
        public function set weekNumberVisibleForMonthView(value:Boolean):void
    weekNumberVisibleForWeekAndDayViewproperty 
    weekNumberVisibleForWeekAndDayView:Boolean

    Determines if week number is visible in all views.

    The default value is true..

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


    Implementation
        public function get weekNumberVisibleForWeekAndDayView():Boolean
        public function set weekNumberVisibleForWeekAndDayView(value:Boolean):void
    weekNumberVisibleForYearViewproperty 
    weekNumberVisibleForYearView:Boolean

    Determines if week number is visible in all views.

    The default value is true..

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


    Implementation
        public function get weekNumberVisibleForYearView():Boolean
        public function set weekNumberVisibleForYearView(value:Boolean):void
    weeksBarWidthproperty 
    weeksBarWidth:Number

    Weeks bar width (month view). Property can be set to change the weeks bar width.

    The default value is 20..

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


    Implementation
        public function get weeksBarWidth():Number
        public function set weeksBarWidth(value:Number):void
    yearToolTipFunctionproperty 
    yearToolTipFunction:Function

    The function used to define the year events tooltip. If undefined, a default toolTip is used. The function must have the following signature: yearToolTipFunction(items:ArrayCollection):String items is a ArrayCollection of CalendarItem objects. The function returns the event toolTip that will be displayed for the event.

    The default value is null..

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


    Implementation
        public function get yearToolTipFunction():Function
        public function set yearToolTipFunction(value:Function):void
    yearViewVisibleproperty 
    yearViewVisible:Boolean

    Controls the visibility of the year view. If false, year view button is hidden in control bar but year view is accessible programatically by setting the displayMode property.

    The default value is false..

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


    Implementation
        public function get yearViewVisible():Boolean
        public function set yearViewVisible(value:Boolean):void
    Constructor Detail
    KCCalendar()Constructor
    public function KCCalendar()

    Class constructor The constructor manages the component creation and initialization. In order to specify your own labels for control bar buttons, tooltips and calendar Today button, you have to define a Calendar.properties file (ResourceBundle). This file must contains:

  • "Previous"
  • "Next"
  • "Day"
  • "Week"
  • "Month"
  • "Year"
  • "Now"
  • "Today" (for the mini-calendar)
  • You can also provide:

  • your own hour format by setting the "hourFormat". The format is the same as DateFormatter.formatString, i.e "K:NN A" will format hour like this: "8:32 PM".
  • your own date format (toolTips) by setting the "dateFormat". As hour format, format is the same as DateFormatter.formatString, i.e: "DD/MM/YYYY" will format date like this: "22/01/2010"
  • Note: fr_FR & en_US locales are already embedded in the component. To manage day & month names for locale other than fr_FR, you could use the BabelFlex framework translations (http://ttfx.org/Tontons_Flexeurs/BabelFlex.html) Another way is to dynamically change the resource bundle "SharedResources" and "formatters": var bundle:ResourceBundle = resourceManager.getResourceBundle(resourceManager.localeChain[0], "SharedResources") as ResourceBundle; bundle.content["dayNames"] = "Dimanche,Lundi,Mardi,Mercredi,Jeudi,Vendredi,Samedi";

    Note concerning Drag&Drop support with AIR: due to different drag&drop management between Flex and AIR (see WindowedApplication - useNativeDragManager AIR drag&drop support is only enabled if the property useNativeDragManager is set to false in the main WindowedApplication (FLEX 4 only).

    Method Detail
    cellClickHandler()method
    protected function cellClickHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    cellDoubleClickHandler()method 
    protected function cellDoubleClickHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    changeDateHandler()method 
    public function changeDateHandler(event:DateChangedEvent):void

    Internal usage.

    Parameters

    event:DateChangedEvent

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

    Overriden commitProperties method.

    copyToClipboard()method 
    public function copyToClipboard():void

    dateClickHandler()method 
    protected function dateClickHandler(event:DateClickEvent):void

    Parameters

    event:DateClickEvent

    emptySelection()method 
    public function emptySelection():void

    Empty the current selection.

    forceResourceChanged()method 
    public function forceResourceChanged():void

    Force a full update as if resource have been changed (could be useful when you use runtime localization)

    generateCode()method 
    public function generateCode():String

    This function is used by the test application and allows developper to easily generate MXML code of the KCCalendar component. The generated code reflects the actual component skinning & properties state. So developpers can use the test application to configure and skin the calendar component, generate the corresponding code to directly use in their application.

    Returns
    String — MXML code
    getCalendarEventAdditionalImage()method 
    public function getCalendarEventAdditionalImage(item:Object):*

    Get the event additional image.

    Parameters

    item:Object — event object.

    Returns
    * — image source or null if undefined.
    getCalendarEventColor()method 
    public function getCalendarEventColor(item:Object):Number

    Get the color of an event.

    Parameters

    item:Object — event object.

    Returns
    Number — event color.
    getCalendarEventColumn()method 
    public function getCalendarEventColumn(item:Object, checkRange:Boolean = true):int

    Get the event column.

    Parameters

    item:Object — event object.
     
    checkRange:Boolean (default = true) — if true the function will check that the return value is between 0 & columnCount - 1.

    Returns
    int — event column.
    getCalendarEventEndTime()method 
    public function getCalendarEventEndTime(item:Object):Date

    Get the EndTime of an event

    Parameters

    item:Object — event object.

    Returns
    Date — Date corresponding to the date of the event.
    getCalendarEventLabel()method 
    public function getCalendarEventLabel(item:Object):String

    Get the label of an event

    Parameters

    item:Object — event object.

    Returns
    String — String corresponding to the label of the event.
    getCalendarEventReadOnly()method 
    public function getCalendarEventReadOnly(item:Object, readOnlyForStackedEventsEnabled:Boolean = true):Boolean

    Get the read-only state of an event.

    Parameters

    item:Object — event object.
     
    readOnlyForStackedEventsEnabled:Boolean (default = true)

    Returns
    Boolean — if event is read-only.
    getCalendarEventResource()method 
    public function getCalendarEventResource(item:Object):String

    Get the ressource of an event

    Parameters

    item:Object — event object.

    Returns
    String — String corresponding to the ressource of the event.
    getCalendarEventSelectable()method 
    public function getCalendarEventSelectable(item:Object):Boolean

    Get the event selectable state.

    Parameters

    item:Object — event object.

    Returns
    Boolean — if event is selectable (hand cursor upon mouse over).
    getCalendarEventStartTime()method 
    public function getCalendarEventStartTime(item:Object):Date

    Get the StartTime of an event

    Parameters

    item:Object — event object.

    Returns
    Date — Date corresponding to the label of the event.
    getCalendarEventStatus()method 
    public function getCalendarEventStatus(item:Object):int

    Get the status of an event.

    Parameters

    item:Object — event object.

    Returns
    int — event status.
    getCalendarEventTitle()method 
    public function getCalendarEventTitle(item:Object):String

    Get the title of an event

    Parameters

    item:Object — event object.

    Returns
    String — String corresponding to the title of the event.
    getCurrentRangeToString()method 
    public function getCurrentRangeToString():String

    Return the current date range according to current display mode and current locale. This method is used to display the visible range in the control bar. Formats are:

    Returns
    String — the date range
    getCurrentView()method 
    public function getCurrentView():GenericView

    Returns
    GenericView
    getDayIndexAccordingToHiddenDays()method 
    public function getDayIndexAccordingToHiddenDays(dateIndex:int):int

    Returns the date index according to hidden days (from 0 to 6). As example if Monday (0) & Wednesday (2) are hidden, a call to the function with Friday (4) will return 2.

    Parameters

    dateIndex:int — date index (0 for Monday, 6 for Sunday)

    Returns
    int — day index from 0 to 6
    getDurationAccordingToHiddenDays()method 
    public function getDurationAccordingToHiddenDays(dateIndex:int, duration:Number):Number

    Returns the duration according to hidden days. As example if Monday (0) & Wednesday (2) are hidden, a call to the function with Friday (4) will return 2.

    Parameters

    dateIndex:int — date index (0 for Monday, 6 for Sunday)
     
    duration:Number — duration in days

    Returns
    Number — duration
    getMonthView()method 
    public function getMonthView():MonthView

    Returns
    MonthView
    getOffsetHiddenDays()method 
    public function getOffsetHiddenDays():Array

    Returns the hiddenDays array with index updated according to the dayOffset setting. As example, if Monday (0) is hidden with default dayOffset(1), it will return [0] (same as hiddenDays) but if dayOffset is 0, it will return [1] as Monday is now the second day of the week.

    Returns
    Array
    getOriginalDayIndexAccordingToHiddenDays()method 
    public function getOriginalDayIndexAccordingToHiddenDays(dateIndex:int):int

    Reverse getDayIndexAccordingToHiddenDays function. It returns the original date index according to hidden days (from 0 to 6). As example if Monday (0) & Wednesday (2) are hidden, a call to the function with Friday (2 when hidden days are taken in account) will return 4.

    Parameters

    dateIndex:int — date index (0 for Monday, 6 for Sunday)

    Returns
    int — day index from 0 to 6
    getOriginalDayIndexForMonthViewAccordingToHiddenDays()method 
    public function getOriginalDayIndexForMonthViewAccordingToHiddenDays(dateIndex:int):int

    Returns the original date index according to hidden days (from 0 to 6) for the month view. As example if Monday (0) & Wednesday (2) are hidden, a call to the second month Friday (6 when hidden days are taken in account and we assume that month starts a Monday) will return 11.

    Parameters

    dateIndex:int — date index (0 to 30)

    Returns
    int — day index from 0 to 30
    getPendingCalendarItems()method 
    public function getPendingCalendarItems():ArrayCollection

    Retrieves the CalendarItems that contains some pending modifications (start or end dates).

    Returns
    ArrayCollection — ArrayCollection of CalendarItem. Result is empty if no CalendarItem contains any modifications.
    getWeekDayView()method 
    public function getWeekDayView():WeekDayView

    Returns
    WeekDayView
    getYearView()method 
    public function getYearView():YearView

    Returns
    YearView
    isDayView()method 
    public function isDayView():Boolean

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

    Returns
    Boolean
    isPV()method 
    public final function isPV():Boolean

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

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

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

    Returns
    Boolean
    itemChangedHandler()method 
    protected function itemChangedHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    itemClickHandler()method 
    protected function itemClickHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    itemDoubleClickHandler()method 
    protected function itemDoubleClickHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    itemRollOutHandler()method 
    protected function itemRollOutHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    itemRollOverHandler()method 
    protected function itemRollOverHandler(event:CalendarEvent):void

    Parameters

    event:CalendarEvent

    itemToCalendarItem()method 
    public function itemToCalendarItem(item:Object):CalendarItem

    Retrieves the CalendarItem managing the given data provider item.

    Parameters

    item:Object — data provider item to find.

    Returns
    CalendarItem — CalendarItem that manages the data provider item. Return null if no CalendarItem is found.
    loadDataFromSharedObject()method 
    public function loadDataFromSharedObject(name:String, itemObjectClass:Class):void

    Loads data provider objects from a shared object. Important note: the itemObjectClass should implement a clone() method used to duplicate objects and not to add them as references.

    Parameters

    name:String — SharedObject name
     
    itemObjectClass:Class — Data provider objects class

    loadFromFile()method 
    public function loadFromFile():void

    Load data provider objects from a binary file. Important notes:

    maximizeHeightForPrint()method 
    public function maximizeHeightForPrint():void

    Set calendar to its maximum size in order for all cells to be displayed

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

    Overriden measure method.

    next()method 
    public function next():void

    Change current date, set it to next:

    Note: if in day view, previous date is hidden by hiddenDays properties, the first next day not hidden will de displayed

    previous()method 
    public function previous():void

    Change current date, set it to previous:

    Note: if in day view, previous date is hidden by hiddenDays properties, the first previous day not hidden will de displayed

    printCurrentView()method 
    public function printCurrentView(doNotPrint:Boolean = false):Image

    Prints an image capture of the calendar's current view

    Parameters

    doNotPrint:Boolean (default = false) — indicates if the image has to be printed.

    Returns
    Image — current view image
    resourcesChanged()method 
    override protected function resourcesChanged():void

    Overriden resourcesChanged method. Update calendar component language on the fly.

    saveDataToSharedObject()method 
    public function saveDataToSharedObject(name:String, itemObjectClass:Class):void

    Save data provider objects in a shared object. Important note: the itemObjectClass should implement a clone() method used to duplicate objects and not to add them as references.

    Parameters

    name:String — SharedObject name
     
    itemObjectClass:Class — Data provider objects class

    saveToFile()method 
    public function saveToFile(fileName:String = KCCalendarData.bin, respectPrivacy:Boolean = true):void

    Save data provider objects in a binary file. Important notes:

    Parameters

    fileName:String (default = KCCalendarData.bin) — default filename
     
    respectPrivacy:Boolean (default = true)

    scrollToFirstVisibleItem()method 
    public function scrollToFirstVisibleItem():void

    In day or week, scroll to allow user to see the first item visible (first means the one with the smaller start hour).

    setDayView()method 
    public function setDayView():void

    Set display mode to day view.

    setEndHourInternal()method 
    public function setEndHourInternal(value:int):void

    Internal function used in stacked event mode.

    Parameters

    value:int

    setMonthView()method 
    public function setMonthView():void

    Set display mode to month view.

    setStyle()method 
    override public function setStyle(styleProp:String, newValue:*):void

    Overriden setStyle method.

    Parameters

    styleProp:String
     
    newValue:*

    setWeekView()method 
    public function setWeekView():void

    Set display mode to week view.

    setYearView()method 
    public function setYearView():void

    Set display mode to year view.

    startLassoSelection()method 
    public function startLassoSelection():void

    traceItems()method 
    public function traceItems(items:ArrayCollection, prefix:String):void

    Parameters

    items:ArrayCollection
     
    prefix:String

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

    Overriden updateDisplayList method.

    Parameters

    unscaledWidth:Number
     
    unscaledHeight:Number

    viewUpdateComplete()method 
    public function viewUpdateComplete(view:GenericView):void

    Internal usage.

    Parameters

    view:GenericView

    Event Detail
    cellClick Event
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user clicks on a calendar cell where there is no event.

    cellDoubleClick Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user double-clicks on a calendar cell where there is no event.

    currentDateChange Event  
    Event Object Type: com.keepcore.calendar.event.DateChangedEvent
    DateChangedEvent.type property = com.keepcore.calendar.event.DateChangedEvent

    Dispatched when the current date is changed.

    dateClick Event  
    Event Object Type: com.keepcore.calendar.event.DateClickEvent
    DateClickEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user clicks on a week number / a day / a month leading to a view change (and only if calendarLinksEnabled is false). Note: this event is subject to change in future version. Use it carefully.

    displayModeChange Event  
    Event Object Type: flash.events.Event
    Event.type property = flash.events.Event

    Dispatched when the display mode is changed.

    displayModeChanging Event  
    Event Object Type: flash.events.Event
    Event.type property = flash.events.Event

    Dispatched before the display mode is changed and before views are updated (note that displayMode is already up-to-date when event is trigger). For exemple, it could be used to change data provider before display update.

    itemChange Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when an event has been changed.

    itemClick Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when an event has been clicked.

    itemDoubleClick Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when an event has been double-clicked.

    itemRollOut Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user rolls the mouse out of an event.

    itemRollOver Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user rolls the mouse over an event.

    itemSelected Event  
    Event Object Type: com.keepcore.calendar.event.CalendarEvent
    CalendarEvent.type property = com.keepcore.calendar.event.CalendarEvent

    Dispatched when the user selects an event.

    visibleRangeChange Event  
    Event Object Type: flash.events.Event
    Event.type property = flash.events.Event

    Dispatched when the visible range changes. For exemple, it could be used to change data provider before display update.

    Constant Detail
    CALENDAR_CONTROL_BAR_BACKGROUND_COLORConstant
    public static const CALENDAR_CONTROL_BAR_BACKGROUND_COLOR:String = calendarControlBarBackgroundColor

    COLUMN_HEADER_FONT_STYLEConstant 
    public static const COLUMN_HEADER_FONT_STYLE:String = columnHeaderFontStyleName

    CURRENT_HOUR_BAR_COLOR_STYLEConstant 
    public static const CURRENT_HOUR_BAR_COLOR_STYLE:String = currentHourBarColor

    DAY_CELL_BACKGROUND_ALPHA_STYLEConstant 
    public static const DAY_CELL_BACKGROUND_ALPHA_STYLE:String = dayCellBackgroundAlpha

    DAY_CELL_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_CELL_BACKGROUND_COLOR_STYLE:String = dayCellBackgroundColor

    DAY_CELL_BORDER_COLOR_STYLEConstant 
    public static const DAY_CELL_BORDER_COLOR_STYLE:String = dayCellBorderColor

    DAY_CELL_INACTIVE_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_CELL_INACTIVE_BACKGROUND_COLOR_STYLE:String = dayCellInactiveBackgroundColor

    DAY_CELL_TODAY_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_CELL_TODAY_BACKGROUND_COLOR_STYLE:String = dayCellTodayBackgroundColor

    DAY_COLOR_ALPHAConstant 
    public static const DAY_COLOR_ALPHA:String = dayColorAlpha

    DAY_HEADER_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_HEADER_BACKGROUND_COLOR_STYLE:String = dayHeaderBackgroundColor

    DAY_HEADER_BORDER_COLOR_STYLEConstant 
    public static const DAY_HEADER_BORDER_COLOR_STYLE:String = dayHeaderBorderColor

    DAY_HEADER_FONT_STYLEConstant 
    public static const DAY_HEADER_FONT_STYLE:String = dayHeaderFontStyleName

    DAY_HEADER_INACTIVE_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_HEADER_INACTIVE_BACKGROUND_COLOR_STYLE:String = dayHeaderInactiveBackgroundColor

    DAY_HEADER_TODAY_BACKGROUND_COLOR_STYLEConstant 
    public static const DAY_HEADER_TODAY_BACKGROUND_COLOR_STYLE:String = dayHeaderTodayBackgroundColor

    DAY_VIEWConstant 
    public static const DAY_VIEW:Number = 2

    DAYS_BAR_BACKGROUND_COLOR_STYLEConstant 
    public static const DAYS_BAR_BACKGROUND_COLOR_STYLE:String = daysBarBackgroundColor

    DAYS_BAR_BORDER_COLOR_STYLEConstant 
    public static const DAYS_BAR_BORDER_COLOR_STYLE:String = daysBarBorderColor

    DAYS_BAR_FONT_STYLEConstant 
    public static const DAYS_BAR_FONT_STYLE:String = daysBarFontStyleName

    DAYS_DOUBLE_BAR_SEPARATOR_SHOWING_STYLEConstant 
    public static const DAYS_DOUBLE_BAR_SEPARATOR_SHOWING_STYLE:String = daysDoubleBarSeparatorShowing

    DEFAULT_ITEM_BACKGROUND_COLORConstant 
    public static const DEFAULT_ITEM_BACKGROUND_COLOR:String = defaultItemBackgroundColor

    DISPLAY_MODE_CHANGEConstant 
    public static const DISPLAY_MODE_CHANGE:String = displayModeChange

    DISPLAY_MODE_CHANGINGConstant 
    public static const DISPLAY_MODE_CHANGING:String = displayModeChanging

    FULL_VERSIONConstant 
    public static const FULL_VERSION:String

    HIGHLIGHT_DAY_RANGE_BACKGROUND_ALPHAConstant 
    public static const HIGHLIGHT_DAY_RANGE_BACKGROUND_ALPHA:String = highlightDayRangeBackgroundAlpha

    HIGHLIGHT_DAY_RANGE_BACKGROUND_COLORConstant 
    public static const HIGHLIGHT_DAY_RANGE_BACKGROUND_COLOR:String = highlightDayRangeBackgroundColor

    HOUR_HALF_BAR_BORDER_ALPHA_STYLEConstant 
    public static const HOUR_HALF_BAR_BORDER_ALPHA_STYLE:String = hourHalfBarBorderAlpha

    HOUR_HALF_BAR_BORDER_COLOR_STYLEConstant 
    public static const HOUR_HALF_BAR_BORDER_COLOR_STYLE:String = hourHalfBarBorderColor

    HOURS_BAR_BACKGROUND_COLOR_STYLEConstant 
    public static const HOURS_BAR_BACKGROUND_COLOR_STYLE:String = hoursBarBackgroundColor

    HOURS_BAR_BORDER_COLOR_STYLEConstant 
    public static const HOURS_BAR_BORDER_COLOR_STYLE:String = hoursBarBorderColor

    HOURS_BAR_FONT_STYLEConstant 
    public static const HOURS_BAR_FONT_STYLE:String = hoursBarFontStyleName

    INVALID_DAY_RANGE_BACKGROUND_ALPHAConstant 
    public static const INVALID_DAY_RANGE_BACKGROUND_ALPHA:String = invalidDayRangeBackgroundAlpha

    INVALID_DAY_RANGE_BACKGROUND_COLORConstant 
    public static const INVALID_DAY_RANGE_BACKGROUND_COLOR:String = invalidDayRangeBackgroundColor

    ITEM_HOURS_FONT_STYLEConstant 
    public static const ITEM_HOURS_FONT_STYLE:String = itemHoursFontStyleName

    ITEM_LABEL_FONT_STYLEConstant 
    public static const ITEM_LABEL_FONT_STYLE:String = itemLabelFontStyleName

    ITEM_TITLE_FONT_STYLEConstant 
    public static const ITEM_TITLE_FONT_STYLE:String = itemTitleFontStyleName

    KC_DEMO_TEXTConstant 
    public static const KC_DEMO_TEXT:String = KCCalendarwww.flex-component.com

    KC_WEBSITEConstant 
    public static const KC_WEBSITE:String = http://www.flex-component.com/

    MAX_CALENDAR_COUNTConstant 
    public static const MAX_CALENDAR_COUNT:Number = 3

    MONTH_HEADER_BACKGROUND_COLOR_STYLEConstant 
    public static const MONTH_HEADER_BACKGROUND_COLOR_STYLE:String = monthHeaderBackgroundColor

    MONTH_HEADER_BORDER_COLOR_STYLEConstant 
    public static const MONTH_HEADER_BORDER_COLOR_STYLE:String = monthHeaderBorderColor

    MONTH_HEADER_TODAY_BACKGROUND_COLOR_STYLEConstant 
    public static const MONTH_HEADER_TODAY_BACKGROUND_COLOR_STYLE:String = monthHeaderTodayBackgroundColor

    MONTH_VIEWConstant 
    public static const MONTH_VIEW:Number = 0

    MOUSE_SELECTION_BACKGROUND_COLORConstant 
    public static const MOUSE_SELECTION_BACKGROUND_COLOR:String = mouseSelectionBackgroundColor

    NOT_DISPLAYED_ITEMS_INDICATOR_FONT_STYLEConstant 
    public static const NOT_DISPLAYED_ITEMS_INDICATOR_FONT_STYLE:String = notDisplayedItemsIndicatorFontStyleName

    OVERLAP_MODEConstant 
    public static const OVERLAP_MODE:Number = 1

    SIDE_MODEConstant 
    public static const SIDE_MODE:Number = 0

    STATUS_UP_TO_DATEConstant 
    public static const STATUS_UP_TO_DATE:int = 0

    STATUS_UP_TO_DATE_STRINGConstant 
    public static const STATUS_UP_TO_DATE_STRING:String

    STATUS_UPDATINGConstant 
    public static const STATUS_UPDATING:int = 1

    STATUS_UPDATING_STRINGConstant 
    public static const STATUS_UPDATING_STRING:String

    VERSIONConstant 
    public static const VERSION:String = 1.6.0

    VISIBLE_RANGE_CHANGEConstant 
    public static const VISIBLE_RANGE_CHANGE:String = visibleRangeChange

    WEEK_FONT_STYLEConstant 
    public static const WEEK_FONT_STYLE:String = weekFontStyleName

    WEEK_VIEWConstant 
    public static const WEEK_VIEW:Number = 1

    WEEKS_BAR_BACKGROUND_COLOR_STYLEConstant 
    public static const WEEKS_BAR_BACKGROUND_COLOR_STYLE:String = weeksBarBackgroundColor

    WEEKS_BAR_BORDER_COLOR_STYLEConstant 
    public static const WEEKS_BAR_BORDER_COLOR_STYLE:String = weeksBarBorderColor

    YEAR_DAY_BORDER_COLOR_STYLEConstant 
    public static const YEAR_DAY_BORDER_COLOR_STYLE:String = yearDayBorderColor

    YEAR_DAY_FONT_STYLEConstant 
    public static const YEAR_DAY_FONT_STYLE:String = yearDayFontStyleName

    YEAR_DAY_WEEK_END_BORDER_COLOR_STYLEConstant 
    public static const YEAR_DAY_WEEK_END_BORDER_COLOR_STYLE:String = yearDayWeekEndBorderColor

    YEAR_MONTH_HEADER_FONT_STYLEConstant 
    public static const YEAR_MONTH_HEADER_FONT_STYLE:String = yearMonthHeaderFontStyleName

    YEAR_RENDERER_FONT_STYLEConstant 
    public static const YEAR_RENDERER_FONT_STYLE:String = yearRendererFontStyleName

    YEAR_VIEWConstant 
    public static const YEAR_VIEW:Number = 3

    YEAR_WEEK_FONT_STYLEConstant 
    public static const YEAR_WEEK_FONT_STYLE:String = yearWeekFontStyleName