Packagecom.ithaca.timeline
Classpublic class ObselsRenderer
InheritanceObselsRenderer Inheritance BaseObselsRenderer Inheritance spark.components.Group

The ObselsRenderer class extends BaseOselsRenderer to render obsels with skinned ObselsSkins.

Default MXML PropertymxmlContent



Public Properties
 PropertyDefined By
 InheritedborderVisible : Boolean = true
Specifies if the borders of the obselsRenderer should be visible or not.
BaseObselsRenderer
 InheritedobselsCollection : ArrayCollection
[write-only] Change the obsels collection that is displayed by the obsels renderer.
BaseObselsRenderer
  obselsSkinsCollection : ArrayCollection
ObselsRenderer
Protected Properties
 PropertyDefined By
 Inherited_obsels : ArrayCollection = null
the obsels collection displayed by this component
BaseObselsRenderer
 Inherited_timeline : Timeline
Reference to the Timeline
BaseObselsRenderer
 Inherited_timeRange : TimeRange = null
Reference to the TimeRange.
BaseObselsRenderer
 Inherited_traceline : TraceLine
Reference to the TraceLine that contains the BaseObselsRenderer
BaseObselsRenderer
Public Methods
 MethodDefined By
  
ObselsRenderer
 Inherited
filterDisplay(selector:ISelector = null):void
Filter the display of Obsels.
BaseObselsRenderer
  
getObselSkinIndex(obsel:Obsel):int
ObselsRenderer
  
onObselsCollectionChange(event:CollectionEvent):void
[override] Manage the obselsSkinsCollection when the _obsels ArrayCollection change.
ObselsRenderer
  
onResize(event:ResizeEvent):void
[override] Function called when the ObselRenderer is resized.
ObselsRenderer
  
[override] Switch between different redraw functions.
ObselsRenderer
  
redraw(event:Event = null):void
[override] Full redraw of the obsels renderer.
ObselsRenderer
  
updateObselPosition(event:Event = null):void
This redraw function is used when the same set of obsels is visible but their positions have changed.
ObselsRenderer
  
updateViewportPosition(event:Event = null):void
This redraw function is used when the time range has shifted.
ObselsRenderer
Property Detail
obselsSkinsCollectionproperty
public var obselsSkinsCollection:ArrayCollection

Constructor Detail
ObselsRenderer()Constructor
public function ObselsRenderer(tr:TimeRange, tl:TraceLine)



Parameters
tr:TimeRange
 
tl:TraceLine
Method Detail
getObselSkinIndex()method
public function getObselSkinIndex(obsel:Obsel):int

Parameters

obsel:Obsel — An Obsel

Returns
int — the index in obselsSkinsCollection of the ObselSkin that represents obsel. Return -1 if the obsel is not found.
onObselsCollectionChange()method 
override public function onObselsCollectionChange(event:CollectionEvent):void

Manage the obselsSkinsCollection when the _obsels ArrayCollection change. This function is called when a CollectionEvent.COLLECTION_CHANGE is dispatched by _obsels.

Parameters

event:CollectionEvent

onResize()method 
override public function onResize(event:ResizeEvent):void

Function called when the ObselRenderer is resized.

Parameters

event:ResizeEvent

onTimerangeChange()method 
override public function onTimerangeChange(event:TimelineEvent):void

Switch between different redraw functions.

Parameters

event:TimelineEvent

redraw()method 
override public function redraw(event:Event = null):void

Full redraw of the obsels renderer.

Parameters

event:Event (default = null)

updateObselPosition()method 
public function updateObselPosition(event:Event = null):void

This redraw function is used when the same set of obsels is visible but their positions have changed. It happens when the window is resized for example.

Parameters

event:Event (default = null)

updateViewportPosition()method 
public function updateViewportPosition(event:Event = null):void

This redraw function is used when the time range has shifted. These are the same obsels at the same position (no resizing of the renderer) but the position of the viewport must change. It happens when the current time change.

Parameters

event:Event (default = null)