Packagecom.whirled.contrib.avrg.probe
Classpublic class TargetedSubCtrlDef

Builds a list of method definitions that target a specific subcontrol instance that is retrieved by id.



Public Properties
 PropertyDefined by
  getSubCtrl : Function
Function that retrieves a subcontrol by id.
TargetedSubCtrlDef
  idParam : Parameter
The id parameter prepended to the parameter list for all added methods.
TargetedSubCtrlDef
Protected Properties
 PropertyDefined by
  _methods : Array
TargetedSubCtrlDef
Public Methods
 MethodDefined by
  
TargetedSubCtrlDef(getSubCtrl:Function, idParam:Parameter)
Creates a new set of method definitions.
TargetedSubCtrlDef
  
addMethod(name:String, getMethod:Function, params:Array = null):void
Adds a new method.
TargetedSubCtrlDef
  
toSpecs():Array
Convert the list of method definitions to a FunctionSpec array.
TargetedSubCtrlDef
Property detail
getSubCtrlproperty
public var getSubCtrl:Function

Function that retrieves a subcontrol by id.

idParamproperty 
public var idParam:Parameter

The id parameter prepended to the parameter list for all added methods.

_methodsproperty 
protected var _methods:Array
Constructor detail
TargetedSubCtrlDef()constructor
public function TargetedSubCtrlDef(getSubCtrl:Function, idParam:Parameter)

Creates a new set of method definitions.

Parameters
getSubCtrl:Function
 
idParam:Parameter
Method detail
addMethod()method
public function addMethod(name:String, getMethod:Function, params:Array = null):void

Adds a new method.

Parameters
name:String — the name of the method
 
getMethod:Function — function that retrives the actual method, given a subcontrol instance
 
params:Array (default = null) — optional list of parameters to the method
toSpecs()method 
public function toSpecs():Array

Convert the list of method definitions to a FunctionSpec array.

Returns
Array