JSClassDefinition class

struct JSStaticFunction This structure contains properties and callbacks that define a type of object. All fields other than the version field are optional. Any pointer may be NULL. The staticValues and staticFunctions arrays are the simplest and most efficient means for vending custom properties. Statically declared properties autmatically service requests like getProperty, setProperty, and getPropertyNames. Property access callbacks are required only to implement unusual properties, like array indexes, whose names are not known at compile-time.

If you named your getter function "GetX" and your setter function "SetX", you would declare a JSStaticValue array containing "X" like this:

JSStaticValue StaticValueArray[] = { Standard JavaScript practice calls for storing function objects in prototypes, so they can be shared. The default JSClass created by JSClassCreate follows this idiom, instantiating objects with a shared, automatically generating prototype containing the class's function objects. The kJSClassAttributeNoAutomaticPrototype attribute specifies that a JSClass should not automatically generate such a prototype. The resulting JSClass instantiates objects with the default object prototype, and gives each instance object its own copy of the class's function objects.

Properties

attributes JSClassAttributes
A logically ORed set of JSClassAttributes to give to the class.
getter/setter pair
callAsConstructor Pointer<NativeFunction<JSObjectCallAsConstructorCallback>>?
The callback invoked when an object is used as the target of an 'instanceof' expression.
getter/setter pair
callAsFunction Pointer<NativeFunction<JSObjectCallAsFunctionCallback>>?
The callback invoked when an object is called as a function.
getter/setter pair
className String
A null-terminated UTF8 string containing the class's name.
getter/setter pair
convertToType Pointer<NativeFunction<JSObjectConvertToTypeCallback>>?
The callback invoked when converting an object to a particular JavaScript type.
getter/setter pair
deleteProperty Pointer<NativeFunction<JSObjectDeletePropertyCallback>>?
The callback invoked when deleting a property.
getter/setter pair
finalize Pointer<NativeFunction<JSObjectFinalizeCallback>>?
The callback invoked when an object is finalized (prepared for garbage collection). Use this callback to release resources allocated for the object, and perform other cleanup.
getter/setter pair
getProperty Pointer<NativeFunction<JSObjectGetPropertyCallback>>?
The callback invoked when getting a property's value.
getter/setter pair
getPropertyNames Pointer<NativeFunction<JSObjectGetPropertyNamesCallback>>?
The callback invoked when collecting the names of an object's properties.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
hasInstance Pointer<NativeFunction<JSObjectHasInstanceCallback>>?
The callback invoked when an object is used as a constructor in a 'new' expression.
getter/setter pair
hasProperty Pointer<NativeFunction<JSObjectHasPropertyCallback>>?
The callback invoked when determining whether an object has a property. If this field is NULL, getProperty is called instead. The hasProperty callback enables optimization in cases where only a property's existence needs to be known, not its value, and computing its value is expensive.
getter/setter pair
initialize Pointer<NativeFunction<JSObjectInitializeCallback>>?
The callback invoked when an object is first created. Use this callback to initialize the object.
getter/setter pair
parentClass JSClass?
A JSClass to set as the class's parent class. Pass NULL use the default object class.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
setProperty Pointer<NativeFunction<JSObjectSetPropertyCallback>>?
The callback invoked when setting a property's value.
getter/setter pair
staticFunctions List<JSStaticFunction>?
A JSStaticFunction array containing the class's statically declared function properties. Pass NULL to specify no statically declared function properties. The array must be terminated by a JSStaticFunction whose name field is NULL.
getter/setter pair
staticValues List<JSStaticValue>?
A JSStaticValue array containing the class's statically declared value properties. Pass NULL to specify no statically declared value properties. The array must be terminated by a JSStaticValue whose name field is NULL.
getter/setter pair
version int
The version number of this structure. The current version is 0.
getter/setter pair

Methods

create() Pointer<JSClassDefinition>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited