Packagecom.flextras.calendar
Classpublic class Calendar
InheritanceCalendar Inheritance ListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
ImplementsIObjectArrayForTransitions

The Flextras Calendar Component gives you the base you need to develop your own Calendar based applications. Everything you see on screen as part of the Calendar component is implemented with a renderer, providing you with a solid base for which to extend the component to suit your own needs. The Calendar supports much of the Flex List class API, such as itemEditors, and drag and drop. It also includes elements of the Flex DateChooser such as localization. The Calendar supports Flex 3 and Flex 4, so register to download our free developer edition today.

Uses in the Real World

MXML Syntaxexpanded Hide MXML Syntax

The <flextras:Calendar> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <flextras:Calendar
     Properties
    dateField="date"
    dateFunction="null"
    dayHeaderRenderer="com.flextras.calendar.defaultRenderers.DayHeaderRenderer"
    dayHeaderVisible="true"
    dayNameHeaderRenderer="com.flextras.calendar.defaultRenderers.DayNameHeaderRenderer"
    dayNameHeadersVisible="true"
    dayNames="[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]"
    dayRenderer="com.flextras.calendar.defaultRenderers.dayRenderer"
    displayedDate="Current date"
    displayedMonth="Current month"
    displayedYear=Current year""
    editable="false"
    editedItemPosition="No default"
    editorDataField="text"
    editorHeightOffset="0"
    editorUsesEnterKey="false"
    editorWidthOffset="0"
    editorXOffset="0"
    editorYOffset="0"
    firstDayOfWeek="0"
    imeMode="null"    
    itemEditor="mx.controls.TextInput"
    itemEditorInstance="Current item editor"
    monthHeaderRenderer="com.flextras.calendar.defaultRenderers.MonthHeaderRenderer"
    monthHeaderVisible="true"
    monthNames="["January", "February", "March", "April", "May","June", "July", "August", "September", "October", "November","December"]"
    monthSymbol=""
    rendererIsEditor="true"
    weekHeaderRenderer="com.flextras.calendar.defaultRenderers.WeekHeaderRenderer"
    weekHeaderVisible="true"
  
     
     Events
    change="No default"
    dayClick="No default"
    dayDragComplete="No default"
    dayDragDrop="No default"
    dayDragEnter="No default"
    dayDragExit="No default"
    dayDragOver="No default"
    dayDragStart="No default"
    expandDay="No default"
    expandMonth="No default"
    expandWeek="No default"
    itemClick="No default"
    itemDoubleClick="No default"
    itemEditBegin="No default"
    itemEditBeginning="No default"
    itemEditEnd="No default"
    itemFocusIn="No default"
    itemFocusOut="No default"
    itemRollOut="No default"
    itemRollOver="No default"
    nextDay="No default"
    nextMonth="No default"
    nextWeek="No default"
    nextYear="No default"
    previousDay="No default"
    previousMonth="No default"
    previousWeek="No default"
    previousYear="No default"
   />
   


Public Properties
 PropertyDefined by
 InheritedactiveEffects : Array
The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedallowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
ListBase
  allowMultipleSelection : Boolean
This property is passed through to your dayRenderer.
Calendar
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationTabularData : Object
An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedbaselinePosition : Number
The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 InheritedcacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
The name of this instance's class, such as "Button".
UIComponent
 InheritedcolumnCount : int
The number of columns to be displayed in a TileList control or items in a HorizontalList control.
ListBase
 InheritedcontentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The item in the data provider this component should render when this component is used as an item renderer or item editor.
ListBase
  dataProvider : Object
Set of data to be viewed.
Calendar
  dataTipField : String
This property is passed through to your dayRenderer.
Calendar
  dataTipFunction : Function
This property is passed through to your dayRenderer.
Calendar
  dateField : String
The is the name of the field in the data provider items that will be used as the date for deciding which day your data provider item should be placed on.
Calendar
  dateFunction : Function
This is a user-supplied function to run on each item to determine its date.
Calendar
  dayHeaderRenderer : IFactory
This is a custom renderer for the day header.
Calendar
  dayHeaderVisible : Boolean
This is used to decide whether the Day Header should be displayed in the day expanded state.
Calendar
  dayNameHeaderRenderer : IFactory
This is a custom renderer for the day name header.
Calendar
  dayNameHeadersVisible : Boolean
This checks to see if the dayNameHeaders should be displayed in the week and month views.
Calendar
  dayNames : Array
If you set this property to null, it will get the value "dayNames" from the resourceManager .
Calendar
  dayRenderer : IFactory
This is a custom renderer for the days that make up the Calendar Component.
Calendar
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
  displayedDate : Number
This is used in conjunction with the displayedMonth and displayedYear properties to decide what day to display and where to position it.
Calendar
  displayedDateObject : Date
[read-only] This property will return the currently selected date.
Calendar
  displayedMonth : Number
Used together with the displayedYear and displayedDate property to decide what days to display and where to position them.
Calendar
  displayedYear : Number
Used together with the displayedMonth and displayedDate property to decide what days to display and where to position them.
Calendar
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
  doubleClickEnabled : Boolean
This property is passed through to your dayRenderer.
Calendar
  dragEnabled : Boolean
This property is passed through to your dayRenderer.
Calendar
  dragMoveEnabled : Boolean
This property is passed through to your dayRenderer.
Calendar
  dropEnabled : Boolean
This property is passed through to your dayRenderer.
Calendar
  editable : Boolean
This property is passed through to your dayRenderer.
Calendar
  editedItemRenderer : IListItemRenderer
