Packagecom.ithaca.timeline
Interfacepublic interface ISelector
Implementors SelectorRegexp

The ISelector interface is implemented by classes that are used to select obsels (Tracelines have an ISelector properties for example).

See also

SelectorRegexp


Public Methods
 MethodDefined By
  
getMatchingObsels(obselsArray:Array):Array
Select the matching set of obsels from an array of obsels
ISelector
  
getParameters():String
This function returns the parameter serialization needed to define the Selector.
ISelector
  
isEqual(selector:ISelector):Boolean
Test if another ISelector is the same as this one.
ISelector
  
isObselMatching(obsel:Obsel):Boolean
Test if an obsel matches the selector
ISelector
  
setParameters(parameters:String):void
Change the parameters of the selector.
ISelector
Method Detail
getMatchingObsels()method
public function getMatchingObsels(obselsArray:Array):Array

Select the matching set of obsels from an array of obsels

Parameters

obselsArray:Array — the array of obsels to test

Returns
Array — the array of matching obsels
getParameters()method 
public function getParameters():String

This function returns the parameter serialization needed to define the Selector.

It is used to save the current layout in an xml descriptor.

Returns
String — the serialization of the selector parameters

See also

isEqual()method 
public function isEqual(selector:ISelector):Boolean

Test if another ISelector is the same as this one.

This function is used to test if a selector has already been created by a LayoutModifier in order to know if a new traceline needs to be created.

Parameters

selector:ISelector — the selector to test

Returns
Boolean — true if equal, else return false

See also

isObselMatching()method 
public function isObselMatching(obsel:Obsel):Boolean

Test if an obsel matches the selector

Parameters

obsel:Obsel — The obsel to test

Returns
Boolean — true if the obsel is matching, false otherwise.
setParameters()method 
public function setParameters(parameters:String):void

Change the parameters of the selector.

Parameters

parameters:String — The serialization of the selector parameters

See also