BiReference
This is the base class for representing a reference to another object in ADF markup. The referred object is typically a property or action. The default is Object. Extend this class to create tags for your own predefined reference types.@remark This class is used inside BiAction Statements.
This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiReference .
Constructor
new BiReference ( )
Parameters
No parameters.
Properties
| Name | Type | get | set | Descripton |
arguments | Array |  | | Arguments for the referred action/property. NOTE: Right now, The setter adds rather than overwrite value. This is due to change in coming versions. |
async | Boolean | | | Whether to perform this action asynchronously |
name | String | | | A referenced property name. This is the property/action upon which activity(get,set,call) will be performed. It is typically used in conjunction with src.@remark This class overrides the default behavior of the "name" property. It is the the name of that we refer. |
src | Object | | | This is an optional reference to an Object which holds the member that will be acted upon. In ADF markup, prefixes can be used and have the following meaning: prefix # = id locator - referencing the id of another object as defined in the ADF. prefix . = local property locator - the name of a local member(action or property). no prefix = reference to a name known in the name scope or a direct reference to an object. |
threadConstructor | | | | The thread constructor to use for this type of action |
type | Number | | | The type of this reference. Options are: action/4, get/1, set/2 or property/3. If "property" is used, the context in which the reference is used decides whether "set" or "get" is used. Default is 4(action). |
Methods
| Name | Description |
createThread | This method creates an executable thread from the action definition |
Events
None.
Static Methods
| Name | Description |
getReference | This is a static method to look up references. A reference can be either a object reference or a string that represent either a name or a composite path. See the documentation of reference src for details on paths. |
Static Fields
None.
Remarks
None.
Method Details
createThread
This method creates an executable thread from the action definition
Syntax
object.createThread ( oScope [ ,nType ] ) Parameters
| Name | Type | Optional | Default | Descripton |
oScope | Object | The scope this action should be executed in. | ||
nType | Number | | The (optional) type of the thread. |
Return Type
Static Method Details
getReference
This is a static method to look up references. A reference can be either a object reference or a string that represent either a name or a composite path. See the documentation of reference src for details on paths.
Syntax
BiReference . getReference ( oRef,oThis [ ,oDefaultReturns ] ) Parameters
| Name | Type | Optional | Default | Descripton |
oRef | Object | The reference to look up. | ||
oThis | Object | What should "this" be when reference is a local reference | ||
oDefaultReturns | Object | | Boolean false | What this call should(optionally) return as default |
Return Type
Object