[read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
Calendar
  editorDataField : String
This property is passed through to your dayRenderer.
Calendar
  editorHeightOffset : Number
This property is passed through to your dayRenderer.
Calendar
  editorUsesEnterKey : Boolean
This property is passed through to your dayRenderer.
Calendar
  editorWidthOffset : Number
This property is passed through to your dayRenderer.
Calendar
  editorXOffset : Number
This property is passed through to your dayRenderer.
Calendar
  editorYOffset : Number
This property is passed through to your dayRenderer.
Calendar
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
  firstDayOfWeek : int
Calendar
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 Inheritedheight : Number
Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalScrollPolicy : String
A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
 InheritedhorizontalScrollPosition : Number
The offset into the content from the left edge.
ScrollControlBase
  iconField : String
This property is passed through to your dayRenderer.
Calendar
  iconFunction : Function
This property is passed through to your dayRenderer.
Calendar
 Inheritedid : String
ID of the component.
UIComponent
  imeMode : String
This property is passed through to your dayRenderer.
Calendar
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : Boolean
Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  itemEditor : IFactory
This property is passed through to your dayRenderer.
Calendar
  itemEditorInstance : IListItemRenderer
[read-only] A reference to the currently active instance of the item editor, if it exists.
Calendar
  itemRenderer : IFactory
This property is passed through to your dayRenderer.
Calendar
  labelField : String
This property is passed through to your dayRenderer.
Calendar
  labelFunction : Function
This property is passed through to your dayRenderer.
Calendar
  lastDayOfWeek : int
[read-only] Number representing the last day of the week to display in the last column of the calendar control.
Calendar
  leadingTrailingDaysVisible : Boolean
This is used to determine whether the leading and trailing days should be displayed in the month state.
Calendar
 InheritedlistData : BaseListData
When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control.
ListBase
 InheritedliveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released.
ScrollControlBase
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
ScrollControlBase
 InheritedmaxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
ScrollControlBase
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
  monthHeaderRenderer : IFactory
This is a custom renderer for the month header.
Calendar
  monthHeaderVisible : Boolean
This is used to determine whether the Month Headers should be displayed in the month state.
Calendar
  monthNames : Array
Calendar
  monthSymbol : String
Calendar
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
  nullItemRenderer : IFactory
This property is passed through to your dayRenderer.
Calendar
 InheritednumAutomationChildren : int
The number of automation children this container has.
UIComponent
  objectArrayForTransitions : Array
[read-only] This is an array of objects that may have property changes during state changes.
Calendar
  offscreenExtraRowsOrColumns : int
This property is passed through to your dayRenderer.
Calendar
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
 Inheritedparent : DisplayObjectContainer
The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
  rendererIsEditor : Boolean
This property is passed through to your dayRenderer.
Calendar
 Inheritedrepeater : IRepeater
A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 InheritedscaleX : Number
Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
Number that specifies the vertical scaling factor.
UIComponent
 Inheritedscreen : Rectangle
Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
  selectable : Boolean
This property is passed through to your dayRenderer.
Calendar
 InheritedselectedIndex : int
The index in the data provider of the selected item.
ListBase
 InheritedselectedIndices : Array
An array of indices in the data provider of the selected items.
ListBase
 InheritedselectedItem : Object
A reference to the selected item in the data provider.
ListBase
 InheritedselectedItems : Array
An array of references to the selected items in the data provider.
ListBase
 InheritedselectedItemsCompareFunction : Function
A function used to compare selectedItems against items in the dataProvider.
ListBase
  showDataTips : Boolean
This property is passed through to your dayRenderer.
Calendar
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 InheritedshowScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 Inheritedvalue : Object
The selected item, or the data or label field of the selected item.
ListBase
 InheritedverticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
 InheritedverticalScrollPosition : Number
The offset into the content from the top edge.
ScrollControlBase
 InheritedviewMetrics : EdgeMetrics
An EdgeMetrics object taking into account the scroll bars, if visible.
ScrollControlBase
 Inheritedvisible : Boolean
Controls the visibility of this UIComponent.
UIComponent
  weekHeaderRenderer : IFactory
This is a custom renderer for the week header.
Calendar
  weekHeaderVisible : Boolean
This is used to determine whether the Week Header should be displayed in the week state.
Calendar
 Inheritedwidth : Number
Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
  wordWrap : Boolean
This property is passed through to your dayRenderer.
Calendar
 Inheritedx : Number
Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
Protected Properties
 PropertyDefined by
 InheritedactualCollection : ICollectionView
A copy of the value normally stored in collection used while running data changes effects.
ListBase
 InheritedactualIterator : IViewCursor
A copy of the value normally stored in iterator used while running data changes effects.
ListBase
 InheritedallowItemSizeChangeNotification : Boolean
If false, renderers cannot invalidate size of List.
ListBase
 InheritedanchorBookmark : CursorBookmark
A bookmark to the item that is the anchor.
ListBase
 InheritedanchorIndex : int = -1
The offset of the item in the data provider that is the selection anchor point.
ListBase
 Inheritedborder : IFlexDisplayObject
The border object.
ScrollControlBase
 InheritedcachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style.
ListBase
  calendarData : ICalendarDataVO
This is an instance of the CalendarData object, passed into the monthDisplay, dayDisplay, and weekDisplay.
Calendar
  calendarMeasurementVO : CalendarMeasurementsVO
This is an instace of the CalendarMeasurementsVO object, passed into the monthDisplay, dayDisplay, and weekDisplay.
Calendar
 InheritedcaretBookmark : CursorBookmark
A bookmark to the item under the caret.
ListBase
 InheritedcaretIndex : int = -1
The offset of the item in the data provider that is the selection caret point.
ListBase
 InheritedcaretIndicator : Sprite
The DisplayObject that contains the graphics that indicate which renderer is the caret.
ListBase
 InheritedcaretItemRenderer : IListItemRenderer
The renderer for the item under the caret.
ListBase
 InheritedcaretUID : String
The UID of the item under the caret.
ListBase
 Inheritedcollection : ICollectionView
An ICollectionView that represents the data provider.
ListBase
 InheriteddataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has just completed.
ListBase
 InheriteddataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers used to supply their data.
ListBase
  dataProviderManager : DataProviderManager
[read-only] This is an instance of the dataProvider Manager component, which is used to decide which data should be displayed on which day.
Calendar
  dayDisplay : IDayDisplay
This contains a reference to the component that displays the expanded day and the day header.
Calendar
 InheriteddefaultColumnCount : int = 4
The default number of columns to display.
ListBase
 InheriteddefaultRowCount : int = 4
The default number of rows to display.
ListBase
 InheriteddragImage : IUIComponent
Gets an instance of a class that displays the visuals during a drag and drop operation.
ListBase
 InheriteddragImageOffsets : Point
Gets the offset of the drag image for drag and drop.
ListBase
 InheritedexplicitColumnCount : int = -1
The column count requested by explicitly setting the columnCount property.
ListBase
 InheritedexplicitColumnWidth : Number
The column width requested by explicitly setting the columnWidth.
ListBase
 InheritedexplicitRowCount : int = -1
The row count requested by explicitly setting rowCount.
ListBase
 InheritedexplicitRowHeight : Number
The row height requested by explicitly setting rowHeight.
ListBase
 InheritedfactoryMap : Dictionary
A map of item renderers by factory.
ListBase
 InheritedfreeItemRenderers : Array
A stack of unused item renderers.
ListBase
 InheritedfreeItemRenderersByFactory : Dictionary
A map of free item renderers by factory.
ListBase
 InheritedhighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted.
ListBase
 InheritedhighlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret.
ListBase
 InheritedhighlightUID : String
The UID of the item that is current rolled over or under the caret.
ListBase
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
 InheriteditemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth and rowHeight properties need to be calculated.
ListBase
 InheriteditemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed.
ListBase
 Inheritediterator : IViewCursor
The main IViewCursor used to fetch items from the data provider and pass the items to the renderers.
ListBase
 InheritediteratorValid : Boolean = true
A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed).
ListBase
 InheritedkeySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by a page fault.
ListBase
 InheritedlastDropIndex : int
The most recently calculated index where the drag item should be added to the drop target.
ListBase
 InheritedlastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault.
ListBase
 InheritedlistContent : ListBaseContentHolder
An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics.
ListBase
 InheritedlistContentStyleFilters : Object
The set of styles to pass from the ListBase to the listContent.
ListBase
 InheritedlistItems : Array
An Array of Arrays that contains the itemRenderer instances that render each data provider item.
ListBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedmodifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
ListBase
  monthDisplay : IMonthDisplay
This is a reference to the component that displays the days in a month layout, the day name headers, and the month header.
Calendar
 InheritedoffscreenExtraColumns : int = 0
The target number of extra columns of item renderers used in the layout of the control.
ListBase
 InheritedoffscreenExtraColumnsLeft : int = 0
The number of offscreen columns currently to the left of the leftmost visible column.
ListBase
 InheritedoffscreenExtraColumnsRight : int = 0
The number of offscreen columns currently to the right of the right visible column.
ListBase
 InheritedoffscreenExtraRows : int = 0
The target number of extra rows of item renderers to be used in the layout of the control.
ListBase
 InheritedoffscreenExtraRowsBottom : int = 0
The number of offscreen rows currently below the bottom visible item renderer.
ListBase
 InheritedoffscreenExtraRowsOrColumnsChanged : Boolean = false
A flag indicating that the number of offscreen rows or columns may have changed.
ListBase
 InheritedoffscreenExtraRowsTop : int = 0
The number of offscreen rows currently above the topmost visible row.
ListBase
 InheritedrendererChanged : Boolean = false
A flag that indicates that the renderer changed.
ListBase
 InheritedreservedItemRenderers : Object
A hash map of currently unused item renderers that may be used again in the near future.
ListBase
 InheritedrowInfo : Array
An array of ListRowInfo objects that cache row heights and other tracking information for the rows in listItems.
ListBase
 InheritedrowMap : Object
A hash map of item renderers to their respective ListRowInfo object.
ListBase
 InheritedrunDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated the next time the display is updated.
ListBase
 InheritedrunningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running.
ListBase
 InheritedscrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 InheritedselectedData : Object
A hash table of ListBaseSelectionData objects that track which items are currently selected.
ListBase
 InheritedselectionIndicators : Object
A hash table of selection indicators.
ListBase
 InheritedselectionLayer : Sprite
The layer in listContent where all selection and highlight indicators are drawn.
ListBase
 InheritedselectionTweens : Object
A hash table of selection tweens.
ListBase
 InheritedshowCaret : Boolean
A flag that indicates whether to show caret.
ListBase
 InheritedunconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject to the layout algorithms of the list.
ListBase
 InheritedunscaledHeight : Number
A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
 InheritedverticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
 InheritedvisibleData : Object
A hash table of data provider item renderers currently in view.
ListBase
  weekDisplay : IWeekDisplay
This is a reference to the component that displays the days in a week layout, the day name headers, and the week header.
Calendar
 InheritedwordWrapChanged : Boolean = false
A flag that indicates whether the value of the wordWrap property has changed since the last time the display list was updated.
ListBase
Public Methods
 MethodDefined by
  
Constructor.
Calendar
 Inherited
addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running.
ListBase
 Inherited
calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added to the drop target.
ListBase
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
  
changeDay(value:int = 1):void
A method to change the day based on the specified increment.
Calendar
  
