Packagecom.ithaca.timeline
Classpublic class ZoomContext
InheritanceZoomContext Inheritance spark.components.SkinnableContainer

The ZoomContext class manages a movable and resizable cursor to control the time interval in which the obsels have to be displayed.

Default MXML PropertymxmlContentFactory



Public Properties
 PropertyDefined By
  cursorEditable : Boolean
[write-only] Set the cursor in the 'editable' or 'fixed' state according to the parameter value.
ZoomContext
  cursorRange : TimeRange
The TimeRange defined by the position and the width of the 'cursor' component ; the obsels in this TimeRange are rendered in the main layout zone.
ZoomContext
  _timeline : Timeline
Reference to the TimeLine
ZoomContext
  timeline : Timeline
ZoomContext
  _timelineRange : TimeRange
The TimeRange of the Timeline ; it defines the minimum and maximum of the possible values of the cursorRange.
ZoomContext
Public Methods
 MethodDefined By
  
ZoomContext
  
addTraceLineGroupPreview(tlg:TraceLineGroup, index:Number = -1):void
Add a traceline to the timelinePreview Group in order to make a preview of a given TraceLineGroup.
ZoomContext
  
onTracelineGroupsChange(event:ElementExistenceEvent):void
Update the content of the timelinePreview Group according to the TraceLineGroup of the Timeline
ZoomContext
  
Remove a TraceLine from the timelinePreview Group
ZoomContext
  
reset():void
Reset the position and width of the cursor component to default value (and obviously the cursorRange interval)
ZoomContext
  
setRange(beginValue:Number, endValue:Number):void
Change the limits of the cursorRange (and obviously the position and width of the cursor)
ZoomContext
  
shiftContext(deltaTime:Number):Number
Add a given number of milliseconds both to the begin and to the end of the cursorRange
ZoomContext
  
updateSkinPositionFromValues(e:Event = null):void
update the position and the width of the cursor according to the cursorRange values
ZoomContext
  
updateValuesFromSkinPosition(e:Event = null):void
update the cursorRange values according to the position and the width of the cursor
ZoomContext
Protected Methods
 MethodDefined By
  
onManualChange(e:Event = null):void
ZoomContext
Styles
 Style Description Defined By
  
backgroundColor
Type: Number Format: Color CSS Inheritance: no
ZoomContext
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
cursor:mx.core.UIComponent
Required: true Part Type: Static
This is the movable an resizable part of the zoomContext. Its position defines the begin of the cursorRange Property and its width defines the duration of this TimeRange.
ZoomContext
  
inputTimeRuler:TimeRuler
Required: true Part Type: Static
A ruler to display to the _timelineRange
ZoomContext
  
outputTimeRuler:TimeRuler
Required: false Part Type: Static
A ruler to display to the cursorRange
ZoomContext
  
timelinePreview:spark.components.Group
Required: true Part Type: Static
This group contains a preview traceline for each TraceLineGroup of the Timeline ; the obsels in the _timelineRange are rendered.
ZoomContext
Property Detail
_timelineproperty
public var _timeline:Timeline

Reference to the TimeLine

_timelineRangeproperty 
public var _timelineRange:TimeRange

The TimeRange of the Timeline ; it defines the minimum and maximum of the possible values of the cursorRange.

cursorEditableproperty 
cursorEditable:Boolean  [write-only]

Set the cursor in the 'editable' or 'fixed' state according to the parameter value.


Implementation
    public function set cursorEditable(value:Boolean):void
cursorRangeproperty 
public var cursorRange:TimeRange

The TimeRange defined by the position and the width of the 'cursor' component ; the obsels in this TimeRange are rendered in the main layout zone.

timelineproperty 
timeline:Timeline


Implementation
    public function get timeline():Timeline
    public function set timeline(value:Timeline):void
Constructor Detail
ZoomContext()Constructor
public function ZoomContext()



Method Detail
addTraceLineGroupPreview()method
public function addTraceLineGroupPreview(tlg:TraceLineGroup, index:Number = -1):void

Add a traceline to the timelinePreview Group in order to make a preview of a given TraceLineGroup.

Parameters

tlg:TraceLineGroup — the TraceLineGroup to preview
 
index:Number (default = -1) — the position of the preview (-1 to add it at the end)

onManualChange()method 
protected function onManualChange(e:Event = null):void

Parameters

e:Event (default = null)

onTracelineGroupsChange()method 
public function onTracelineGroupsChange(event:ElementExistenceEvent):void

Update the content of the timelinePreview Group according to the TraceLineGroup of the Timeline

Parameters

event:ElementExistenceEvent

removeTraceLineGroupPreviewAt()method 
public function removeTraceLineGroupPreviewAt(i:uint):void

Remove a TraceLine from the timelinePreview Group

Parameters

i:uint — index of the traceline to remove

reset()method 
public function reset():void

Reset the position and width of the cursor component to default value (and obviously the cursorRange interval)

setRange()method 
public function setRange(beginValue:Number, endValue:Number):void

Change the limits of the cursorRange (and obviously the position and width of the cursor)

Parameters

beginValue:Number — start of the new range in milliseconds
 
endValue:Number — end of the new range in milliseconds

shiftContext()method 
public function shiftContext(deltaTime:Number):Number

Add a given number of milliseconds both to the begin and to the end of the cursorRange

Parameters

deltaTime:Number — (can be a negative value)

Returns
Number
updateSkinPositionFromValues()method 
public function updateSkinPositionFromValues(e:Event = null):void

update the position and the width of the cursor according to the cursorRange values

Parameters

e:Event (default = null)

updateValuesFromSkinPosition()method 
public function updateValuesFromSkinPosition(e:Event = null):void

update the cursorRange values according to the position and the width of the cursor

Parameters

e:Event (default = null)