Packagecom.flexcalendar.components.calendar.displayClasses.headers
Classpublic class DayViewHeader
InheritanceDayViewHeader Inheritance mx.core.UIComponent
Implements IRenderersContainer, IDateRangeAware

Class displaying headers of each day. This is also place where long events are displayed



Public Properties
 PropertyDefined By
  startDate : Date
Start date of the displayed labels.
DayViewHeader
  visibleItemDetails : Array
[write-only] Array of visible item details - sorted by start date
DayViewHeader
Protected Properties
 PropertyDefined By
  itemRenderersFactory : ClassFactory
Class factory for creating item renderers
DayViewHeader
Public Methods
 MethodDefined By
  
DayViewHeader(context:ICalendarContext, itemRenderersFactory:ClassFactory)
Create DaysHeader instance
DayViewHeader
  
deleteItemDetails(deletedItemDetails:ItemDetails):void
Delete item details.
DayViewHeader
  
endDrag():void
Called at the end of the drag
DayViewHeader
  
Return height of this component, based on styles and maximum count of long events per day.
DayViewHeader
  
layoutMovingItemDetails(movingRenderer:ICalendarItemRenderer, startGlobalPosition:Point, currentGlobalPosition:Point):void
Layout item renderer when item renderer is moved
DayViewHeader
  
pointToDate(point:Point):Date
Convert local point to date,
DayViewHeader
  
removeRenderers(itemDetails:ItemDetails):void
Remove all renderers for item details.
DayViewHeader
  
Set visible range
DayViewHeader
  
updateItemDetails(updatedItemDetails:ItemDetails):void
Update or create item details.
DayViewHeader
Protected Methods
 MethodDefined By
  
[override]
DayViewHeader
Events
 Event Summary Defined By
  Dispatched when user clicks on the free calendar spaceDayViewHeader
Styles
 Style Description Defined By
  
backgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color for header The default value is 0xe3e9ff;.
DayViewHeader
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label. Default values are inherited from default css, with exceptions: HourLabels: 0x767477 DayViewHeader: 0x3214cf CalendarItemRenderer: 0xFFFFFF DaysGrid: 0x666666
DayViewHeader
  
dateFormatterClass
Type: Class CSS Inheritance: no
Formatter for names displayed in the header If defined, this formatter is used instead of DateFormatter. The default value is undefined.
DayViewHeader
  
disabledColor
Type: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled. Default values are inherited from default css
DayViewHeader
  
fontAntiAliasType
Type: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED). Default values are inherited from default css
DayViewHeader
  
fontFamily
Type: String CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. Default values are inherited from default css, with exceptions: HourLabels: "Arial" DayViewHeader: "Arial" CalendarItemRenderer: "Arial"
DayViewHeader
  
fontGridFitType
Type: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL). Default values are inherited from default css
DayViewHeader
  
fontSharpness
Type: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400. Default values are inherited from default css, with exceptions:
DayViewHeader
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels. Default values are inherited from default css, with exceptions: HourLabels: 11 DayViewHeader: 13; CalendarItemRenderer: 11 DaysGrid: 11
DayViewHeader
  
fontStyle
Type: String CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". Default values are inherited from default css, with exceptions: HourLabels: "normal" DayViewHeader: "normal"
DayViewHeader
  
fontThickness
Type: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200. Default values are inherited from default css
DayViewHeader
  
fontWeight
Type: String CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. Default values are inherited from default css, with exceptions: HourLabels: normal DayViewHeader: normal
DayViewHeader
  
kerning
Type: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. Default values are inherited from default css
DayViewHeader
  
labelFormat
Type: String CSS Inheritance: no
Formatting style for labels. If set, this value overrides localized value. The default value is undefined.
DayViewHeader
  
labelHeight
Type: uint Format: Length CSS Inheritance: no
Height of label with day date. Changing this value will affect header height; The default value is 18;.
DayViewHeader
  
leftPadding
Type: Number Format: Length CSS Inheritance: no
Left padding of the component, where only background is drawn. As default this is equal to HourLabels width The default value is 40;.
DayViewHeader
  