changeMonth(value:int = 1):void
A method to change the month based on the specified increment.
Calendar
  
changeState(nextState:String, date:Date = null):void
This method is a helper function for changing the current state.
Calendar
  
changeWeek(value:int = 1):void
A method to change the week based on the specified increment.
Calendar
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Creates an item renderer given the data object.
ListBase
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
UIComponent
 Inherited
findString(str:String):Boolean
Finds an item in the list based on a String, and moves the selection to it.
ListBase
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
Return the appropriate factory, using the default factory if none specified.
ListBase
 Inherited
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false to indicates whether the effect should play on the target.
ListBase
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Hides the drop indicator under the mouse pointer that indicates that a drag and drop operation is allowed.
ListBase
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Get an item renderer for the index of an item in the data provider, if one exists.
ListBase
 Inherited
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item at colIndex, rowIndex.
ListBase
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
  
This method will force the displayed data to update on the next update if you modify the dataProvider.
Calendar
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Refresh all rows on the next update.
ListBase
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
isItemHighlighted(data:Object):Boolean
Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation).
ListBase
 Inherited
isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item is selectable.
ListBase
 Inherited
isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item is selected.
ListBase
 Inherited
isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer.
ListBase
 Inherited
itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object.
ListBase
 Inherited
Returns the index of the item in the data provider of the item being rendered by this item renderer.
ListBase
 Inherited
itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties.
ListBase
 Inherited
itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties.
ListBase
 Inherited
Returns the item renderer for a given item in the data provider, if there is one.
ListBase
 Inherited
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties.
ListBase
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items.
ListBase
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the maximum width found.
ListBase
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running.
ListBase
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible.
ListBase
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
Displays a drop indicator under the mouse pointer to indicate that a drag and drop operation is allowed and where the items will be dropped.
ListBase
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
unconstrainRenderer(item:Object):void
Called by an UnconstrainItemAction effect as part of a data change effect if the item renderers corresponding to certain data items need to move outside the normal positions of item renderers in the control.
ListBase
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined by
 Inherited
addDragData(ds:Object):void
Adds the selected items to the DragSource object as part of a drag-and-drop operation.
ListBase
 Inherited
Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it.
ListBase
 Inherited
Add a blank row to the beginning of the arrays that store references to the rows.
ListBase
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
Called from the updateDisplayList() method to adjust the size and position of listContent.
ListBase
 Inherited
applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void
Sets up the effect for applying the selection indicator.
ListBase
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
calculateDropIndicatorY(rowCount:Number, rowNum:int):Number
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
ListBase
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the caret indicator into the given Sprite.
ListBase
 Inherited
clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the highlight indicator in the given Sprite.
ListBase
 Inherited
Removes all selection and highlight and caret indicators.
ListBase
 Inherited
clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics depicting the selected state of those items.
ListBase
 Inherited
Empty the visibleData hash table.
ListBase
 Inherited
collectionChangeHandler(event:Event):void
Handles CollectionEvents dispatched from the data provider as the data changes.
ListBase
 Inherited
Calculates the column width and row height and number of rows and columns based on whether properties like columnCount columnWidth, rowHeight and rowCount were explicitly set.
ListBase
 Inherited
Configures the ScrollBars based on the number of rows and columns and viewable rows and columns.
ListBase
 Inherited
copyItemWithUID(item:Object):Object
Makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method.
ListBase
 Inherited
copySelectedItems(useDataField:Boolean = true):Array
Copies the selected items in the order that they were selected.
ListBase
 Inherited
createBorder():void
Creates the border for this component.
ScrollControlBase
 Inherited
Creates objects that are children of this ListBase; in this case, the listContent object that will hold all the item renderers.
ListBase
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
destroyRow(i:int, numCols:int):void
Recycle a row that is no longer needed, and remove its indicators.
ListBase
 Inherited
Handles DragEvent.DRAG_COMPLETE events.
ListBase
 Inherited
Handles DragEvent.DRAG_DROP events.
ListBase
 Inherited
Handles DragEvent.DRAG_ENTER events.
ListBase
 Inherited
Handles DragEvent.DRAG_EXIT events.
ListBase
 Inherited
Handles DragEvent.DRAG_OVER events.
ListBase
 Inherited
dragScroll():void
Interval function that scrolls the list up or down if the mouse goes above or below the list.
ListBase
 Inherited
The default handler for the dragStart event.
ListBase
 Inherited
drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators that it is highlighted, selected, or the caret.
ListBase
 Inherited
Draws any alternating row colors, borders and backgrounds for the rows.
ListBase
 Inherited
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that starts with the character in the eventCode parameter.
ListBase
 Inherited
Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect.
ListBase
 Inherited
Sets selected items based on the caretIndex and anchorIndex properties.
ListBase
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Retrieves an already-created item renderer not currently in use.
ListBase
 Inherited
indexToColumn(index:int):int
The column for the data provider item at the given index.
ListBase
 Inherited
indexToRow(index:int):int
The row for the data provider item at the given index.
ListBase
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
Initiates a data change effect when there have been changes in the data provider.
ListBase
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
isRendererUnconstrained(item:Object):Boolean
Returns true if an item renderer is no longer being positioned by the list's layout algorithm while a data change effect is running as a result of a call to the unconstrainRenderer() method.
ListBase
 Inherited
Returns a Point containing the columnIndex and rowIndex of an item renderer.
ListBase
 Inherited
itemToUID(data:Object):String
Determines the UID for a data provider item.
ListBase
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of this control's borders.
ScrollControlBase
 Inherited
makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area described by left, top, right, bottom.
ListBase
 Inherited
measure():void
Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties.
ListBase
 Inherited
mouseClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDoubleClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDownHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Determines which item renderer is under the mouse.
ListBase
 Inherited
mouseMoveHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOutHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOverHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers.
ListBase
 Inherited
mouseUpHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseWheelHandler(event:MouseEvent):void
Handles mouseWheel events by changing scroll positions.
ListBase
 Inherited
moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators horizontally.
ListBase
 Inherited
moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically.
ListBase
 Inherited
moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void
Move a row vertically, and update the rowInfo record.
ListBase
 Inherited
moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
Moves the selection in a horizontal direction in response to the user selecting items using the left arrow or right arrow keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
Moves the selection in a vertical direction in response to the user selecting items using the up arrow or down arrow Keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
Prepares the data effect for the collection event.
ListBase
 Inherited
Called by the updateDisplayList() method to remove existing item renderers and clean up various caching structures when the renderer changes.
ListBase
 Inherited
Update the keys in the visibleData hash table.
ListBase
 Inherited
removeFromRowArrays(i:int):void
Remove a row from the arrays that store references to the row.
ListBase
 Inherited
removeIndicators(uid:String):void
Cleans up selection highlights and other associated graphics for a given item in the data provider.
ListBase
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
restoreRowArrays(modDeltaPos:int):void
Remove the requested number of rows from the beginning of the arrays that store references to the rows.
ListBase
 Inherited
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
 Inherited
scrollHandler(event:Event):void
Default event handler for the scroll event.
ScrollControlBase
 Inherited
scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
Returns the data provider index for the item at the first visible row and column for the given scroll positions.
ListBase
 Inherited
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
The default failure handler when a seek fails due to a page fault.
ListBase
 Inherited
The default result handler when a seek fails due to a page fault.
ListBase
 Inherited
seekPositionSafely(index:int):Boolean
Seek to a position, and handle an ItemPendingError if necessary.
ListBase
 Inherited
selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided was clicked by the mouse and the keyboard modifiers are in the given state.
ListBase
 Inherited
setRowCount(v:int):void
Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows.
ListBase
 Inherited
setRowHeight(v:Number):void
Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows.
ListBase
 Inherited
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in.
ScrollControlBase
 Inherited
shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void
Shift a row in the arrays that reference rows.
ListBase
 Inherited
sumRowHeights(startRowIdx:int, endRowIdx:int):Number
Determine the height of the requested set of rows.
ListBase
 Inherited
truncateRowArrays(numRows:int):void
Remove all remaining rows from the end of the arrays that store references to the rows.
ListBase
 Inherited
Find an item renderer based on its UID if it is visible.
ListBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Adds or removes item renderers if the number of displayable items changed.
ListBase
 Inherited
