static org.cote.js.object
version 1.9.18
Utilities for script objects.
This class participates in the engine library.
Index
Property Index
- public accessorindex (internal): A hash of variant identifiers whose value is the index of accessors. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
- public accessornames (internal): A hash of variant names whose value is the index of accessors. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
- public accessors (internal): An array of variant values. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
- public object_version: The version of the object
Method Index
- public getAccessor (internal): Returns the accessor for the given index. The method is created for an object with implementsObjectAccessor.
- public getAccessorByName (internal): Returns the accessor based on the specified name. The method is created for an object with implementsObjectAccessor.
- public getAccessors (internal): Returns the accessors array. The method is created for an object with implementsObjectAccessor.
- public implementObjectAccessor (internal): Creates object accessors, getAccessorByName, getAccessor, getAccessors, and isAccessor methods, and the Accessors, Accessornames, and Accessorindex arrays on the object_config.pointers sub structure. It is up to the implementing class to specify the property values jointly in order for the method values to resolve.
- public isAccessor (internal): Returns true if the accessor exists. The method is created for an object with implementsObjectAccessor.
- public newInstance (internal): Returns the offset client height.
Properties
accessorindex
A hash of variant identifiers whose value is the index of accessors. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
Syntax
array = org.cote.js.object.accessorindex
accessornames
A hash of variant names whose value is the index of accessors. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
Syntax
array = org.cote.js.object.accessornames
accessors
An array of variant values. The array is created for an object with implementsObjectAccessor, and is stored on the object_config.pointers sub structure.
Syntax
array = org.cote.js.object.accessors
object_version
The version of the object
Syntax
String = org.cote.js.object.object_version
Methods
getAccessor
Returns the accessor for the given index. The method is created for an object with implementsObjectAccessor.
Syntax
v = getAccessor(
)
Returns
v as variant: The value of the accessor.
getAccessorByName
Returns the accessor based on the specified name. The method is created for an object with implementsObjectAccessor.
Syntax
v = getAccessorByName(
)
Returns
v as variant: The value of the accessor.
getAccessors
Returns the accessors array. The method is created for an object with implementsObjectAccessor.
Syntax
a = getAccessors(
)
Returns
a as array: The accessor array.
implementObjectAccessor
Creates object accessors, getAccessorByName, getAccessor, getAccessors, and isAccessor methods, and the Accessors, Accessornames, and Accessorindex arrays on the object_config.pointers sub structure. It is up to the implementing class to specify the property values jointly in order for the method values to resolve.
Syntax
b = implementObjectAccessor(
o, s
)
Parameters
- o as object : Object for which the accessors will be created.
- s as String : Name of the accessor.
Returns
b as boolean: Returns true if the accessors were created.
isAccessor
Returns true if the accessor exists. The method is created for an object with implementsObjectAccessor.
Syntax
b = isAccessor(
)
Returns
b as boolean: Bit indicating whether the accessor exists.
newInstance
Returns the offset client height.
Syntax
o = newInstance(
s, v
)
Parameters
- s as String : Object type.
- v as String : Object version.
Returns
o as object: A new instance of the specified object created from a