letterSpacing
Type: Number CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. Default values are inherited from default css
DayViewHeader
  
lineColor
Type: uint Format: Color CSS Inheritance: no
Color of grid lines The default value is 0xdddddd;.
DayViewHeader
  
lineThickness
Type: Number Format: Length CSS Inheritance: no
Grid line thickness The default value is 1;.
DayViewHeader
  
linkLabels
Type: Boolean CSS Inheritance: no
Determine if labels should be links to concrete days The default value is true.
DayViewHeader
  
longEventBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color for header's long event area The default value is 0xFFFFFF;.
DayViewHeader
  
longEventHighlightedBackgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color for header's long event area The default value is 0xfff7d7;.
DayViewHeader
  
longItemRendererHeight
Type: uint Format: Length CSS Inheritance: no
Height of item renderer for long items and bottom padding under renderers. Changing this value will affect header height. The default value is 18;.
DayViewHeader
  
movingItemAlpha
Type: Number CSS Inheritance: no
Moving renderer alpha. The default value is 0.8.
DayViewHeader
  
rightPadding
Type: Number Format: Length CSS Inheritance: no
Right padding of the component, where only background is drawn As default this is equal to ScrollBar width The default value is 16;.
DayViewHeader
  
textAlign
Type: String CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center". Default values are inherited from default css, with exceptions: DayViewHeader: "left"
DayViewHeader
  
textDecoration
Type: String CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". Default values are inherited from default css
DayViewHeader
  
textIndent
Type: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. Default values are inherited from default css
DayViewHeader
Property Detail
itemRenderersFactoryproperty
protected var itemRenderersFactory:ClassFactory

Class factory for creating item renderers

startDateproperty 
startDate:Date

Start date of the displayed labels.

The default value is new Date();.

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


Implementation
    public function get startDate():Date
    public function set startDate(value:Date):void
visibleItemDetailsproperty 
visibleItemDetails:Array  [write-only]

Array of visible item details - sorted by start date


Implementation
    public function set visibleItemDetails(value:Array):void
Constructor Detail
DayViewHeader()Constructor
public function DayViewHeader(context:ICalendarContext, itemRenderersFactory:ClassFactory)

Create DaysHeader instance

Parameters
context:ICalendarContext
 
itemRenderersFactory:ClassFactory
Method Detail
commitProperties()method
override protected function commitProperties():void

deleteItemDetails()method 
public function deleteItemDetails(deletedItemDetails:ItemDetails):void

Delete item details.

Parameters

deletedItemDetails:ItemDetails — item to delete.

endDrag()method 
public function endDrag():void

Called at the end of the drag

getComputedComponentHeight()method 
public function getComputedComponentHeight():Number

Return height of this component, based on styles and maximum count of long events per day.

Returns
Number
layoutMovingItemDetails()method 
public function layoutMovingItemDetails(movingRenderer:ICalendarItemRenderer, startGlobalPosition:Point, currentGlobalPosition:Point):void

Layout item renderer when item renderer is moved

Parameters

movingRenderer:ICalendarItemRenderer — item renderer to layout
 
startGlobalPosition:Point — start click position, in global coordinates
 
currentGlobalPosition:Point — current mouse positon, in global coordinates

pointToDate()method 
public function pointToDate(point:Point):Date

Convert local point to date,

Parameters

point:Point — requested point, in local coordinates

Returns
Date — date object, computed based on point location
removeRenderers()method 
public function removeRenderers(itemDetails:ItemDetails):void

Remove all renderers for item details.

Parameters

itemDetails:ItemDetails — item which renderers will be removed.

setVisibleRange()method 
public function setVisibleRange(value:DateRange):void

Set visible range

Parameters

value:DateRange — visible range

updateItemDetails()method 
public function updateItemDetails(updatedItemDetails:ItemDetails):void

Update or create item details. Move renderers in new place and redraw layout.

Parameters

updatedItemDetails:ItemDetails — item to update.

Event Detail
calendarMouseClick Event
Event Object Type: com.flexcalendar.components.calendar.events.CalendarMouseEvent

Dispatched when user clicks on the free calendar space