updateList():void
Refreshes all rows.
ListBase
Events
 EventSummaryDefined by
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIComponent
   Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction.Calendar
 Inherited Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction.ListBase
 Inherited Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited Dispatched after the view state has changed.UIComponent
 Inherited Dispatched after the currentState property changes, but before the view state changes.UIComponent
 Inherited Dispatched when the data property changes.ListBase
   The CalendarEvent.DATE_CHANGED constant defines the value of the type property of the CalendarEvent object for a dateChanged event, which indicates that the Calendar's displayedYear, displayedDate, or displayedMonth has changed.Calendar
   This event is dispatched when a user presses and releases the main button of the user's pointing device over the list in this dayRenderer.Calendar
   The CalendarDragEvent.DAY_DRAG_COMPLETE constant defines the value of the type property of the event object for a dayDragComplete event.Calendar
   The CalendarDragEvent.DRAG_DROP_DAY constant defines the value of the type property of the event object for a dayDragDrop event.Calendar
   The CalendarDragEvent.DRAG_ENTER_DAY constant defines the value of the type property of the event object for a dayDragEnter event.Calendar
   The CalendarDragEvent.DRAG_EXIT_DAY constant defines the value of the type property of the event object for a dayDragExit event.Calendar
   The CalendarDragEvent.DRAG_OVER_DAY constant defines the value of the type property of the event object for a dayDragOver event.Calendar
   The CalendarDragEvent.DRAG_START_DAY constant defines the value of the type property of the event object for a dayDragStart event.Calendar
 Inherited Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 Inherited Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited Dispatched after an effect ends.UIComponent
 Inherited Dispatched just before an effect starts.UIComponent
 Inherited Dispatched after the component has returned to the root view state.UIComponent
 Inherited Dispatched before the component exits from the root view state.UIComponent
   This event is dispatched when the user clicks the button to expand the Day in the dayRenderer.Calendar
   This event is dispatched when the user clicks the button to expand the Month in the dayRenderer.Calendar
   This event was dispatched when the user clicks the button to expand the Week in the dayRenderer.Calendar
 Inherited Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
   Dispatched when the user clicks on an item in the control.Calendar
 Inherited Dispatched when the user clicks on an item in the control.ListBase
   Dispatched when the user double-clicks on an item in the control.Calendar
 Inherited Dispatched when the user double-clicks on an item in the control.ListBase
   Dispatched when the editedItemPosition property is set and the item can be edited.Calendar
   Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item.Calendar
   Dispatched when an item editing session is ending for any reason.Calendar
   Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard.Calendar
   Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control.Calendar
   Dispatched when the user rolls the mouse pointer out of an item in the control.Calendar
 Inherited Dispatched when the user rolls the mouse pointer out of an item in the control.ListBase
   Dispatched when the user rolls the mouse pointer over an item in the control.Calendar
 Inherited Dispatched when the user rolls the mouse pointer over an item in the control.ListBase
 Inherited Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited Dispatched when the object has moved.UIComponent
   This event is dispatched when the user clicks the button in the dayHeaderRenderer to get to the next day.Calendar
   This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next month.Calendar
   This event is dispatched when the user releases clicks the button to get to the next week in the weekHeaderRenderer.Calendar
   This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next year.Calendar
 Inherited Dispatched at the beginning of the component initialization sequence.UIComponent
   This event is dispatched when the user clicks the button in the dayHeaderRenderer to get to the previous day.Calendar
   This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the previous month.Calendar
   This event is dispatched when the user clicks the button to get to the previous week in the weekHeaderRenderer.Calendar
   This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next year.Calendar
 Inherited Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIComponent
 Inherited Dispatched when the component is resized.UIComponent
 Inherited Dispatched when the content is scrolled.ScrollControlBase
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 StyleDescriptionDefined by
 Inherited Type: Array   Format: Color   CSS Inheritance: yes
The colors to use for the backgrounds of the items in the list.
ListBase
 Inherited Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Background color of a component.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled.
ScrollControlBase
 Inherited Type: Object   Format: File   CSS Inheritance: no
Background image of a component.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Color of the border.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Bounding box sides.
ScrollControlBase
 Inherited Type: Class   CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Bounding box style.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled.
ScrollControlBase
 Inherited Type: Class   CSS Inheritance: no
The skin to use to indicate where a dragged item can be dropped.
ListBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow.
ScrollControlBase
 Inherited Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
ListBase
 Inherited Type: String   CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
ListBase
 Inherited Type: Class   CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 Inherited Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
 Inherited Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
 Inherited Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
The number of pixels between the bottom of the row and the bottom of the renderer in the row.
ListBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
ListBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
ListBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
The number of pixels between the top of the row and the top of the renderer in the row.
ListBase
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
The color of the background of a renderer when the user rolls over it.
ListBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
The color of the background of a renderer when the user selects it.
ListBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
The color of the background of a renderer when the component is disabled.
ListBase
 Inherited Type: Number   Format: Time   CSS Inheritance: no
The duration of the selection effect.
ListBase
 Inherited Type: Function   CSS Inheritance: no
The easingFunction for the selection effect.
ListBase
 Inherited Type: String   CSS Inheritance: no
Direction of the drop shadow.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
The color of the text of a renderer when the user rolls over a it.
ListBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
The color of the text of a renderer when the user selects it.
ListBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Theme color of a component.
UIComponent
 Inherited
top
Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
 Inherited Type: Boolean   CSS Inheritance: no
A flag that controls whether items are highlighted as the mouse rolls over them.
ListBase
 Inherited Type: String   CSS Inheritance: no
The vertical alignment of a renderer in a row.
ListBase
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Style name for vertical scrollbar.
ScrollControlBase
Effects
 EffectDescriptionDefined by
 Inherited Triggering event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering event: hide
Played when the component becomes invisible.
UIComponent
  
monthChangeEffect
Triggering event: dateChangeEvent
This is the effect that will occur on the MonthDisplay class whenever the month changes while in the month state.
Calendar
 Inherited Triggering event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering event: move
Played when the component is moved.
UIComponent
 Inherited Triggering event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined by
  DAY_VIEW : String = "dayView"
[static] This is a constant representing the single day view state of this component.
Calendar
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
  MONTH_VIEW : String = "monthView"
[static] This is a constant representing the month view state of this component.
Calendar
  WEEK_VIEW : String = "weekView"
[static] This is a constant representing the week view state of this component.
Calendar
Property detail
allowMultipleSelectionproperty
allowMultipleSelection:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether you can allow more than one item to be selected at the same time. If true, users can select multiple items. There is no option to disallow discontiguous selection. Standard complex selection options are always in effect (Shift-click, Ctrl-click).

The default value is false.

Implementation
    public function get allowMultipleSelection():Boolean
    public function set allowMultipleSelection(value:Boolean):void
calendarDataproperty 
calendarData:ICalendarDataVO  [read-write]

This is an instance of the CalendarData object, passed into the monthDisplay, dayDisplay, and weekDisplay. It is a value object encompassing many of the Calendar's properties.

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

Implementation
    protected function get calendarData():ICalendarDataVO
    protected function set calendarData(value:ICalendarDataVO):void

See also

com.flextras.calendar.monthDisplay
com.flextras.calendar.weekDisplay
com.flextras.calendar.dayDisplay
calendarMeasurementVOproperty 
calendarMeasurementVO:CalendarMeasurementsVO  [read-write]

This is an instace of the CalendarMeasurementsVO object, passed into the monthDisplay, dayDisplay, and weekDisplay. It is used for sharing sizing for transition states.

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

Implementation
    protected function get calendarMeasurementVO():CalendarMeasurementsVO
    protected function set calendarMeasurementVO(value:CalendarMeasurementsVO):void

See also

dataProviderproperty 
dataProvider:Object  [read-write]

Set of data to be viewed. This property lets you use most types of objects as data providers. If you set the dataProvider property to an Array, it will be converted to an ArrayCollection. If you set the property to an XML object, it will be converted into an XMLListCollection with only one item. If you set the property to an XMLList, it will be converted to an XMLListCollection. If you set the property to an object that implements the IList or ICollectionView interface, the object will be used directly.

As a consequence of the conversions, when you get the dataProvider property, it will always be an ICollectionView, and therefore not necessarily be the type of object you used to you set the property. This behavior is important to understand if you want to modify the data in the data provider: changes to the original data may not be detected, but changes to the ICollectionView object that you get back from the dataProvider property will be detected.

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

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
dataProviderManagerproperty 
dataProviderManager:DataProviderManager  [read-only]

This is an instance of the dataProvider Manager component, which is used to decide which data should be displayed on which day.

Implementation
    protected function get dataProviderManager():DataProviderManager

