| Package | ardisia.scheduling.dataTypes |
| Class | public class CalendarDefinitionData |
| Inheritance | CalendarDefinitionData  Object |
The properties are flexible and each property is optional. Add whatever properties you would like your renderers to have. By default, properties like "backgroundColor" exist to instruct the renderer on what color to draw its background, but developers can change/add/delete properties as they see fit.
For example, if you want certain calendars to display a red border, add a "redBorder" boolean property to this class and then the renderers can reference the "redBorder" property and draw a red border as required.
CalendarDefinitionData is not only useful for visual properties. User access and editing rights can be added to these objects. By default, the "editable" property is a easy way to disable/enable user editing to the underlying data.
Extend the class as needed.
| Property | Defined By | ||
|---|---|---|---|
| color : uint = 0x9FC6E7
The color used to represent the calendar
| CalendarDefinitionData | ||
| description : String
A a more detailed description of the calendar than the "title" property. | CalendarDefinitionData | ||
| editable : Boolean = true
Indicates whether the user has editing rights for event associated with
this calendar. | CalendarDefinitionData | ||
| enabled : Boolean = true
Whether or not to display the renderer data associated with this object. | CalendarDefinitionData | ||
| id : int
A unique numerical id for the calendar. | CalendarDefinitionData | ||
| title : String
A short title for the calendar. | CalendarDefinitionData | ||
| color | property |
public var color:uint = 0x9FC6E7The color used to represent the calendar
The default value is 0 (blue esque).
| description | property |
public var description:StringA a more detailed description of the calendar than the "title" property.
The default value is "".
| editable | property |
public var editable:Boolean = trueIndicates whether the user has editing rights for event associated with this calendar.
The default value is true.
| enabled | property |
public var enabled:Boolean = trueWhether or not to display the renderer data associated with this object.
The default value is true.
| id | property |
public var id:intA unique numerical id for the calendar.
The default value is 0.
| title | property |
public var title:StringA short title for the calendar. E.G. "Work".
The default value is "".