Packagecom.flexcalendar.components.calendar.displayClasses.renderers.defaults
Classpublic class BaseCalendarItemRenderer
InheritanceBaseCalendarItemRenderer Inheritance mx.core.UIComponent
Implements ICalendarItemRenderer
Subclasses DefaultCalendarDayViewAvailableSpaceRenderer, DefaultCalendarDayViewItemRenderer, DefaultCalendarDayViewLongItemRenderer, DefaultCalendarDayViewUnavailableSpaceRenderer, DefaultCalendarMonthViewItemRenderer, DefaultCalendarMonthViewLongItemRenderer

Base for default item renderers for FlexCalendar. This class should not be used directly, but extended to create concrete item renderers. In addition to standard styles, each BaseCalendarItemRenderer instance has set .calendarItemRendererSummary style set at summary label. Also, some instances can set .calendarItemRendererDuration style for the duration label.



Public Properties
 PropertyDefined By
  itemDetails : ItemDetails
Calendar item associated with this renderer.
BaseCalendarItemRenderer
Protected Properties
 PropertyDefined By
  _backgroundAlpha : Number
Holds read style value
BaseCalendarItemRenderer
  _backgroundColor : uint
Holds read style value
BaseCalendarItemRenderer
  _borderAlpha : Number
Holds read style value
BaseCalendarItemRenderer
  _borderColor : uint
Holds read style value
BaseCalendarItemRenderer
  _borderThickness : Number
Holds read style value
BaseCalendarItemRenderer
  _calendarContext : ICalendarContext
Calendar context injected by factory
BaseCalendarItemRenderer
  _cornerRadius : Number
Holds read style value
BaseCalendarItemRenderer
  _itemDetails : ItemDetails
Internal calendar item object, accessed by getter/setter
BaseCalendarItemRenderer
  _margin : Number
Margin of element.
BaseCalendarItemRenderer
  _rendererAlpha : Number
Holds read style value
BaseCalendarItemRenderer
  summaryLabel : Text
Summary label
BaseCalendarItemRenderer
  _textColor : Number
Holds read style value
BaseCalendarItemRenderer
Public Methods
 MethodDefined By
  
As this is base class, it should not be created directly.
BaseCalendarItemRenderer
  
getPositionFunction(x:Number, y:Number):int
Implementation of ICalendarRenderer interface.
BaseCalendarItemRenderer
  
BaseCalendarItemRenderer
Protected Methods
 MethodDefined By
  
Create summary label
BaseCalendarItemRenderer
  
BaseCalendarItemRenderer
  
Read component style values
BaseCalendarItemRenderer
Styles
 Style Description Defined By
  
backgroundAlpha
Type: Number CSS Inheritance: no
Background alpha. The default value is 1.
BaseCalendarItemRenderer
  
backgroundColor
Type: uint Format: Color CSS Inheritance: no
Background color. This value might be overridden by setting property in CalendarItem class The default value is 0x668CD9.
BaseCalendarItemRenderer
  
borderAlpha
Type: Number CSS Inheritance: no
Border alpha. The default value is 1.
BaseCalendarItemRenderer
  
borderColor
Type: uint Format: Color CSS Inheritance: no
Border color The default value is 0x060D5E.
BaseCalendarItemRenderer
  
borderThickness
Type: Number Format: Length CSS Inheritance: no
Border thickness The default value is 1 for most components, 0.5 for long item renderers and month renderers..
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
cornerRadius
Type: Number Format: Length CSS Inheritance: no
Corner radius. If 0, corners are not rounded. The default value is 5.
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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"
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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:
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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"
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
margin
Type: Number Format: Length CSS Inheritance: no
Margin of renderer. The default value is 1.
BaseCalendarItemRenderer
  
rendererAlpha
Type: Number CSS Inheritance: no
Entire renderer alpha value. The default value is not set.
BaseCalendarItemRenderer
  
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"
BaseCalendarItemRenderer
  
textColor
Type: uint Format: Color CSS Inheritance: no
Background color. This value might be overridden by setting property in CalendarItem class The default value is 0xfefefe.
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
  
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
BaseCalendarItemRenderer
Property Detail
_backgroundAlphaproperty
protected var _backgroundAlpha:Number

Holds read style value

_backgroundColorproperty 
protected var _backgroundColor:uint

Holds read style value

_borderAlphaproperty 
protected var _borderAlpha:Number

Holds read style value

_borderColorproperty 
protected var _borderColor:uint

Holds read style value

_borderThicknessproperty 
protected var _borderThickness:Number

Holds read style value

_calendarContextproperty 
protected var _calendarContext:ICalendarContext

Calendar context injected by factory

_cornerRadiusproperty 
protected var _cornerRadius:Number

Holds read style value

_itemDetailsproperty 
protected var _itemDetails:ItemDetails

Internal calendar item object, accessed by getter/setter

_marginproperty 
protected var _margin:Number

Margin of element.

_rendererAlphaproperty 
protected var _rendererAlpha:Number

Holds read style value

_textColorproperty 
protected var _textColor:Number

Holds read style value

itemDetailsproperty 
itemDetails:ItemDetails

Calendar item associated with this renderer. Implementation of CalendarItemRenderer interface.

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


Implementation
    public function get itemDetails():ItemDetails
    public function set itemDetails(value:ItemDetails):void

See also

summaryLabelproperty 
protected var summaryLabel:Text

Summary label

Constructor Detail
BaseCalendarItemRenderer()Constructor
public function BaseCalendarItemRenderer()

As this is base class, it should not be created directly.

Method Detail
createSummaryLabel()method
protected function createSummaryLabel():void

Create summary label

getPositionFunction()method 
public function getPositionFunction(x:Number, y:Number):int

Implementation of ICalendarRenderer interface. As this is base class, this function returns CalendarRendererPositionFunction.NONE

Parameters

x:Number — x position in component coordinates
 
y:Number — y position in component coordinates

Returns
int — value declared in CalendarRendererPositionFunction class

See also

readItemColors()method 
protected function readItemColors():IRendererColors

Returns
IRendererColors
readStyleValues()method 
protected function readStyleValues():void

Read component style values

setContext()method 
public function setContext(context:ICalendarContext):void

Parameters

context:ICalendarContext