See also

dataTipFieldproperty 
dataTipField:String  [read-write]

This property is passed through to your dayRenderer.

Name of the field in the data provider items to display as the data tip. By default, the list looks for a property named label on each item and displays it. However, if the data objects do not contain a label property, you can set the dataTipField property to use a different property in the data object. An example would be "FullName" when viewing a set of people's names retrieved from a database.

The default value is null.

Implementation
    public function get dataTipField():String
    public function set dataTipField(value:String):void
dataTipFunctionproperty 
dataTipFunction:Function  [read-write]

This property is passed through to your dayRenderer.

User-supplied function to run on each item to determine its dataTip. By default, the list looks for a property named label on each data provider item and displays it. However, some items do not have a label property nor do they have another property that can be used for displaying in the rows. An example is a data set that has lastName and firstName fields, but you want to display full names. You can supply a dataTipFunction that finds the appropriate fields and return a displayable string. The dataTipFunction is also good for handling formatting and localization.

The dataTipFunction takes a single argument which is the item in the data provider and returns a String:

myDataTipFunction(item:Object):String

The default value is null.

Implementation
    public function get dataTipFunction():Function
    public function set dataTipFunction(value:Function):void
dateFieldproperty 
dateField:String  [read-write]

The is the name of the field in the data provider items that will be used as the date for deciding which day your data provider item should be placed on. By default the Calendar looks for a property named date on each item and displays it on that day. However, if the data objects do not contain a date property, you can set the dateField property to use a different property in the data object.

The default value is "date".

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

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

See also

dateFunctionproperty 
dateFunction:Function  [read-write]

This is a user-supplied function to run on each item to determine its date. By default the Calendar looks for a property named date on each item and displays it on that day. However, some data sets do not have a date property, nor do they have another property that can be used for finding the date. An example of this is an XML document whose dates are located in a custom namepsace on the object.

You can supply a dateFunction that finds the appropriate fields and returns a date Object.

The date function takes a single argument which is the item in the data provider and returns a String.

      myDateFunction(item:Object):Date

The default value is null.

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

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

See also

dayDisplayproperty 
dayDisplay:IDayDisplay  [read-write]

This contains a reference to the component that displays the expanded day and the day header.

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

Implementation
    protected function get dayDisplay():IDayDisplay
    protected function set dayDisplay(value:IDayDisplay):void

See also

dayHeaderRendererproperty 
dayHeaderRenderer:IFactory  [read-write]

This is a custom renderer for the day header. The day header will be the header of the component in the day expanded state.

The default value is ClassFactory(com.flextras.calendar.defaultRenderers.DayHeaderRenderer).

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

Implementation
    public function get dayHeaderRenderer():IFactory
    public function set dayHeaderRenderer(value:IFactory):void

See also

dayHeaderVisibleproperty 
dayHeaderVisible:Boolean  [read-write]

This is used to decide whether the Day Header should be displayed in the day expanded state. A day header is an area to display informationa at the top of the day expanded view state. The header is created by a dayHeaderRenderer, which should be an instance of the IDayHeader interface.

The default value is true.

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

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

See also

dayNameHeaderRendererproperty 
dayNameHeaderRenderer:IFactory  [read-write]

This is a custom renderer for the day name header. It is used to displays the header for each day column in the Calendar component.

The default value is new ClassFactory(com.flextras.calendar.defaultRenderers.dayNameHeaderRenderer).

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

Implementation
    public function get dayNameHeaderRenderer():IFactory
    public function set dayNameHeaderRenderer(value:IFactory):void

See also

dayNameHeadersVisibleproperty 
dayNameHeadersVisible:Boolean  [read-write]

This checks to see if the dayNameHeaders should be displayed in the week and month views. A day header is the text day of the week that can be displayed at the top of each day column. You can control the layout or content displayed by creating a dayNameHeaderRenderer

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

Implementation
    public function get dayNameHeadersVisible():Boolean
    public function set dayNameHeadersVisible(value:Boolean):void

See also

dayNamesproperty 
dayNames:Array  [read-write]

If you set this property to null, it will get the value "dayNames" from the resourceManager .

The default value is [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]..

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

Implementation
    public function get dayNames():Array
    public function set dayNames(value:Array):void
dayRendererproperty 
dayRenderer:IFactory  [read-write]

This is a custom renderer for the days that make up the Calendar Component. . It is used to create days that display in the month view, week view, and day view. If you want to create your own dayRenderer, you should implement IDayRenderer for best results.

The default value is new ClassFactory(com.flextras.calendar.defaultRenderers.DayRenderer).

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

Implementation
    public function get dayRenderer():IFactory
    public function set dayRenderer(value:IFactory):void

See also

displayedDateproperty 
displayedDate:Number  [read-write]

This is used in conjunction with the displayedMonth and displayedYear properties to decide what day to display and where to position it. If you set this, it will ignore the value if it does not represent a day in the current month.

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

Implementation
    public function get displayedDate():Number
    public function set displayedDate(value:Number):void

See also

displayedDateObjectproperty 
displayedDateObject:Date  [read-only]

This property will return the currently selected date. This value is created using the displayedMonth and displayedYear and displayedDate properties.

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

Implementation
    public function get displayedDateObject():Date

See also

displayedMonthproperty 
displayedMonth:Number  [read-write]

Used together with the displayedYear and displayedDate property to decide what days to display and where to position them. Month numbers are zero-based, so January is 0 and December is 11.

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

Implementation
    public function get displayedMonth():Number
    public function set displayedMonth(value:Number):void

See also

displayedYearproperty 
displayedYear:Number  [read-write]

Used together with the displayedMonth and displayedDate property to decide what days to display and where to position them.

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

Implementation
    public function get displayedYear():Number
    public function set displayedYear(value:Number):void

See also

doubleClickEnabledproperty 
doubleClickEnabled:Boolean  [read-write]

This property is passed through to your dayRenderer.

Specifies whether the UIComponent object receives doubleClick events. The default value is false, which means that the UIComponent object does not receive doubleClick events.

The mouseEnabled property must also be set to true, its default value, for the object to receive doubleClick events.

The default value is false.

Implementation
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
dragEnabledproperty 
dragEnabled:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether you can drag items out of this control and drop them on other controls. If true, dragging is enabled for the control. If the dropEnabled property is also true, you can drag items and drop them within this control to reorder the items.

The default value is false.

Implementation
    public function get dragEnabled():Boolean
    public function set dragEnabled(value:Boolean):void
dragMoveEnabledproperty 
dragMoveEnabled:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether items can be moved instead of just copied from the control as part of a drag-and-drop operation. If true, and the dragEnabled property is true, items can be moved. Often the data provider cannot or should not have items removed from it, so a MOVE operation should not be allowed during drag-and-drop.

The default value is false.

Implementation
    public function get dragMoveEnabled():Boolean
    public function set dragMoveEnabled(value:Boolean):void
dropEnabledproperty 
dropEnabled:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether dragged items can be dropped onto the control.

If you set this property to true, the control accepts all data formats, and assumes that the dragged data matches the format of the data in the data provider. If you want to explicitly check the data format of the data being dragged, you must handle one or more of the drag events, such as dragOver, and call the DragEvent's preventDefault() method to customize the way the list class accepts dropped data.

When you set dropEnabled to true, Flex automatically calls the showDropFeedback() and hideDropFeedback() methods to display the drop indicator.

The default value is false.

Implementation
    public function get dropEnabled():Boolean
    public function set dropEnabled(value:Boolean):void
editableproperty 
editable:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether or not the user can edit items in the data provider. If true, the item renderers in the control are editable. The user can click on an item renderer to open an editor.

The default value is false.

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

Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
editedItemRendererproperty 
editedItemRenderer:IListItemRenderer  [read-only]

A reference to the item renderer in the DataGrid control whose item is currently being edited.

From within an event listener for the itemEditBegin and itemEditEnd events, you can access the current value of the item being edited using the editedItemRenderer.data property.

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

Implementation
    public function get editedItemRenderer():IListItemRenderer
editorDataFieldproperty 
editorDataField:String  [read-write]

This property is passed through to your dayRenderer.

The name of the property of the item editor that contains the new data for the list item. For example, the default itemEditor is TextInput, so the default value of the editorDataField property is "text", which specifies the text property of the the TextInput control.

The default value is false.

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

Implementation
    public function get editorDataField():String
    public function set editorDataField(value:String):void
editorHeightOffsetproperty 
editorHeightOffset:Number  [read-write]

