| Package | com.keepcore.calendar |
| Class | public class KCCalendar |
| Inheritance | KCCalendar 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.
| Property | Defined 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 | ||
| Method | Defined 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 | ||
changeDateHandler(event:DateChangedEvent):void
Internal usage. | KCCalendar | ||
copyToClipboard():void | KCCalendar | ||
emptySelection():void
Empty the current selection. | KCCalendar | ||
forceResourceChanged():void
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 | ||
getCalendarEventAdditionalImage(item:Object):*
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 | ||
getCurrentRangeToString():String
Return the current date range according to current display mode and current locale. | KCCalendar | ||
| KCCalendar | |||
getDayIndexAccordingToHiddenDays(dateIndex:int):int
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 | |||
getOffsetHiddenDays():Array
Returns the hiddenDays array with index updated according to the dayOffset setting. | KCCalendar | ||
getOriginalDayIndexAccordingToHiddenDays(dateIndex:int):int
Reverse getDayIndexAccordingToHiddenDays function. | KCCalendar | ||
getOriginalDayIndexForMonthViewAccordingToHiddenDays(dateIndex:int):int
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 | ||
itemToCalendarItem(item:Object):CalendarItem
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 | ||
loadFromFile():void
Load data provider objects from a binary file. | KCCalendar | ||
maximizeHeightForPrint():void
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 | ||
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). | KCCalendar | ||
setDayView():void
Set display mode to day view. | KCCalendar | ||
setEndHourInternal(value:int):void
Internal function used in stacked event mode. | KCCalendar | ||
setMonthView():void
Set display mode to month view. | KCCalendar | ||
setStyle(styleProp:String, newValue:*):void [override]
Overriden setStyle method. | KCCalendar | ||
setWeekView():void
Set display mode to week view. | KCCalendar | ||
setYearView():void
Set display mode to year view. | KCCalendar | ||
startLassoSelection():void | KCCalendar | ||
traceItems(items:ArrayCollection, prefix:String):void | KCCalendar | ||
viewUpdateComplete(view:GenericView):void
Internal usage. | KCCalendar | ||
| Method | Defined By | ||
|---|---|---|---|
cellClickHandler(event:CalendarEvent):void | KCCalendar | ||
cellDoubleClickHandler(event:CalendarEvent):void | KCCalendar | ||
commitProperties():void [override]
Overriden commitProperties method. | KCCalendar | ||
dateClickHandler(event:DateClickEvent):void | KCCalendar | ||
itemChangedHandler(event:CalendarEvent):void | KCCalendar | ||
itemClickHandler(event:CalendarEvent):void | KCCalendar | ||
itemDoubleClickHandler(event:CalendarEvent):void | KCCalendar | ||
itemRollOutHandler(event:CalendarEvent):void | KCCalendar | ||
itemRollOverHandler(event:CalendarEvent):void | KCCalendar | ||
measure():void [override]
Overriden measure method. | KCCalendar | ||
resourcesChanged():void [override]
Overriden resourcesChanged method. | KCCalendar | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Overriden updateDisplayList method. | KCCalendar | ||
| 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 | |||
| Constant | Defined 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 | ||
| additionalImageField | property |
additionalImageField:StringThe property name where is stored the additional image source. Additional image is optional.
The default value is "additionalImage"..
public function get additionalImageField():String public function set additionalImageField(value:String):void| additionalImageFunction | property |
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.
public function get additionalImageFunction():Function public function set additionalImageFunction(value:Function):void| alwaysApplyStartHourDisplay | property |
alwaysApplyStartHourDisplay:BooleanIndicates 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.
public function get alwaysApplyStartHourDisplay():Boolean public function set alwaysApplyStartHourDisplay(value:Boolean):void| calendarControlBar | property |
calendarControlBar:CalendarControlBar [read-only] Calendar control bar.
public function get calendarControlBar():CalendarControlBar| calendarDayBarRenderer | property |
calendarDayBarRenderer:IFactorySpecify 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.
public function get calendarDayBarRenderer():IFactory public function set calendarDayBarRenderer(value:IFactory):void| calendarDayCellRenderer | property |
calendarDayCellRenderer:IFactorySpecify 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.
public function get calendarDayCellRenderer():IFactory public function set calendarDayCellRenderer(value:IFactory):void| calendarDayHeaderRenderer | property |
calendarDayHeaderRenderer:IFactorySpecify 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.
public function get calendarDayHeaderRenderer():IFactory public function set calendarDayHeaderRenderer(value:IFactory):void| calendarHoursGridRenderer | property |
calendarHoursGridRenderer:IFactorySpecify 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.
public function get calendarHoursGridRenderer():IFactory public function set calendarHoursGridRenderer(value:IFactory):void| calendarInvalidImage | property |
calendarInvalidImage:ClassThis property can be used as the source for data binding.
public static function get calendarInvalidImage():Class public static function set calendarInvalidImage(value:Class):void| calendarItemRenderer | property |
calendarItemRenderer:IFactorySpecify 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.
public function get calendarItemRenderer():IFactory public function set calendarItemRenderer(value:IFactory):void| calendarLinksEnabled | property |
calendarLinksEnabled:BooleanDetermines 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.
public function get calendarLinksEnabled():Boolean public function set calendarLinksEnabled(value:Boolean):void| calendarMonthCellRenderer | property |
calendarMonthCellRenderer:IFactorySpecify 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.
public function get calendarMonthCellRenderer():IFactory public function set calendarMonthCellRenderer(value:IFactory):void| calendarMonthHeaderRenderer | property |
calendarMonthHeaderRenderer:IFactorySpecify 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.
public function get calendarMonthHeaderRenderer():IFactory public function set calendarMonthHeaderRenderer(value:IFactory):void| calendarWeekLabelRenderer | property |
calendarWeekLabelRenderer:IFactorySpecify 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.
public function get calendarWeekLabelRenderer():IFactory public function set calendarWeekLabelRenderer(value:IFactory):void| calendarYearRenderer | property |
calendarYearRenderer:IFactorySpecify 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.
public function get calendarYearRenderer():IFactory public function set calendarYearRenderer(value:IFactory):void| classicResourceImage | property |
classicResourceImage:ClassThis property can be used as the source for data binding.
public static function get classicResourceImage():Class public static function set classicResourceImage(value:Class):void| classicResourceUndefinedImage | property |
classicResourceUndefinedImage:ClassThis property can be used as the source for data binding.
public static function get classicResourceUndefinedImage():Class public static function set classicResourceUndefinedImage(value:Class):void| colorField | property |
colorField:StringThe property name where is stored the event color. It is only used if no colorFunction is defined.
The default value is "color"..
public function get colorField():String public function set colorField(value:String):void| colorFunction | property |
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..
public function get colorFunction():Function public function set colorFunction(value:Function):void| columnConcurrentEventDisplayMode | property |
columnConcurrentEventDisplayMode:NumberItem concurrency display mode in column mode. Property can be set to change mode. Allowed values are:
The default value is SIDE_MODE..
This property can be used as the source for data binding.
public function get columnConcurrentEventDisplayMode():Number public function set columnConcurrentEventDisplayMode(value:Number):void| columnCount | property |
columnCount:intSpecify 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.
public function get columnCount():int public function set columnCount(value:int):void| columnField | property |
columnField:StringThe 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..
public function get columnField():String public function set columnField(value:String):void| columnFunction | property |
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..
public function get columnFunction():Function public function set columnFunction(value:Function):void| columnHeaderFunction | property |
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..
public function get columnHeaderFunction():Function public function set columnHeaderFunction(value:Function):void| columnHeaderHeight | property |
columnHeaderHeight:NumberColumn 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.
public function get columnHeaderHeight():Number public function set columnHeaderHeight(value:Number):void| columnHeaderRenderer | property |
columnHeaderRenderer:IFactorySpecify 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.
public function get columnHeaderRenderer():IFactory public function set columnHeaderRenderer(value:IFactory):void| columnModeEnabled | property |
columnModeEnabled:BooleanSpecify 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.
public function get columnModeEnabled():Boolean public function set columnModeEnabled(value:Boolean):void| concurrentEventDisplayMode | property |
concurrentEventDisplayMode:NumberItem concurrency display mode. Property can be set to change mode. Allowed values are:
The default value is SIDE_MODE..
This property can be used as the source for data binding.
public function get concurrentEventDisplayMode():Number public function set concurrentEventDisplayMode(value:Number):void| controlBarVisible | property |
controlBarVisible:BooleanControls 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.
public function get controlBarVisible():Boolean public function set controlBarVisible(value:Boolean):void| currentDate | property |
currentDate:DateCurrent 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.
public function get currentDate():Date public function set currentDate(value:Date):void| dataProvider | property |
dataProvider:ArrayCollectionSet of data to be viewed. You can use CalendarObjectSample as a base class for objects.
The default value is null.
public function get dataProvider():ArrayCollection public function set dataProvider(value:ArrayCollection):void| dayBarHeight | property |
dayBarHeight:NumberDay 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.
public function get dayBarHeight():Number public function set dayBarHeight(value:Number):void| dayCellBorderVisible | property |
dayCellBorderVisible:BooleanDetermines if day cell border is displayed.
The default value is true..
This property can be used as the source for data binding.
public function get dayCellBorderVisible():Boolean public function set dayCellBorderVisible(value:Boolean):void| dayColorFunction | property |
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.
public function get dayColorFunction():Function public function set dayColorFunction(value:Function):void| dayDoubleSeparatorVisible | property |
dayDoubleSeparatorVisible:BooleanDetermines 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.
public function get dayDoubleSeparatorVisible():Boolean public function set dayDoubleSeparatorVisible(value:Boolean):void| dayHeaderAllDayEventsHeightGap | property |
dayHeaderAllDayEventsHeightGap:NumberHorizontal 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.
public function get dayHeaderAllDayEventsHeightGap():Number public function set dayHeaderAllDayEventsHeightGap(value:Number):void| dayHeaderHeight | property |
dayHeaderHeight:NumberDay 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.
public function get dayHeaderHeight():Number public function set dayHeaderHeight(value:Number):void| dayHeaderVisible | property |
dayHeaderVisible:BooleanSpecify 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.
public function get dayHeaderVisible():Boolean public function set dayHeaderVisible(value:Boolean):void| dayOffset | property |
dayOffset:intSpecify the week starting day.
The default value is 1 (Monday)..
This property can be used as the source for data binding.
public function get dayOffset():int public function set dayOffset(value:int):void| diffTimeZone | property |
diffTimeZone:intSpecify 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.
public function get diffTimeZone():int public function set diffTimeZone(value:int):void| displayAllItemsNumberInMonthView | property |
displayAllItemsNumberInMonthView:BooleanSpecify if number of all items is displayed in month view
This property can be used as the source for data binding.
public function get displayAllItemsNumberInMonthView():Boolean public function set displayAllItemsNumberInMonthView(value:Boolean):void| displayCurrentHourBar | property |
displayCurrentHourBar:BooleanSpecify 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.
public function get displayCurrentHourBar():Boolean public function set displayCurrentHourBar(value:Boolean):void| displayFullDayEvents | property |
displayFullDayEvents:BooleanSpecify 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.
public function get displayFullDayEvents():Boolean public function set displayFullDayEvents(value:Boolean):void| displayItemsInFullSizeInMonthView | property |
displayItemsInFullSizeInMonthView:BooleanSpecify 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.
public function get displayItemsInFullSizeInMonthView():Boolean public function set displayItemsInFullSizeInMonthView(value:Boolean):void| displayMode | property |
displayMode:NumberCurrent 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..
public function get displayMode():Number public function set displayMode(value:Number):void| displayMonthNamesInAllDays | property |
displayMonthNamesInAllDays:BooleanSpecify 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.
public function get displayMonthNamesInAllDays():Boolean public function set displayMonthNamesInAllDays(value:Boolean):void| dragAndDropOriginalItemVisible | property |
dragAndDropOriginalItemVisible:BooleanIndicates if the original item is visible during a drag & drop operation.
This property can be used as the source for data binding.
public function get dragAndDropOriginalItemVisible():Boolean public function set dragAndDropOriginalItemVisible(value:Boolean):void| dragOverDayRangeEnabled | property |
dragOverDayRangeEnabled:BooleanDetermines 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.
public function get dragOverDayRangeEnabled():Boolean public function set dragOverDayRangeEnabled(value:Boolean):void| endHour | property |
endHour:intIndicates the end hour for day & week view.
The default value is 24..
This property can be used as the source for data binding.
public function get endHour():int public function set endHour(value:int):void| endTimeField | property |
endTimeField:StringThe property name where is stored the event end time. It is only used if no endTimeFunction is defined.
The default value is "endTime"..
public function get endTimeField():String public function set endTimeField(value:String):void| endTimeFunction | property |
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..
public function get endTimeFunction():Function public function set endTimeFunction(value:Function):void| errorItems | property |
errorItems:ArrayCollection [read-only] public function get errorItems():ArrayCollection| eventMultiSelectEnabled | property |
eventMultiSelectEnabled:BooleanSpecify 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.
public function get eventMultiSelectEnabled():Boolean public function set eventMultiSelectEnabled(value:Boolean):void| eventMultiSelectionLassoModeEnabled | property |
eventMultiSelectionLassoModeEnabled:BooleanSpecify 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.
public function get eventMultiSelectionLassoModeEnabled():Boolean public function set eventMultiSelectionLassoModeEnabled(value:Boolean):void| eventsHeight | property |
eventsHeight:NumberEvents 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.
public function get eventsHeight():Number public function set eventsHeight(value:Number):void| eventTimeStep | property |
eventTimeStep:intIndicates 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.
public function get eventTimeStep():int public function set eventTimeStep(value:int):void| eventTimeStepInMs | property |
eventTimeStepInMs:int [read-only] public function get eventTimeStepInMs():int| hiddenDays | property |
hiddenDays:ArrayContains 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.
public function get hiddenDays():Array public function set hiddenDays(value:Array):void| hideInactiveDaysInDayView | property |
hideInactiveDaysInDayView:BooleanSpecify 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.
public function get hideInactiveDaysInDayView():Boolean public function set hideInactiveDaysInDayView(value:Boolean):void| highlightDayRangeColumnFunction | property |
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.
public function get highlightDayRangeColumnFunction():Function public function set highlightDayRangeColumnFunction(value:Function):void| highlightDayRangeFunction | property |
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.
public function get highlightDayRangeFunction():Function public function set highlightDayRangeFunction(value:Function):void| hourBarStep | property |
hourBarStep:NumberDetermines 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.
public function get hourBarStep():Number public function set hourBarStep(value:Number):void| hourHalfBarVisible | property |
hourHalfBarVisible:BooleanDetermines if a half hour bar is displayed.
The default value is false..
This property can be used as the source for data binding.
public function get hourHalfBarVisible():Boolean public function set hourHalfBarVisible(value:Boolean):void| hourHeight | property |
hourHeight:intSpecify 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.
public function get hourHeight():int public function set hourHeight(value:int):void| hoursBarVisible | property |
hoursBarVisible:BooleanSpecify 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.
public function get hoursBarVisible():Boolean public function set hoursBarVisible(value:Boolean):void| hoursCount | property |
hoursCount:int [read-only] Returns number of displayed hours.
public function get hoursCount():int| hoursGridWidth | property |
hoursGridWidth:NumberHours 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.
public function get hoursGridWidth():Number public function set hoursGridWidth(value:Number):void| iconCalendarInvalid | property |
iconCalendarInvalid:ClassCurrent calendar icon. Property can be set to change calendar icon.
public function get iconCalendarInvalid():Class public function set iconCalendarInvalid(value:Class):void| iconResource | property |
iconResource:ClassCurrent resource icon. Property can be set to change resource icon.
public function get iconResource():Class public function set iconResource(value:Class):voidSee also
| iconResourceUndefined | property |
iconResourceUndefined:ClassCurrent resource undefined icon. Property can be set to change resource undefined icon.
public function get iconResourceUndefined():Class public function set iconResourceUndefined(value:Class):voidSee also
| invalidDayRangeColumnFunction | property |
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.
public function get invalidDayRangeColumnFunction():Function public function set invalidDayRangeColumnFunction(value:Function):void| invalidDayRangeFunction | property |
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.
public function get invalidDayRangeFunction():Function public function set invalidDayRangeFunction(value:Function):void| isLassoSelectionInProgress | property |
isLassoSelectionInProgress:Boolean [read-only] public function get isLassoSelectionInProgress():Boolean| itemCornerRadius | property |
itemCornerRadius:NumberItem 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.
public function get itemCornerRadius():Number public function set itemCornerRadius(value:Number):void| itemLeftMargin | property |
itemLeftMargin:NumberItem 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.
public function get itemLeftMargin():Number public function set itemLeftMargin(value:Number):void| itemMargin | property |
itemMargin:NumberItem 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.
public function get itemMargin():Number public function set itemMargin(value:Number):void| itemRightMargin | property |
itemRightMargin:NumberItem 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.
public function get itemRightMargin():Number public function set itemRightMargin(value:Number):void| items | property |
items:ArrayCollection [read-only] List of CalendarItem (one for each dataProvider objects)
public function get items():ArrayCollection| keepRangeSelectionVisible | property |
keepRangeSelectionVisible:BooleanIndicates 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.
public function get keepRangeSelectionVisible():Boolean public function set keepRangeSelectionVisible(value:Boolean):void| labelField | property |
labelField:StringThe property name of objects where the event label is stored. It is only used if no labelFunction is defined.
The default value is "label".
public function get labelField():String public function set labelField(value:String):void| labelFunction | property |
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..
public function get labelFunction():Function public function set labelFunction(value:Function):void| lassoSelectionEnabled | property |
lassoSelectionEnabled:BooleanIndicates if lasso selection is enabled (controlled by CRTL key).
This property can be used as the source for data binding.
public function get lassoSelectionEnabled():Boolean public function set lassoSelectionEnabled(value:Boolean):void| monthHeaderHeight | property |
monthHeaderHeight:NumberMonth 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.
public function get monthHeaderHeight():Number public function set monthHeaderHeight(value:Number):void| mouseSelectionColumnToolTipFunction | property |
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.
public function get mouseSelectionColumnToolTipFunction():Function public function set mouseSelectionColumnToolTipFunction(value:Function):void| mouseSelectionFullHour | property |
mouseSelectionFullHour:BooleanDetermines 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.
public function get mouseSelectionFullHour():Boolean public function set mouseSelectionFullHour(value:Boolean):void| mouseSelectionStep | property |
mouseSelectionStep:intDetermines 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.
public function get mouseSelectionStep():int public function set mouseSelectionStep(value:int):void| mouseSelectionToolTipFunction | property |
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.
public function get mouseSelectionToolTipFunction():Function public function set mouseSelectionToolTipFunction(value:Function):void| mouseSelectionToolTipVisible | property |
mouseSelectionToolTipVisible:BooleanIndicates 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.
public function get mouseSelectionToolTipVisible():Boolean public function set mouseSelectionToolTipVisible(value:Boolean):void| mouseSelectionVisible | property |
mouseSelectionVisible:BooleanDetermines 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.
public function get mouseSelectionVisible():Boolean public function set mouseSelectionVisible(value:Boolean):void| mouseWheelNavigationEnabled | property |
mouseWheelNavigationEnabled:BooleanDetermines 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.
public function get mouseWheelNavigationEnabled():Boolean public function set mouseWheelNavigationEnabled(value:Boolean):void| multipleDaysForYearRenderer | property |
multipleDaysForYearRenderer:BooleanSpecify 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.
public function get multipleDaysForYearRenderer():Boolean public function set multipleDaysForYearRenderer(value:Boolean):void| notDisplayedItemsIndicatorVisible | property |
notDisplayedItemsIndicatorVisible:BooleanSpecify 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.
public function get notDisplayedItemsIndicatorVisible():Boolean public function set notDisplayedItemsIndicatorVisible(value:Boolean):void| otherColumnDragEnabled | property |
otherColumnDragEnabled:BooleanSpecify 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.
public function get otherColumnDragEnabled():Boolean public function set otherColumnDragEnabled(value:Boolean):void| rangeSelection | property |
rangeSelection:DateRangeGives the selected range.
The default value is null..
This property can be used as the source for data binding.
public function get rangeSelection():DateRange public function set rangeSelection(value:DateRange):void| rangeSelectionEnabled | property |
rangeSelectionEnabled:BooleanIndicates if range selection is enabled on cells.
The default value is true..
This property can be used as the source for data binding.
public function get rangeSelectionEnabled():Boolean public function set rangeSelectionEnabled(value:Boolean):void| rangeSelectionInProgress | property |
rangeSelectionInProgress:BooleanIndicates if a range selection is in progress.
The default value is false..
This property can be used as the source for data binding.
public function get rangeSelectionInProgress():Boolean public function set rangeSelectionInProgress(value:Boolean):void| readOnlyField | property |
readOnlyField:StringThe property name where is stored the event readOnly. It is only used if no readOnlyFunction is defined.
The default value is "readOnly"..
public function get readOnlyField():String public function set readOnlyField(value:String):void| readOnlyFunction | property |
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..
public function get readOnlyFunction():Function public function set readOnlyFunction(value:Function):void| resizeBottomImage | property |
resizeBottomImage:ClassThis property can be used as the source for data binding.
public static function get resizeBottomImage():Class public static function set resizeBottomImage(value:Class):void| resizeButtonHeight | property |
resizeButtonHeight:intSpecify the event resize button heigth (vertical events).
The default value is 10..
This property can be used as the source for data binding.
public function get resizeButtonHeight():int public function set resizeButtonHeight(value:int):void| resizeButtonWidth | property |
resizeButtonWidth:intSpecify the event resize button width (horizontal events).
The default value is 10..
This property can be used as the source for data binding.
public function get resizeButtonWidth():int public function set resizeButtonWidth(value:int):void| resizeOverDayRangeEnabled | property |
resizeOverDayRangeEnabled:BooleanDetermines 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.
public function get resizeOverDayRangeEnabled():Boolean public function set resizeOverDayRangeEnabled(value:Boolean):void| resizeRightImage | property |
resizeRightImage:ClassThis property can be used as the source for data binding.
public static function get resizeRightImage():Class public static function set resizeRightImage(value:Class):void| resourceField | property |
resourceField:StringThe 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"..
public function get resourceField():String public function set resourceField(value:String):voidSee also
| resourceFunction | property |
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..
public function get resourceFunction():Function public function set resourceFunction(value:Function):voidSee also
| selectableField | property |
selectableField:StringThe 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"..
public function get selectableField():String public function set selectableField(value:String):void| selectableFunction | property |
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.
public function get selectableFunction():Function public function set selectableFunction(value:Function):void| selectedItem | property |
selectedItem:CalendarItemCurrently 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.
public function get selectedItem():CalendarItem public function set selectedItem(value:CalendarItem):void| selectedItems | property |
selectedItems:ArrayCollectionCurrently 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.
public function get selectedItems():ArrayCollection public function set selectedItems(value:ArrayCollection):void| showEventHours | property |
showEventHours:BooleanSpecify if event hours must be displayed in items.
The default value is true..
This property can be used as the source for data binding.
public function get showEventHours():Boolean public function set showEventHours(value:Boolean):void| stackedEventGapHeight | property |
stackedEventGapHeight:intSpecify 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.
public function get stackedEventGapHeight():int public function set stackedEventGapHeight(value:int):void| stackedEventHeight | property |
stackedEventHeight:intSpecify 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.
public function get stackedEventHeight():int public function set stackedEventHeight(value:int):void| stackedEventsEnabled | property |
stackedEventsEnabled:BooleanSpecify 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.
public function get stackedEventsEnabled():Boolean public function set stackedEventsEnabled(value:Boolean):void| startHour | property |
startHour:intIndicates the start hour for day & week view.
The default value is 0..
This property can be used as the source for data binding.
public function get startHour():int public function set startHour(value:int):void| startHourDisplay | property |
startHourDisplay:intIndicates the first hour displayed on day & week view.
The default value is 8..
This property can be used as the source for data binding.
public function get startHourDisplay():int public function set startHourDisplay(value:int):void| startTimeField | property |
startTimeField:StringThe property name where is stored the event start time. It is only used if no startTimeFunction is defined.
The default value is "startTime"..
public function get startTimeField():String public function set startTimeField(value:String):void| startTimeFunction | property |
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..
public function get startTimeFunction():Function public function set startTimeFunction(value:Function):void| staticEventDispatcher | property |
staticEventDispatcher:IEventDispatcher [read-only] public static function get staticEventDispatcher():IEventDispatcher| statusField | property |
statusField:StringThe property name where is stored the event status. It is only used if no statusFunction is defined.
The default value is "status"..
public function get statusField():String public function set statusField(value:String):void| statusFunction | property |
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..
public function get statusFunction():Function public function set statusFunction(value:Function):void| titleField | property |
titleField:StringThe 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.
public function get titleField():String public function set titleField(value:String):void| titleFunction | property |
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.
public function get titleFunction():Function public function set titleFunction(value:Function):void| todayButtonVisible | property |
todayButtonVisible:BooleanControls 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.
public function get todayButtonVisible():Boolean public function set todayButtonVisible(value:Boolean):void| toolTipFunction | property |
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.
public function get toolTipFunction():Function public function set toolTipFunction(value:Function):void| transitionConfig | property |
transitionConfig:TransitionConfigSpecify 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.
public function get transitionConfig():TransitionConfig public function set transitionConfig(value:TransitionConfig):void| transitionEnabled | property |
transitionEnabled:BooleanSpecify if transitions are enabled (animated transitions).
This property can be used as the source for data binding.
public function get transitionEnabled():Boolean public function set transitionEnabled(value:Boolean):void| useGradientInItemRenderers | property |
useGradientInItemRenderers:BooleanSpecify 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.
public function get useGradientInItemRenderers():Boolean public function set useGradientInItemRenderers(value:Boolean):void| useRollOverInItemRenderers | property |
useRollOverInItemRenderers:BooleanSpecify 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.
public function get useRollOverInItemRenderers():Boolean public function set useRollOverInItemRenderers(value:Boolean):void| visibleEventCount | property |
visibleEventCount:int [read-only] Number of visible items in the current view.
This property can be used as the source for data binding.
public function get visibleEventCount():int| visibleItems | property |
visibleItems:ArrayCollection [read-only] List of visible CalendarItem in the current view (one for each displayed dataProvider object)
public function get visibleItems():ArrayCollection| visibleRange | property |
| weekDayHeadersVisible | property |
weekDayHeadersVisible:BooleanDetermines if day headers are visible in week view.
The default value is true..
This property can be used as the source for data binding.
public function get weekDayHeadersVisible():Boolean public function set weekDayHeadersVisible(value:Boolean):void| weekDayViewCellsItems | property |
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.
public function get weekDayViewCellsItems():ArrayCollection| weekDayViewHeaderItems | property |
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.
public function get weekDayViewHeaderItems():ArrayCollection| weekNumberVisible | property |
weekNumberVisible:BooleanDetermines if week number is visible in all views.
The default value is true..
This property can be used as the source for data binding.
public function get weekNumberVisible():Boolean public function set weekNumberVisible(value:Boolean):void| weekNumberVisibleForMonthView | property |
weekNumberVisibleForMonthView:BooleanDetermines if week number is visible in all views.
The default value is true..
This property can be used as the source for data binding.
public function get weekNumberVisibleForMonthView():Boolean public function set weekNumberVisibleForMonthView(value:Boolean):void| weekNumberVisibleForWeekAndDayView | property |
weekNumberVisibleForWeekAndDayView:BooleanDetermines if week number is visible in all views.
The default value is true..
This property can be used as the source for data binding.
public function get weekNumberVisibleForWeekAndDayView():Boolean public function set weekNumberVisibleForWeekAndDayView(value:Boolean):void| weekNumberVisibleForYearView | property |
weekNumberVisibleForYearView:BooleanDetermines if week number is visible in all views.
The default value is true..
This property can be used as the source for data binding.
public function get weekNumberVisibleForYearView():Boolean public function set weekNumberVisibleForYearView(value:Boolean):void| weeksBarWidth | property |
weeksBarWidth:NumberWeeks 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.
public function get weeksBarWidth():Number public function set weeksBarWidth(value:Number):void| yearToolTipFunction | property |
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.
public function get yearToolTipFunction():Function public function set yearToolTipFunction(value:Function):void| yearViewVisible | property |
yearViewVisible:BooleanControls 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.
public function get yearViewVisible():Boolean public function set yearViewVisible(value:Boolean):void| 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:
You can also provide:
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).
| cellClickHandler | () | method |
| cellDoubleClickHandler | () | method |
| changeDateHandler | () | method |
public function changeDateHandler(event:DateChangedEvent):voidInternal usage.
Parameters
event:DateChangedEvent |
| commitProperties | () | method |
override protected function commitProperties():voidOverriden commitProperties method.
| copyToClipboard | () | method |
public function copyToClipboard():void| dateClickHandler | () | method |
| emptySelection | () | method |
public function emptySelection():voidEmpty the current selection.
| forceResourceChanged | () | method |
public function forceResourceChanged():voidForce a full update as if resource have been changed (could be useful when you use runtime localization)
| generateCode | () | method |
public function generateCode():StringThis 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.
ReturnsString — MXML code
|
| getCalendarEventAdditionalImage | () | method |
public function getCalendarEventAdditionalImage(item:Object):*Get the event additional image.
Parameters
item:Object — event object.
|
* — image source or null if undefined.
|
| getCalendarEventColor | () | method |
public function getCalendarEventColor(item:Object):NumberGet the color of an event.
Parameters
item:Object — event object.
|
Number — event color.
|
| getCalendarEventColumn | () | method |
public function getCalendarEventColumn(item:Object, checkRange:Boolean = true):intGet 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.
|
int — event column.
|
| getCalendarEventEndTime | () | method |
public function getCalendarEventEndTime(item:Object):DateGet the EndTime of an event
Parameters
item:Object — event object.
|
Date — Date corresponding to the date of the event.
|
| getCalendarEventLabel | () | method |
public function getCalendarEventLabel(item:Object):StringGet the label of an event
Parameters
item:Object — event object.
|
String — String corresponding to the label of the event.
|
| getCalendarEventReadOnly | () | method |
public function getCalendarEventReadOnly(item:Object, readOnlyForStackedEventsEnabled:Boolean = true):BooleanGet the read-only state of an event.
Parameters
item:Object — event object.
| |
readOnlyForStackedEventsEnabled:Boolean (default = true) |
Boolean — if event is read-only.
|
| getCalendarEventResource | () | method |
public function getCalendarEventResource(item:Object):StringGet the ressource of an event
Parameters
item:Object — event object.
|
String — String corresponding to the ressource of the event.
|
| getCalendarEventSelectable | () | method |
public function getCalendarEventSelectable(item:Object):BooleanGet the event selectable state.
Parameters
item:Object — event object.
|
Boolean — if event is selectable (hand cursor upon mouse over).
|
| getCalendarEventStartTime | () | method |
public function getCalendarEventStartTime(item:Object):DateGet the StartTime of an event
Parameters
item:Object — event object.
|
Date — Date corresponding to the label of the event.
|
| getCalendarEventStatus | () | method |
public function getCalendarEventStatus(item:Object):intGet the status of an event.
Parameters
item:Object — event object.
|
int — event status.
|
| getCalendarEventTitle | () | method |
public function getCalendarEventTitle(item:Object):StringGet the title of an event
Parameters
item:Object — event object.
|
String — String corresponding to the title of the event.
|
| getCurrentRangeToString | () | method |
public function getCurrentRangeToString():StringReturn 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:
String — the date range
|
| getCurrentView | () | method |
| getDayIndexAccordingToHiddenDays | () | method |
public function getDayIndexAccordingToHiddenDays(dateIndex:int):intReturns 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)
|
int — day index from 0 to 6
|
| getDurationAccordingToHiddenDays | () | method |
public function getDurationAccordingToHiddenDays(dateIndex:int, duration:Number):NumberReturns 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
|
Number — duration
|
| getMonthView | () | method |
| getOffsetHiddenDays | () | method |
public function getOffsetHiddenDays():ArrayReturns 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.
ReturnsArray |
| getOriginalDayIndexAccordingToHiddenDays | () | method |
public function getOriginalDayIndexAccordingToHiddenDays(dateIndex:int):intReverse 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)
|
int — day index from 0 to 6
|
| getOriginalDayIndexForMonthViewAccordingToHiddenDays | () | method |
public function getOriginalDayIndexForMonthViewAccordingToHiddenDays(dateIndex:int):intReturns 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)
|
int — day index from 0 to 30
|
| getPendingCalendarItems | () | method |
public function getPendingCalendarItems():ArrayCollectionRetrieves the CalendarItems that contains some pending modifications (start or end dates).
ReturnsArrayCollection — ArrayCollection of CalendarItem. Result is empty if no CalendarItem contains any modifications.
|
| getWeekDayView | () | method |
| getYearView | () | method |
| isDayView | () | method |
public function isDayView():BooleanReturnsBoolean |
| isMonthView | () | method |
public function isMonthView():BooleanReturnsBoolean |
| isPV | () | method |
public final function isPV():BooleanReturnsBoolean |
| isWeekOrDayView | () | method |
public function isWeekOrDayView():BooleanReturnsBoolean |
| isWeekView | () | method |
public function isWeekView():BooleanReturnsBoolean |
| isYearView | () | method |
public function isYearView():BooleanReturnsBoolean |
| itemChangedHandler | () | method |
| itemClickHandler | () | method |
| itemDoubleClickHandler | () | method |
| itemRollOutHandler | () | method |
| itemRollOverHandler | () | method |
| itemToCalendarItem | () | method |
public function itemToCalendarItem(item:Object):CalendarItemRetrieves the CalendarItem managing the given data provider item.
Parameters
item:Object — data provider item to find.
|
CalendarItem — CalendarItem that manages the data provider item. Return null if no CalendarItem is found.
|
| loadDataFromSharedObject | () | method |
public function loadDataFromSharedObject(name:String, itemObjectClass:Class):voidLoads 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():voidSet calendar to its maximum size in order for all cells to be displayed
| measure | () | method |
override protected function measure():voidOverriden measure method.
| next | () | method |
public function next():voidChange current date, set it to next:
| previous | () | method |
public function previous():voidChange current date, set it to previous:
| printCurrentView | () | method |
public function printCurrentView(doNotPrint:Boolean = false):ImagePrints an image capture of the calendar's current view
Parameters
doNotPrint:Boolean (default = false) — indicates if the image has to be printed.
|
Image — current view image
|
| resourcesChanged | () | method |
override protected function resourcesChanged():voidOverriden resourcesChanged method. Update calendar component language on the fly.
| saveDataToSharedObject | () | method |
public function saveDataToSharedObject(name:String, itemObjectClass:Class):voidSave 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():voidIn 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():voidSet display mode to day view.
| setEndHourInternal | () | method |
public function setEndHourInternal(value:int):voidInternal function used in stacked event mode.
Parameters
value:int |
| setMonthView | () | method |
public function setMonthView():voidSet display mode to month view.
| setStyle | () | method |
override public function setStyle(styleProp:String, newValue:*):voidOverriden setStyle method.
Parameters
styleProp:String | |
newValue:* |
| setWeekView | () | method |
public function setWeekView():voidSet display mode to week view.
| setYearView | () | method |
public function setYearView():voidSet display mode to year view.
| startLassoSelection | () | method |
public function startLassoSelection():void| traceItems | () | method |
public function traceItems(items:ArrayCollection, prefix:String):voidParameters
items:ArrayCollection | |
prefix:String |
| updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidOverriden updateDisplayList method.
Parameters
unscaledWidth:Number | |
unscaledHeight:Number |
| viewUpdateComplete | () | method |
public function viewUpdateComplete(view:GenericView):voidInternal usage.
Parameters
view:GenericView |
| cellClick | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when the user clicks on a calendar cell where there is no event.
| cellDoubleClick | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when the user double-clicks on a calendar cell where there is no event.
| currentDateChange | Event |
com.keepcore.calendar.event.DateChangedEventcom.keepcore.calendar.event.DateChangedEventDispatched when the current date is changed.
| dateClick | Event |
com.keepcore.calendar.event.DateClickEventcom.keepcore.calendar.event.CalendarEventDispatched 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 |
flash.events.Eventflash.events.EventDispatched when the display mode is changed.
| displayModeChanging | Event |
flash.events.Eventflash.events.EventDispatched 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 |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when an event has been changed.
| itemClick | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when an event has been clicked.
| itemDoubleClick | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when an event has been double-clicked.
| itemRollOut | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when the user rolls the mouse out of an event.
| itemRollOver | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when the user rolls the mouse over an event.
| itemSelected | Event |
com.keepcore.calendar.event.CalendarEventcom.keepcore.calendar.event.CalendarEventDispatched when the user selects an event.
| visibleRangeChange | Event |
flash.events.Eventflash.events.EventDispatched when the visible range changes. For exemple, it could be used to change data provider before display update.
| CALENDAR_CONTROL_BAR_BACKGROUND_COLOR | Constant |
public static const CALENDAR_CONTROL_BAR_BACKGROUND_COLOR:String = calendarControlBarBackgroundColor| COLUMN_HEADER_FONT_STYLE | Constant |
public static const COLUMN_HEADER_FONT_STYLE:String = columnHeaderFontStyleName| CURRENT_HOUR_BAR_COLOR_STYLE | Constant |
public static const CURRENT_HOUR_BAR_COLOR_STYLE:String = currentHourBarColor| DAY_CELL_BACKGROUND_ALPHA_STYLE | Constant |
public static const DAY_CELL_BACKGROUND_ALPHA_STYLE:String = dayCellBackgroundAlpha| DAY_CELL_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_CELL_BACKGROUND_COLOR_STYLE:String = dayCellBackgroundColor| DAY_CELL_BORDER_COLOR_STYLE | Constant |
public static const DAY_CELL_BORDER_COLOR_STYLE:String = dayCellBorderColor| DAY_CELL_INACTIVE_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_CELL_INACTIVE_BACKGROUND_COLOR_STYLE:String = dayCellInactiveBackgroundColor| DAY_CELL_TODAY_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_CELL_TODAY_BACKGROUND_COLOR_STYLE:String = dayCellTodayBackgroundColor| DAY_COLOR_ALPHA | Constant |
public static const DAY_COLOR_ALPHA:String = dayColorAlpha| DAY_HEADER_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_HEADER_BACKGROUND_COLOR_STYLE:String = dayHeaderBackgroundColor| DAY_HEADER_BORDER_COLOR_STYLE | Constant |
public static const DAY_HEADER_BORDER_COLOR_STYLE:String = dayHeaderBorderColor| DAY_HEADER_FONT_STYLE | Constant |
public static const DAY_HEADER_FONT_STYLE:String = dayHeaderFontStyleName| DAY_HEADER_INACTIVE_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_HEADER_INACTIVE_BACKGROUND_COLOR_STYLE:String = dayHeaderInactiveBackgroundColor| DAY_HEADER_TODAY_BACKGROUND_COLOR_STYLE | Constant |
public static const DAY_HEADER_TODAY_BACKGROUND_COLOR_STYLE:String = dayHeaderTodayBackgroundColor| DAY_VIEW | Constant |
public static const DAY_VIEW:Number = 2| DAYS_BAR_BACKGROUND_COLOR_STYLE | Constant |
public static const DAYS_BAR_BACKGROUND_COLOR_STYLE:String = daysBarBackgroundColor| DAYS_BAR_BORDER_COLOR_STYLE | Constant |
public static const DAYS_BAR_BORDER_COLOR_STYLE:String = daysBarBorderColor| DAYS_BAR_FONT_STYLE | Constant |
public static const DAYS_BAR_FONT_STYLE:String = daysBarFontStyleName| DAYS_DOUBLE_BAR_SEPARATOR_SHOWING_STYLE | Constant |
public static const DAYS_DOUBLE_BAR_SEPARATOR_SHOWING_STYLE:String = daysDoubleBarSeparatorShowing| DEFAULT_ITEM_BACKGROUND_COLOR | Constant |
public static const DEFAULT_ITEM_BACKGROUND_COLOR:String = defaultItemBackgroundColor| DISPLAY_MODE_CHANGE | Constant |
public static const DISPLAY_MODE_CHANGE:String = displayModeChange| DISPLAY_MODE_CHANGING | Constant |
public static const DISPLAY_MODE_CHANGING:String = displayModeChanging| FULL_VERSION | Constant |
public static const FULL_VERSION:String| HIGHLIGHT_DAY_RANGE_BACKGROUND_ALPHA | Constant |
public static const HIGHLIGHT_DAY_RANGE_BACKGROUND_ALPHA:String = highlightDayRangeBackgroundAlpha| HIGHLIGHT_DAY_RANGE_BACKGROUND_COLOR | Constant |
public static const HIGHLIGHT_DAY_RANGE_BACKGROUND_COLOR:String = highlightDayRangeBackgroundColor| HOUR_HALF_BAR_BORDER_ALPHA_STYLE | Constant |
public static const HOUR_HALF_BAR_BORDER_ALPHA_STYLE:String = hourHalfBarBorderAlpha| HOUR_HALF_BAR_BORDER_COLOR_STYLE | Constant |
public static const HOUR_HALF_BAR_BORDER_COLOR_STYLE:String = hourHalfBarBorderColor| HOURS_BAR_BACKGROUND_COLOR_STYLE | Constant |
public static const HOURS_BAR_BACKGROUND_COLOR_STYLE:String = hoursBarBackgroundColor| HOURS_BAR_BORDER_COLOR_STYLE | Constant |
public static const HOURS_BAR_BORDER_COLOR_STYLE:String = hoursBarBorderColor| HOURS_BAR_FONT_STYLE | Constant |
public static const HOURS_BAR_FONT_STYLE:String = hoursBarFontStyleName| INVALID_DAY_RANGE_BACKGROUND_ALPHA | Constant |
public static const INVALID_DAY_RANGE_BACKGROUND_ALPHA:String = invalidDayRangeBackgroundAlpha| INVALID_DAY_RANGE_BACKGROUND_COLOR | Constant |
public static const INVALID_DAY_RANGE_BACKGROUND_COLOR:String = invalidDayRangeBackgroundColor| ITEM_HOURS_FONT_STYLE | Constant |
public static const ITEM_HOURS_FONT_STYLE:String = itemHoursFontStyleName| ITEM_LABEL_FONT_STYLE | Constant |
public static const ITEM_LABEL_FONT_STYLE:String = itemLabelFontStyleName| ITEM_TITLE_FONT_STYLE | Constant |
public static const ITEM_TITLE_FONT_STYLE:String = itemTitleFontStyleName| KC_DEMO_TEXT | Constant |
public static const KC_DEMO_TEXT:String = KCCalendarwww.flex-component.com| KC_WEBSITE | Constant |
public static const KC_WEBSITE:String = http://www.flex-component.com/| MAX_CALENDAR_COUNT | Constant |
public static const MAX_CALENDAR_COUNT:Number = 3| MONTH_HEADER_BACKGROUND_COLOR_STYLE | Constant |
public static const MONTH_HEADER_BACKGROUND_COLOR_STYLE:String = monthHeaderBackgroundColor| MONTH_HEADER_BORDER_COLOR_STYLE | Constant |
public static const MONTH_HEADER_BORDER_COLOR_STYLE:String = monthHeaderBorderColor| MONTH_HEADER_TODAY_BACKGROUND_COLOR_STYLE | Constant |
public static const MONTH_HEADER_TODAY_BACKGROUND_COLOR_STYLE:String = monthHeaderTodayBackgroundColor| MONTH_VIEW | Constant |
public static const MONTH_VIEW:Number = 0| MOUSE_SELECTION_BACKGROUND_COLOR | Constant |
public static const MOUSE_SELECTION_BACKGROUND_COLOR:String = mouseSelectionBackgroundColor| NOT_DISPLAYED_ITEMS_INDICATOR_FONT_STYLE | Constant |
public static const NOT_DISPLAYED_ITEMS_INDICATOR_FONT_STYLE:String = notDisplayedItemsIndicatorFontStyleName| OVERLAP_MODE | Constant |
public static const OVERLAP_MODE:Number = 1| SIDE_MODE | Constant |
public static const SIDE_MODE:Number = 0| STATUS_UP_TO_DATE | Constant |
public static const STATUS_UP_TO_DATE:int = 0| STATUS_UP_TO_DATE_STRING | Constant |
public static const STATUS_UP_TO_DATE_STRING:String| STATUS_UPDATING | Constant |
public static const STATUS_UPDATING:int = 1| STATUS_UPDATING_STRING | Constant |
public static const STATUS_UPDATING_STRING:String| VERSION | Constant |
public static const VERSION:String = 1.6.0| VISIBLE_RANGE_CHANGE | Constant |
public static const VISIBLE_RANGE_CHANGE:String = visibleRangeChange| WEEK_FONT_STYLE | Constant |
public static const WEEK_FONT_STYLE:String = weekFontStyleName| WEEK_VIEW | Constant |
public static const WEEK_VIEW:Number = 1| WEEKS_BAR_BACKGROUND_COLOR_STYLE | Constant |
public static const WEEKS_BAR_BACKGROUND_COLOR_STYLE:String = weeksBarBackgroundColor| WEEKS_BAR_BORDER_COLOR_STYLE | Constant |
public static const WEEKS_BAR_BORDER_COLOR_STYLE:String = weeksBarBorderColor| YEAR_DAY_BORDER_COLOR_STYLE | Constant |
public static const YEAR_DAY_BORDER_COLOR_STYLE:String = yearDayBorderColor| YEAR_DAY_FONT_STYLE | Constant |
public static const YEAR_DAY_FONT_STYLE:String = yearDayFontStyleName| YEAR_DAY_WEEK_END_BORDER_COLOR_STYLE | Constant |
public static const YEAR_DAY_WEEK_END_BORDER_COLOR_STYLE:String = yearDayWeekEndBorderColor| YEAR_MONTH_HEADER_FONT_STYLE | Constant |
public static const YEAR_MONTH_HEADER_FONT_STYLE:String = yearMonthHeaderFontStyleName| YEAR_RENDERER_FONT_STYLE | Constant |
public static const YEAR_RENDERER_FONT_STYLE:String = yearRendererFontStyleName| YEAR_VIEW | Constant |
public static const YEAR_VIEW:Number = 3| YEAR_WEEK_FONT_STYLE | Constant |
public static const YEAR_WEEK_FONT_STYLE:String = yearWeekFontStyleName