Packageflexlib.scheduling
Classpublic class Timeline
InheritanceTimeline Inheritance mx.core.ScrollControlBase

Timeline is an independent control that renders and let users interact with a customizable timeframe. Developers can use this component in combinations other components, i.e. to add a timeline to a ScheduleViewer component. See flexlib.scheduling.ScheduleViewer for more details. <p> You can style the layout of the timeline frame and customize and style each item of the timeline. By default, one item of Timeline would be a Label displaying a date. </p> <p> The rendering of the item can be customized via the itemRenderer property. The itemRenderer has to implement flexlib.scheduling.timelineClasses.ITimelineEntryRenderer. Via Timeline's timeRanges property you can pass more information to the renderers on specific time ranges. By default a format string as used in mx.formatters.DateFormatter is passed to the renderer depending on what time range is currently displayed. i.e. by default a format string of "L:NNAA" is passed to the renderer when Timeline currently only dispays a time range of one minute. You can customize this with passing your own timeRanges collection. timeRanges must contain items that adhere to the flexlib.scheduling.timelineClasses.ITimeDescriptor interface. See flexlib.scheduling.timelineClasses.TimeRangeDescriptorUtil class for more details and utilities on customizations of time ranges. </p> Timeline supports zooming via the zoom and contentWidth property. <p> Currently, only horizontal timelines are supported. </p> <!--<a href="examples/TimelineLabSample.html">See the example SWF</a>-->

See also

itemRenderer
flexlib.scheduling.timelineClasses.ITimelineEntryRenderer
timeRanges
flexlib.scheduling.timelineClasses.ITimeDescriptor
flexlib.scheduling.timelineClasses.TimeRangeDescriptorUtil
flexlib.scheduling.ScheduleViewer
flexlib.scheduling.util.DateUtil


Public Properties
 PropertyDefined By
  contentWidth : Number
Timeline
  currentDate : Date
Timeline
  endDate : Date
Timeline
  itemRenderer : IFactory
Timeline
  minimumTimeRangeWidth : Number
Timeline
  startDate : Date
Timeline
  timeRanges : IList
Timeline
  xPosition : Number
Timeline
  zoom : Number
Timeline
Public Methods
 MethodDefined By
  
Timeline
Property Detail
contentWidthproperty
contentWidth:Number

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


Implementation
    public function get contentWidth():Number
    public function set contentWidth(value:Number):void
currentDateproperty 
currentDate:Date

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


Implementation
    public function get currentDate():Date
    public function set currentDate(value:Date):void
endDateproperty 
endDate:Date

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


Implementation
    public function get endDate():Date
    public function set endDate(value:Date):void
itemRendererproperty 
itemRenderer:IFactory

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


Implementation
    public function get itemRenderer():IFactory
    public function set itemRenderer(value:IFactory):void
minimumTimeRangeWidthproperty 
minimumTimeRangeWidth:Number

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


Implementation
    public function get minimumTimeRangeWidth():Number
    public function set minimumTimeRangeWidth(value:Number):void
startDateproperty 
startDate: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
timeRangesproperty 
timeRanges:IList

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


Implementation
    public function get timeRanges():IList
    public function set timeRanges(value:IList):void
xPositionproperty 
xPosition:Number

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


Implementation
    public function get xPosition():Number
    public function set xPosition(value:Number):void
zoomproperty 
zoom:Number

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


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
Timeline()Constructor
public function Timeline()