This property is passed through to your dayRenderer.

The height of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.

Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

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

Implementation
    public function get editorHeightOffset():Number
    public function set editorHeightOffset(value:Number):void
editorUsesEnterKeyproperty 
editorUsesEnterKey:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether the item editor uses Enter key. If this property is set to true, the item editor uses the Enter key and the List will not look for the Enter key and move the editor in response.

Changing this value while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is false.

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

Implementation
    public function get editorUsesEnterKey():Boolean
    public function set editorUsesEnterKey(value:Boolean):void
editorWidthOffsetproperty 
editorWidthOffset:Number  [read-write]

This property is passed through to your dayRenderer.

The width of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.

Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

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

Implementation
    public function get editorWidthOffset():Number
    public function set editorWidthOffset(value:Number):void
editorXOffsetproperty 
editorXOffset:Number  [read-write]

This property is passed through to your dayRenderer.

The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.

Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

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

Implementation
    public function get editorXOffset():Number
    public function set editorXOffset(value:Number):void
editorYOffsetproperty 
editorYOffset:Number  [read-write]

This property is passed through to your dayRenderer.

The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.

Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.

The default value is 0.

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

Implementation
    public function get editorYOffset():Number
    public function set editorYOffset(value:Number):void
firstDayOfWeekproperty 
firstDayOfWeek:int  [read-write]

The default value is 0 (Sunday).

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

Implementation
    public function get firstDayOfWeek():int
    public function set firstDayOfWeek(value:int):void
iconFieldproperty 
iconField:String  [read-write]

This property is passed through to your dayRenderer.

The name of the field in the data provider object that determines what to display as the icon. By default, the list class does not try to display icons with the text in the rows. However, by specifying an icon field, you can specify a graphic that is created and displayed as an icon in the row. This property is ignored by DataGrid.

The renderers will look in the data provider object for a property of the name supplied as the iconField. If the value of the property is a Class, it will instantiate that class and expect it to be an instance of an IFlexDisplayObject. If the value of the property is a String, it will look to see if a Class exists with that name in the application, and if it can't find one, it will also look for a property on the document with that name and expect that property to map to a Class.

The default value is null.

Implementation
    public function get iconField():String
    public function set iconField(value:String):void
iconFunctionproperty 
iconFunction:Function  [read-write]

This property is passed through to your dayRenderer.

A user-supplied function to run on each item to determine its icon. By default the list does not try to display icons with the text in the rows. However, by specifying an icon function, you can specify a Class for a graphic that will be created and displayed as an icon in the row. This property is ignored by DataGrid.

The iconFunction takes a single argument which is the item in the data provider and returns a Class.

iconFunction(item:Object):Class

The default value is null.

Implementation
    public function get iconFunction():Function
    public function set iconFunction(value:Function):void
imeModeproperty 
imeMode:String  [read-write]

This property is passed through to your dayRenderer.

Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets focus, and sets it back to the previous value when the control loses focus.

The flash.system.IMEConversionMode class defines constants for the valid values for this property. You can also specify null to specify no IME.

The default value is null.

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

Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void
itemEditorproperty 
itemEditor:IFactory  [read-write]

This property is passed through to your dayRenderer.

The class factory for the item editor to use for the control, if the editable property is set to true.

The default value is new ClassFactory(mx.controls.TextInput).

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

Implementation
    public function get itemEditor():IFactory
    public function set itemEditor(value:IFactory):void
itemEditorInstanceproperty 
itemEditorInstance:IListItemRenderer  [read-only]

A reference to the currently active instance of the item editor, if it exists.

To access the item editor instance and the new item value when an item is being edited, you use the itemEditorInstance property. The itemEditorInstance property is not valid until after the event listener for the itemEditBegin event executes. Therefore, you typically only access the itemEditorInstance property from within the event listener for the itemEditEnd event.

The itemEditor property defines the class of the item editor and, therefore, the data type of the item editor instance.

You do not set this property in MXML.

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

Implementation
    public function get itemEditorInstance():IListItemRenderer
itemRendererproperty 
itemRenderer:IFactory  [read-write]

This property is passed through to your dayRenderer.

The custom item renderer for the control. You can specify a drop-in, inline, or custom item renderer.

The default item renderer depends on the component class. The TileList and HorizontalList class use TileListItemRenderer, The List class uses ListItemRenderer. The DataGrid class uses DataGridItemRenderer from DataGridColumn.

The default value is new ClassFactory(mx.controls.Label).

Implementation
    public function get itemRenderer():IFactory
    public function set itemRenderer(value:IFactory):void
labelFieldproperty 
labelField:String  [read-write]

This property is passed through to your dayRenderer.

The name of the field in the data provider items to display as the label. By default the list looks for a property named label on each item and displays it. However, if the data objects do not contain a label property, you can set the labelField property to use a different property in the data object. An example would be "FullName" when viewing a set of people names fetched from a database.

The default value is "label".

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

Implementation
    public function get labelField():String
    public function set labelField(value:String):void
labelFunctionproperty 
labelFunction:Function  [read-write]

This property is passed through to your dayRenderer.

A user-supplied function to run on each item to determine its label. By default, the list looks for a property named label on each data provider item and displays it. However, some data sets do not have a label property nor do they have another property that can be used for displaying. An example is a data set that has lastName and firstName fields but you want to display full names.

You can supply a labelFunction that finds the appropriate fields and returns a displayable string. The labelFunction is also good for handling formatting and localization.

For most components, the label function takes a single argument which is the item in the data provider and returns a String.

      myLabelFunction(item:Object):String

The method signature for the DataGrid and DataGridColumn classes is:

      myLabelFunction(item:Object, column:DataGridColumn):String

where item contains the DataGrid item object, and column specifies the DataGrid column.

The default value is null.

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
lastDayOfWeekproperty 
lastDayOfWeek:int  [read-only]

Number representing the last day of the week to display in the last column of the calendar control.

The default value is 6 (Saturday).

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

Implementation
    public function get lastDayOfWeek():int

See also

leadingTrailingDaysVisibleproperty 
leadingTrailingDaysVisible:Boolean  [read-write]

This is used to determine whether the leading and trailing days should be displayed in the month state. Leading days are days from the previous month that are included in the week which the current month starts on. Trailing days are days in the next month that are included in the week which the current month ends on.

The default value is false.

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

Implementation
    public function get leadingTrailingDaysVisible():Boolean
    public function set leadingTrailingDaysVisible(value:Boolean):void
monthDisplayproperty 
monthDisplay:IMonthDisplay  [read-write]

This is a reference to the component that displays the days in a month layout, the day name headers, and the month header.

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

Implementation
    protected function get monthDisplay():IMonthDisplay
    protected function set monthDisplay(value:IMonthDisplay):void

See also

monthHeaderRendererproperty 
monthHeaderRenderer:IFactory  [read-write]

This is a custom renderer for the month header. A month header is an area to display information above the month, such as next and previous buttons the name of the month.

The default value is new ClassFactory(com.flextras.calendar.defaultRenderers.MonthHeaderRenderer).

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

Implementation
    public function get monthHeaderRenderer():IFactory
    public function set monthHeaderRenderer(value:IFactory):void

See also

monthHeaderVisibleproperty 
monthHeaderVisible:Boolean  [read-write]

This is used to determine whether the Month Headers should be displayed in the month state. A month header is an area to display information above the month, such as next and previous buttons the name of the month. The header is created by a monthHeaderRenderer, which should be an instance of the IMonthHeader interface.

The default value is true.

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

Implementation
    public function get monthHeaderVisible():Boolean
    public function set monthHeaderVisible(value:Boolean):void

See also

monthNamesproperty 
monthNames:Array  [read-write]

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

Implementation
    public function get monthNames():Array
    public function set monthNames(value:Array):void
monthSymbolproperty 
monthSymbol:String  [read-write]

The default value is "".

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

Implementation
    public function get monthSymbol():String
    public function set monthSymbol(value:String):void
nullItemRendererproperty 
nullItemRenderer:IFactory  [read-write]

This property is passed through to your dayRenderer.

The custom item renderer for the control. You can specify a drop-in, inline, or custom item renderer.

The default item renderer depends on the component class. The TileList and HorizontalList class use TileListItemRenderer, The List class uses ListItemRenderer. The DataGrid class uses DataGridItemRenderer from DataGridColumn.

The default value is new ClassFactory(mx.controls.Label).

Implementation
    public function get nullItemRenderer():IFactory
    public function set nullItemRenderer(value:IFactory):void
