Packageardisia.components.timebarContainer.themes.baseClasses
Classpublic class TimebarContainerItemRendererBase
InheritanceTimebarContainerItemRendererBase Inheritance mx.core.UIComponent
Implements ITimebarContainerItemRenderer
Subclasses TimebarContainerHeaderItemRenderer, TimebarContainerItemRenderer

Base item renderer for the TimebarContainer. Designed to be overridden by themes and optimized for performance.


Public Properties
 PropertyDefined By
  baselineShift : Number
Apply some shift to text.
TimebarContainerItemRendererBase
  dateBegin : Date
The start date represented by the renderer.
TimebarContainerItemRendererBase
  dateEnd : Date
The end date represented by the renderer.
TimebarContainerItemRendererBase
  hovered : Boolean
True when the renderer is hovered.
TimebarContainerItemRendererBase
  intervalMode : IntervalMode
The IntervalMode represented by the renderer.
TimebarContainerItemRendererBase
  itemIndex : int
The item index of the renderer, which is the index of the interval.
TimebarContainerItemRendererBase
  labelDisplay : FTETextField
Label used to display the time period represented by the renderer.
TimebarContainerItemRendererBase
Public Methods
 MethodDefined By
  
getMinWidthAtMode(mode:IntervalMode):Number
Returns the minimum number of pixels required for the passed IntervalMode.
TimebarContainerItemRendererBase
  
update():void
Call to update the label based on the renderer's set properties.
TimebarContainerItemRendererBase
Property Detail
baselineShiftproperty
baselineShift:Number

Apply some shift to text.

The default value is 0.


Implementation
    public function get baselineShift():Number
    public function set baselineShift(value:Number):void
dateBeginproperty 
dateBegin:Date

The start date represented by the renderer.

The default value is null.


Implementation
    public function get dateBegin():Date
    public function set dateBegin(value:Date):void
dateEndproperty 
dateEnd:Date

The end date represented by the renderer.

The default value is null.


Implementation
    public function get dateEnd():Date
    public function set dateEnd(value:Date):void
hoveredproperty 
hovered:Boolean

True when the renderer is hovered.

The default value is false.


Implementation
    public function get hovered():Boolean
    public function set hovered(value:Boolean):void
intervalModeproperty 
intervalMode:IntervalMode

The IntervalMode represented by the renderer.

The default value is null.


Implementation
    public function get intervalMode():IntervalMode
    public function set intervalMode(value:IntervalMode):void
itemIndexproperty 
itemIndex:int

The item index of the renderer, which is the index of the interval.

The default value is 0.


Implementation
    public function get itemIndex():int
    public function set itemIndex(value:int):void
labelDisplayproperty 
public var labelDisplay:FTETextField

Label used to display the time period represented by the renderer.

Use a FTETextField for maximum speed while retaining the ability to embed fonts. Use the textWidth property to get the width of FTETextField objects.

Method Detail
getMinWidthAtMode()method
public function getMinWidthAtMode(mode:IntervalMode):Number

Returns the minimum number of pixels required for the passed IntervalMode. Customize to add additional modes.

Parameters

mode:IntervalMode — the IntervalMode to return the width for

Returns
Number — number of pixels required for the passed IntervalMode
update()method 
public function update():void

Call to update the label based on the renderer's set properties.

Customize to add additional modes.

Will be called automatically by the TimebarContainer after all relevant properties have been set.





Mon Sep 15 2014, 01:55 AM -06:00