Packagecom.flexcalendar.components.calendar.utils.context
Classpublic class CalendarContext
InheritanceCalendarContext Inheritance flash.events.EventDispatcher
Implements ICalendarContext

Holds calendar parameters that can be accessed from inner components.



Public Properties
 PropertyDefined By
  acceptItemsInLimitedEditModeAlwaysButInUnavailableSpace : Boolean
When this flag is enabled it's not required to create available spaces in limited edit mode.
CalendarContext
  availableSpaceIsMoreImportantThanUnavailableSpace : Boolean
Flag that indicates whether available space is more important than unavailable space.
CalendarContext
  cacheTimeToLive : Number
Time to live in milliseconds for cached items.
CalendarContext
  calendarMode : int
Calendar mode defines rules of calendar items' editing.
CalendarContext
  columnModeEnabled : Boolean
FLag that indicates whether column mode is enabled.
CalendarContext
  dataProvider : ICalendarDataProvider
Get calendar data provider from the context.
CalendarContext
  dateOptions : DateOptions
Access DateOptions with date handling configuration
CalendarContext
  dragBetweenColumnsEnabled : Boolean
FLag that indicates whether dragging between columns/calendars is enabled in column mode.
CalendarContext
  dropUiComponentsEnabled : Boolean
FLag that indicates whether dropped UIComponents can create calendar item.
CalendarContext
  granularityMinutes : Number
Set granularity of displayed minutes
CalendarContext
  mainEventDispatcher : EventDispatcher
[read-only]
CalendarContext
  readOnly : Boolean
[read-only] Indicates whether entire component is readonly.
CalendarContext
  snapToGridThreshold : int
Set current snap to grid threshold, in milliseconds.
CalendarContext
  visibleHoursEnd : Number
Set visible hours end hour It's applied only when visibleHoursLimited is set
CalendarContext
  visibleHoursLimited : Boolean
When it'is set calendar displays only hours range specified by visibleHoursEnd and visibleHoursStart
CalendarContext
  visibleHoursStart : Number
Set visible hours start hour It's applied only when visibleHoursLimited is set
CalendarContext
Protected Properties
 PropertyDefined By
  _dateOptions : DateOptions
CalendarContext
  _granularityMinutes : Number = 60
CalendarContext
  _visibleHourEnd : Number
CalendarContext
  _visibleHourLimited : Boolean = false
CalendarContext
  _visibleHourStart : Number
CalendarContext
Public Methods
 MethodDefined By
  
CalendarContext(mainEventDispatcher:EventDispatcher)
CalendarContext
Property Detail
_dateOptionsproperty
protected var _dateOptions:DateOptions

_granularityMinutesproperty 
protected var _granularityMinutes:Number = 60

_visibleHourEndproperty 
protected var _visibleHourEnd:Number

_visibleHourLimitedproperty 
protected var _visibleHourLimited:Boolean = false

_visibleHourStartproperty 
protected var _visibleHourStart:Number

acceptItemsInLimitedEditModeAlwaysButInUnavailableSpaceproperty 
acceptItemsInLimitedEditModeAlwaysButInUnavailableSpace:Boolean

When this flag is enabled it's not required to create available spaces in limited edit mode. Items might be placed everywhere - the only forbidden place is UnavailableSpace. Default is true;


Implementation
    public function get acceptItemsInLimitedEditModeAlwaysButInUnavailableSpace():Boolean
    public function set acceptItemsInLimitedEditModeAlwaysButInUnavailableSpace(value:Boolean):void
availableSpaceIsMoreImportantThanUnavailableSpaceproperty 
availableSpaceIsMoreImportantThanUnavailableSpace:Boolean

Flag that indicates whether available space is more important than unavailable space.


Implementation
    public function get availableSpaceIsMoreImportantThanUnavailableSpace():Boolean
    public function set availableSpaceIsMoreImportantThanUnavailableSpace(value:Boolean):void
cacheTimeToLiveproperty 
cacheTimeToLive:Number