objectArrayForTransitionsproperty 
objectArrayForTransitions:Array  [read-only]

This is an array of objects that may have property changes during state changes. This interface was created for the Flextras Calendar component; and the state changes would be between Calendar.MONTH_VIEW, Calendar.DAY_VIEW, and Calendar.WEEK_VIEW. Objects in this array may change size properties, such as height and width, and position such as x and y. They may also be added or removed from their parent container.

If you want to run special effects for children that are removed or added you can do so using effect filters.

For example if you switch from Calendar.MONTH_VIEW to Calendar.DAY_VIEW the MonthDisplay class instance--which contains the month's days, day name headers, and a header will be removed. The expanded day will be moved and resized to make it larger, and the dayHeader will be added. To move from the Calendar.DAY_VIEW to Calendar.MONTH_VIEW the dayHeader is removed, the expanded day will be moved and resized to make it smaller and the monthHeader and day name headers will be added.

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

Implementation
    public function get objectArrayForTransitions():Array
offscreenExtraRowsOrColumnsproperty 
offscreenExtraRowsOrColumns:int  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether the list shows selected items as selected. If true, the control supports selection. The Menu class, which subclasses ListBase, sets this property to false by default, because it doesn't show the chosen menu item as selected.

The default value is 0.

Implementation
    public function get offscreenExtraRowsOrColumns():int
    public function set offscreenExtraRowsOrColumns(value:int):void
rendererIsEditorproperty 
rendererIsEditor:Boolean  [read-write]

This property is passed through to your dayRenderer.

Specifies whether the item renderer is also an item editor. If this property is true, Flex ignores the itemEditor property.

The default value is false.

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

Implementation
    public function get rendererIsEditor():Boolean
    public function set rendererIsEditor(value:Boolean):void
selectableproperty 
selectable:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether the list shows selected items as selected. If true, the control supports selection. The Menu class, which subclasses ListBase, sets this property to false by default, because it doesn't show the chosen menu item as selected.

The default value is true.

Implementation
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void
showDataTipsproperty 
showDataTips:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether dataTips are displayed for text in the rows. If true, dataTips are displayed. DataTips are tooltips designed to show the text that is too long for the row. If you set a dataTipFunction, dataTips are shown regardless of whether the text is too long for the row.

The default value is false.

Implementation
    public function get showDataTips():Boolean
    public function set showDataTips(value:Boolean):void
weekDisplayproperty 
weekDisplay:IWeekDisplay  [read-write]

This is a reference to the component that displays the days in a week layout, the day name headers, and the week header.

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

Implementation
    protected function get weekDisplay():IWeekDisplay
    protected function set weekDisplay(value:IWeekDisplay):void

See also

weekHeaderRendererproperty 
weekHeaderRenderer:IFactory  [read-write]

This is a custom renderer for the week header. A week header is an area to display information above the week, such as next and previous buttons or the name of the month.

The default value is ClassFactory(com.flextras.calendar.defaultRenderers.WeekHeaderRenderer).

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

Implementation
    public function get weekHeaderRenderer():IFactory
    public function set weekHeaderRenderer(value:IFactory):void

See also

weekHeaderVisibleproperty 
weekHeaderVisible:Boolean  [read-write]

This is used to determine whether the Week Header should be displayed in the week state. A week header is an area to display information above the week, such as next and previous buttons the name of the month and the year. The header is created by a weekHeaderRenderer, which should be an instance of the IWeekHeader interface.

The default value is true.

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

Implementation
    public function get weekHeaderVisible():Boolean
    public function set weekHeaderVisible(value:Boolean):void

See also

wordWrapproperty 
wordWrap:Boolean  [read-write]

This property is passed through to your dayRenderer.

A flag that indicates whether text in the row should be word wrapped. If true, enables word wrapping for text in the rows. Only takes effect if the variableRowHeight property is also true.

The default value is false.

Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
Constructor detail
Calendar()constructor
public function Calendar()

Constructor.

Method detail
changeDay()method
public function changeDay(value:int = 1):void

A method to change the day based on the specified increment. Use a negative value to go back in time or a positive value to go forward. Only has an effect if in the DAY_VIEW state.

Parameters
value:int (default = 1) — The increment value used to change the day; the default is 1.

See also

changeMonth()method 
public function changeMonth(value:int = 1):void

A method to change the month based on the specified increment. You can use a negative value to go back in time or a positive value to go forward. Only has an effect if in the MONTH_VIEW state.

Parameters
value:int (default = 1) — The increment value used to change the month; the default is 1.

See also

changeState()method 
public function changeState(nextState:String, date:Date = null):void

This method is a helper function for changing the current state. It allows you to specify a date object.

Parameters
nextState:String — This argument specifies the state you want to change to. Most likely this value will be Calendar.MONTH_VIEW, Calendar.WEEK_VIEW, or Calendar.DAY_VIEW.
 
date:Date (default = null) — This argument specifies the date to change the component to before the state change. If not specified, the current displayedDatObject won't be changed.
changeWeek()method 
public function changeWeek(value:int = 1):void

A method to change the week based on the specified increment. This increments the displayed day by 7 days. You can use a negative value to go back in time or a positive value to go forward. Only has an effect if in the WEEK_VIEW state.

Parameters
value:int (default = 1) — The increment value used to change the week; the default is 1.

See also

invalidateCalendar()method 
public function invalidateCalendar():void

This method will force the displayed data to update on the next update if you modify the dataProvider.

Event detail
changeevent 
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.CHANGE

Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction.

The CalendarEvent.CHANGE constant defines the value of the type property of the CalendarEvent object for a change event, which indicates that selection changed as a result of user interaction.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.CHANGE
dateChangedevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.DATE_CHANGED

The CalendarEvent.DATE_CHANGED constant defines the value of the type property of the CalendarEvent object for a dateChanged event, which indicates that the Calendar's displayedYear, displayedDate, or displayedMonth has changed.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDateThis is the current date of the Calendar.
oldDateThis is the date of the Calendar before the date change.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.DATE_CHANGED
dayClickevent  
Event object type: com.flextras.calendar.CalendarMouseEvent
CalendarMouseEvent.type property = com.flextras.calendar.CalendarMouseEvent.CLICK_DAY

This event is dispatched when a user presses and releases the main button of the user's pointing device over the list in this dayRenderer. This event mirrors MouseEvent.CLICK

The CalendarMouseEvent.CLICK_DAY constant defines the value of the type property of the CalendarMouseEvent object for a dayClick event, which indicates that the user clicked in the DayRenderer of a calendar class.

Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. For a click event to occur, it must always follow this series of events in the order of occurrence: mouseDown event, then mouseUp. The target object must be identical for both of these events; otherwise the click event does not occur. Any number of other mouse events can occur at any time between the mouseDown or mouseUp events; the click event still occurs.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original MouseEvent.
itemRendererThis is the itemRenderer that the mouse was over when it was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial MouseEvent. If using the default DayRenderer this will be a List.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
mouseEventThis is a reference to the original MouseEvent that started the event chain.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
selectedItemsThis is the items from the dataProvider that are now selected based on the click.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarMouseEvent.CLICK_DAY
dayDragCompleteevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_COMPLETE_DAY

The CalendarDragEvent.DAY_DRAG_COMPLETE constant defines the value of the type property of the event object for a dayDragComplete event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dayDragDropevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_DROP_DAY

The CalendarDragEvent.DRAG_DROP_DAY constant defines the value of the type property of the event object for a dayDragDrop event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dayDragEnterevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_ENTER_DAY

The CalendarDragEvent.DRAG_ENTER_DAY constant defines the value of the type property of the event object for a dayDragEnter event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event, which is always DragManager.MOVE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dayDragExitevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_EXIT_DAY

The CalendarDragEvent.DRAG_EXIT_DAY constant defines the value of the type property of the event object for a dayDragExit event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dayDragOverevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_OVER_DAY

The CalendarDragEvent.DRAG_OVER_DAY constant defines the value of the type property of the event object for a dayDragOver event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dayDragStartevent  
Event object type: com.flextras.calendar.CalendarDragEvent
CalendarDragEvent.type property = com.flextras.calendar.CalendarDragEvent.DRAG_START_DAY

The CalendarDragEvent.DRAG_START_DAY constant defines the value of the type property of the event object for a dayDragStart event.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original DragEvent.
dragEventThis is a reference to the original DragEvent that started the event chain.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
listThis is a reference to the list based class in the dayRender that triggered the initial DragEvent. If using the default DayRenderer this will be a List.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
expandDayevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.EXPAND_DAY

