Packagecom.ithaca.timeline
Classpublic class TraceLine
InheritanceTraceLine Inheritance LayoutNode Inheritance spark.components.SkinnableContainer

The TraceLine class extends the LayoutNode ; it manages an obsels collection selected from an obsels source and renders them.

Default MXML PropertymxmlContentFactory

See also

Layout
LayoutNode

Public Properties
 PropertyDefined By
  autohide : Boolean = false
TraceLine
  lastRendererGap : Number
TraceLine
  lastRendererHeight : Number
TraceLine
 InheritedlayoutXML : XML
The XML descriptor of the sub-layout from this node.
LayoutNode
  _obsels : ArrayCollection
TraceLine
 InheritedparentNode : LayoutNode
A reference to the parent node of this node.
LayoutNode
  selector : ISelector
TraceLine
  sourceStr : String = trace
TraceLine
 Inherited_timeline : Timeline
A reference to the timeline
LayoutNode
  title : String
Sets the title (but not the name) of the Traceline
TraceLine
 InheritedtitleComponent : SkinnableContainer
The visual component used to show the title part of the node.
LayoutNode
Public Methods
 MethodDefined By
  
TraceLine(tl:Timeline, tlTitle:String = null, tlName:String = null, tlSelector:ISelector = null, tlSource:String = null, tlSkinClass:String = null)
Create a new Traceline
TraceLine
  
acceptObsel(obsel:Obsel):Boolean
Check if an obsel matches the selector
TraceLine
 Inherited
addChildAndTitle(child:LayoutNode, index:int = -1):void
LayoutNode
  
addObsel(obsel:Obsel):void
Add an obsel in the obsel collection
TraceLine
  
getCollectionSource():ArrayCollection
TraceLine
 Inherited
getElementByName(name:String):LayoutNode
Return the layoutNode of a given name in the subtree of this node
LayoutNode
  
getParentTraceLines():Array
Return an Array containing the parent tracelines
TraceLine
 Inherited
getTraceLineGroup():TraceLineGroup
LayoutNode
  
getTraceLinePath():Array
Return an Array containing the path to the traceline.
TraceLine
  
getVisibleChildrenNumber():Number
Compute the number of traceline children which are not hidden ; used to know if the open/close button must be visible.
TraceLine
  
isOpen():Boolean
Indicate wether the Traceline is open/expanded or not.
TraceLine
 Inherited
moveTraceline(child:LayoutNode, index:int = -1):void
LayoutNode
  
onSourceChange(event:CollectionEvent):void
[override] Handle an obsel collection event that occurs in the source collection
TraceLine
 Inherited
removeChildAndTitle(child:LayoutNode):void
Remove a child (mostly Traceline)
LayoutNode
  
removeObsel(obsel:Obsel):void
Remove an obsel from the obsel collection
TraceLine
  
resetObselCollection(obselsCollection:ArrayCollection = null):void
[override] Rebuild the obsel collection from source
TraceLine
  
setToVisible(visible:Boolean):void
Show or hide the traceline and its children according to the parameter.
TraceLine
Styles
 Style Description Defined By
  
rendererGap
Type: Number CSS Inheritance: no
The gap under the obsel renderer component 		TraceLine
  
rendererHeight
Type: Number CSS Inheritance: no
The height of the obsel renderer component 		TraceLine
  
title
Type: String CSS Inheritance: no
TraceLine
Property Detail
_obselsproperty
public var _obsels:ArrayCollection

autohideproperty 
public var autohide:Boolean = false

lastRendererGapproperty 
public var lastRendererGap:Number

lastRendererHeightproperty 
public var lastRendererHeight:Number

selectorproperty 
selector:ISelector


Implementation
    public function get selector():ISelector
    public function set selector(value:ISelector):void
sourceStrproperty 
public var sourceStr:String = trace

titleproperty 
title:String

Sets the title (but not the name) of the Traceline


Implementation
    public function get title():String
    public function set title(value:String):void
Constructor Detail
TraceLine()Constructor
public function TraceLine(tl:Timeline, tlTitle:String = null, tlName:String = null, tlSelector:ISelector = null, tlSource:String = null, tlSkinClass:String = null)

Create a new Traceline

Parameters
tl:Timeline — the timeline containing the traceline
 
tlTitle:String (default = null) — the title (and name/id) of the traceline. It is used by CSS selectors.
 
tlName:String (default = null) — the traceline selector
 
tlSelector:ISelector (default = null) — the traceline obsel source
 
tlSource:String (default = null) — FIXME
 
tlSkinClass:String (default = null)
Method Detail
acceptObsel()method
public function acceptObsel(obsel:Obsel):Boolean

Check if an obsel matches the selector

Parameters

obsel:Obsel

Returns
Boolean — true if the obsel matches the selector or if there's no selector ; otherwise return false.
addObsel()method 
public function addObsel(obsel:Obsel):void

Add an obsel in the obsel collection

Parameters

obsel:Obsel

getCollectionSource()method 
public function getCollectionSource():ArrayCollection

Returns
ArrayCollection — the obsels collection used as source (before selection) by the traceline ; it can be the timeline trace or the obsels collection of the parent node
getParentTraceLines()method 
public function getParentTraceLines():Array

Return an Array containing the parent tracelines

Returns
Array
getTraceLinePath()method 
public function getTraceLinePath():Array

Return an Array containing the path to the traceline. It is formed by the concatenation of the traceline parents with the traceline itself.

Returns
Array
getVisibleChildrenNumber()method 
public function getVisibleChildrenNumber():Number

Compute the number of traceline children which are not hidden ; used to know if the open/close button must be visible.

This is because a node could have children in autohide mode and then the open button must be hidden

Returns
Number — the number of visible children
isOpen()method 
public function isOpen():Boolean

Indicate wether the Traceline is open/expanded or not.

Returns
Boolean — true if the traceline is open
onSourceChange()method 
override public function onSourceChange(event:CollectionEvent):void

Handle an obsel collection event that occurs in the source collection

Parameters

event:CollectionEvent

removeObsel()method 
public function removeObsel(obsel:Obsel):void

Remove an obsel from the obsel collection

Parameters

obsel:Obsel

resetObselCollection()method 
override public function resetObselCollection(obselsCollection:ArrayCollection = null):void

Rebuild the obsel collection from source

Parameters

obselsCollection:ArrayCollection (default = null)

setToVisible()method 
public function setToVisible(visible:Boolean):void

Show or hide the traceline and its children according to the parameter.

Parameters

visible:Boolean — if true the TraceLine is visible; otherwise it's hidden.





Thu May 3 2012, 10:25 AM +02:00