Time to live in milliseconds for cached items. It is possible to force invalidate cache for entire FlexCalendar or for any of CalendarItemSet individually.


Implementation
    public function get cacheTimeToLive():Number
    public function set cacheTimeToLive(value:Number):void
calendarModeproperty 
calendarMode:int

Calendar mode defines rules of calendar items' editing.


Implementation
    public function get calendarMode():int
    public function set calendarMode(value:int):void
columnModeEnabledproperty 
columnModeEnabled:Boolean

FLag that indicates whether column mode is enabled.


Implementation
    public function get columnModeEnabled():Boolean
    public function set columnModeEnabled(value:Boolean):void
currentLicenceproperty 
currentLicence:int  [read-only]


Implementation
    fc_internal function get currentLicence():int
dataProviderproperty 
dataProvider:ICalendarDataProvider

Get calendar data provider from the context.


Implementation
    public function get dataProvider():ICalendarDataProvider
    public function set dataProvider(value:ICalendarDataProvider):void
dateOptionsproperty 
dateOptions:DateOptions

Access DateOptions with date handling configuration


Implementation
    public function get dateOptions():DateOptions
    public function set dateOptions(value:DateOptions):void
dragBetweenColumnsEnabledproperty 
dragBetweenColumnsEnabled:Boolean

FLag that indicates whether dragging between columns/calendars is enabled in column mode.


Implementation
    public function get dragBetweenColumnsEnabled():Boolean
    public function set dragBetweenColumnsEnabled(value:Boolean):void
dropUiComponentsEnabledproperty 
dropUiComponentsEnabled:Boolean

FLag that indicates whether dropped UIComponents can create calendar item.


Implementation
    public function get dropUiComponentsEnabled():Boolean
    public function set dropUiComponentsEnabled(value:Boolean):void
granularityMinutesproperty 
granularityMinutes:Number

Set granularity of displayed minutes


Implementation
    public function get granularityMinutes():Number
    public function set granularityMinutes(value:Number):void
licenceLevelRequiredproperty 
licenceLevelRequired:int  [read-only]


Implementation
    fc_internal function get licenceLevelRequired():int
mainEventDispatcherproperty 
mainEventDispatcher:EventDispatcher  [read-only]


Implementation
    public function get mainEventDispatcher():EventDispatcher
readOnlyproperty 
readOnly:Boolean  [read-only]

Indicates whether entire component is readonly. If it's readonly user can not modify it.


Implementation
    public function get readOnly():Boolean
snapToGridThresholdproperty 
snapToGridThreshold:int

Set current snap to grid threshold, in milliseconds. Valid values are full minutes. Default: DateUtils.MILLI_IN_MINUTE 30 (30 minutes)


Implementation
    public function get snapToGridThreshold():int
    public function set snapToGridThreshold(value:int):void
visibleHoursEndproperty 
visibleHoursEnd:Number

Set visible hours end hour It's applied only when visibleHoursLimited is set


Implementation
    public function get visibleHoursEnd():Number
    public function set visibleHoursEnd(value:Number):void
visibleHoursLimitedproperty 
visibleHoursLimited:Boolean

When it'is set calendar displays only hours range specified by visibleHoursEnd and visibleHoursStart


Implementation
    public function get visibleHoursLimited():Boolean
    public function set visibleHoursLimited(value:Boolean):void
visibleHoursStartproperty 
visibleHoursStart:Number

Set visible hours start hour It's applied only when visibleHoursLimited is set


Implementation
    public function get visibleHoursStart():Number
    public function set visibleHoursStart(value:Number):void
Constructor Detail
CalendarContext()Constructor
public function CalendarContext(mainEventDispatcher:EventDispatcher)



Parameters
mainEventDispatcher:EventDispatcher
Method Detail
doRequireProLicence()method
fc_internal function doRequireProLicence():void

verifyLicense()method 
fc_internal function verifyLicense(licence:String):Boolean

Parameters

licence:String

Returns
Boolean