This event is dispatched when the user clicks the button to expand the Day in the dayRenderer.

The CalendarChangeEvent.EXPAND_DAY constant defines the value of the type property of the CalendarChangeEvent object for a expandDay event, which indicates that the user requested the component change to the day state. By default this is dispatched by clicking a button in the dayRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.EXPAND_DAY
expandMonthevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.EXPAND_MONTH

This event is dispatched when the user clicks the button to expand the Month in the dayRenderer.

The CalendarChangeEvent.EXPAND_MONTH constant defines the value of the type property of the CalendarChangeEvent object for a expandMonth event, which indicates that the user requested the component change to the month state. By default this is dispatched by clicking a button in the dayRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.EXPAND_MONTH
expandWeekevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.EXPAND_WEEK

This event was dispatched when the user clicks the button to expand the Week in the dayRenderer.

The CalendarChangeEvent.EXPAND_WEEK constant defines the value of the type property of the CalendarChangeEvent object for a expandWeek event, which indicates that the user requested the component change to the week state. By default this is dispatched by clicking a button in the dayRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.EXPAND_WEEK
itemClickevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_CLICK

Dispatched when the user clicks on an item in the control.

The CalendarEvent.ITEM_CLICK constant defines the value of the type property of the CalendarEvent object for an itemClick event, which indicates that the user clicked the mouse over a visual item in the control.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_CLICK
itemDoubleClickevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_DOUBLE_CLICK

Dispatched when the user double-clicks on an item in the control.

The CalendarEvent.ITEM_DOUBLE_CLICK constant defines the value of the type property of the ListEvent object for an itemDoubleClick event, which indicates that the user double clicked the mouse over a visual item in the control.

To receive itemDoubleClick events, you must set the component's doubleClickEnabled property to true.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_DOUBLE_CLICK
itemEditBeginevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_EDIT_BEGIN

Dispatched when the editedItemPosition property is set and the item can be edited.

The CalendarEvent.ITEM_EDIT_BEGIN constant defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The default listener for this event performs the following actions:

You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.

You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:

  1. Call preventDefault() to stop Flex from calling the createItemEditor() method as part of the default event listener.
  2. Set the list.itemEditor property to the appropriate editor.
  3. Call the list.createItemEditor() method.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original ListEvent.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_EDIT_BEGIN
itemEditBeginningevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_EDIT_BEGINNING

Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item.

The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of the type property of the event object for a itemEditBeginning event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item. This happens in a ListBase class in the dayRenderer.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The default listener for this event sets the List.editedItemPosition property to the item that has focus, which starts the item editing session.

You typically write your own event listener for this event to disallow editing of a specific item or items. Calling the preventDefault() method from within your own event listener for this event prevents the default listener from executing.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original ListEvent.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_EDIT_BEGINNING
itemEditEndevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_EDIT_END

Dispatched when an item editing session is ending for any reason.

The ListEvent.ITEM_EDIT_END constant defines the value of the type property of the ListEvent object for a itemEditEnd event, which indicates that an edit session is ending.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:

You typically write an event listener for this event to perform the following actions:

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original ListEvent.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_EDIT_END
itemFocusInevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_FOCUS_IN

Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. Only dispatched if the list item is editable.

The CalendarEvent.ITEM_FOCUS_IN constant defines the value of the type property of the CalendarEvent object for an itemFocusIn event, which indicates that an item has received the focus.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_FOCUS_IN
itemFocusOutevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_FOCUS_OUT

Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. Only dispatched if the list item is editable.

The CalendarEvent.ITEM_FOCUS_OUT constant defines the value of the type property of the CalendarEvent object for an itemFocusOut event, which indicates that an item has lost the focus.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_FOCUS_OUT
itemRollOutevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_ROLL_OUT

Dispatched when the user rolls the mouse pointer out of an item in the control.

The CalendarEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_ROLL_OUT
itemRollOverevent  
Event object type: com.flextras.calendar.CalendarEvent
CalendarEvent.type property = com.flextras.calendar.CalendarEvent.ITEM_ROLL_OVER

Dispatched when the user rolls the mouse pointer over an item in the control.

The CalendarEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.

This is a wrapper to the events dispatched by the dayRenderer's of the Calendar class.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayRendererThis is a reference to the dayRenderer that triggered the original event.
itemRendererThe item renderer that was clicked.
listThis is a reference to the list based class in the dayRender that triggered the initial ListEvent. If using the default DayRenderer this will be a List.
listEventThis is a reference to the original ListEvent that started the event chain.
newDatenull
oldDatenull
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarEvent.ITEM_ROLL_OVER
nextDayevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.NEXT_DAY

This event is dispatched when the user clicks the button in the dayHeaderRenderer to get to the next day.

The CalendarChangeEvent.NEXT_DAY constant defines the value of the type property of the CalendarChangeEvent object for a nextDay event, which indicates that the user requested that the Calendar component’s displayedDate value increment. By default this value is dispatched from the dayHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.NEXT_DAY
nextMonthevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.NEXT_MONTH

This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next month.

The CalendarChangeEvent.NEXT_DAY constant defines the value of the type property of the CalendarChangeEvent object for a nextMonth event, which indicates that the user requested that the Calendar component’s displayedMonth value increment. By default this value is dispatched from the monthHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.NEXT_MONTH
nextWeekevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.NEXT_WEEK

This event is dispatched when the user releases clicks the button to get to the next week in the weekHeaderRenderer.

The CalendarChangeEvent.NEXT_WEEK constant defines the value of the type property of the CalendarChangeEvent object for a nextWeek event, which indicates that the user requested that the Calendar component’s displayedDate value increment by seven days. By default this value is dispatched from the weekHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.NEXT_WEEK
nextYearevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.NEXT_YEAR

This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next year.

The CalendarChangeEvent.NEXT_YEAR constant defines the value of the type property of the CalendarChangeEvent object for a nextYear event, which indicates that the user requested that the Calendar component’s displayedYear value increment. By default this value is dispatched from the monthHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.NEXT_YEAR
previousDayevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.PREVIOUS_DAY

This event is dispatched when the user clicks the button in the dayHeaderRenderer to get to the previous day.

The CalendarChangeEvent. PREVIOUS_DAY constant defines the value of the type property of the CalendarChangeEvent object for a previousDay event, which indicates that the user requested that the Calendar component’s displayedDate value decrement. By default this value is dispatched from the dayHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.PREVIOUS_DAY
previousMonthevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.PREVIOUS_MONTH

This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the previous month.

The CalendarChangeEvent. PREVIOUS_DAY constant defines the value of the type property of the CalendarChangeEvent object for a previousMonth event, which indicates that the user requested that the Calendar component’s displayedMonth value decrement. By default this value is dispatched from the monthHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.PREVIOUS_MONTH
previousWeekevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.PREVIOUS_WEEK

This event is dispatched when the user clicks the button to get to the previous week in the weekHeaderRenderer.

The CalendarChangeEvent. PREVIOUS_WEEK constant defines the value of the type property of the CalendarChangeEvent object for a previousWeek event, which indicates that the user requested that the Calendar component’s displayedDate value decrement by seven days. By default this value is dispatched from the weekHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.PREVIOUS_WEEK
previousYearevent  
Event object type: com.flextras.calendar.CalendarChangeEvent
CalendarChangeEvent.type property = com.flextras.calendar.CalendarChangeEvent.PREVIOUS_YEAR

This event is dispatched when the user clicks the button in the monthHeaderRenderer to get to the next year.

The CalendarChangeEvent.NEXT_YEAR constant defines the value of the type property of the CalendarChangeEvent object for a previousYear event, which indicates that the user requested that the Calendar component’s displayedYear value decrement. By default this value is dispatched from the monthHeaderRenderer.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dayToExpandThis is a reference to the dayRenderer that fired off the original event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TypeCalendarChangeEvent.PREVIOUS_YEAR
Constant detail
DAY_VIEWconstant
public static const DAY_VIEW:String = "dayView"

This is a constant representing the single day view state of this component. In this state the Calendar is only displaying a single day.

See also

MONTH_VIEWconstant 
public static const MONTH_VIEW:String = "monthView"

This is a constant representing the month view state of this component. In this state, the calendar displays a single month. This is the default state.

See also

WEEK_VIEWconstant 
public static const WEEK_VIEW:String = "weekView"

This is a constant representing the week view state of this component. In this state, the calendar displays a single week, or seven consecutive days.

See also