Runtime Type : Types : Object
Complex data type from which all other complex types are derived. Many of the generic functions here are meant to be overridden in sub-classes.
Contents |
Inherits From
root→Object
Fields
| Object this | Reference to the object (like C++/Java "this", or Python "self") that can be passed to functions. |
Function Summary
| fire | Adds an event, along with another object as the sender to the page-level Event Viewer. |
| fireSelf | Adds an event (from itself) to the page-level Event Viewer. |
| getName | Returns the name of the object. |
| handleEvent | Generic function for handling events that the object observes. This function is meant to be overridden by Cord objects. |
| onCopy | function description |
| onCreate | Is called when the object is instantiated, like a constructor. |
| onDelete | function description |
| onError | function description |
| onLoad | function description |
| toString | This function returns the name of the object type. Note: In actual applications, this may also be thought of as the "Type". |
Function Detail
Adds an event, along with another object as the sender. to the page-level Event Viewer.
Syntax
fire( [in] EventAdapter event, [in] Object detail )
Parameters
- event
- The type of event to add.
- detail
- The object type indicated as the sender.
Error Handling
If event or detail is null, then no action is taken, and no error condition is raised.
Adds an event (from itself) to the page-level Event Viewer.
Syntax
fireSelf( [in] EventAdapter event )
Parameters
- event
- The type of event to add.
Error Handling
If event is null, then no action is taken, and no erro condition is raised.
Returns the name of the object.
Syntax
getName( [out] string className )
Parameters
- className
- The name of the class.
Generic function for handling events that the object observes. This function is meant to be overridden by Cord objects.
Syntax
handleEvent( [in] Event event, [in] Object parentContext, [in] Cord cord, [out] boolean eventHandled )
Parameters
- event
- the event to handle (i.e. Click, Double-Click, etc.)
- parentContext
- contains information about the context in which the function was called (never used by Event Viewer)
- cord
- the cord the event came from, and therefore the cord that called the function
- eventHandled
- true if the object wishes to cancel the event
Error Handling
If event, parentContext, or cord is null, then no action is taken, no error condition is raised, and eventHandled is false.
function description
Syntax
onCopy( [in] Object newCopyObject )
Parameters
- newCopyObject
- argument description
Is called when the object is instantiated, like a constructor.
Syntax
onCreate( )
function description
Syntax
onDelete( )
function description
Syntax
onError( [in] Error error )
Parameters
- error
- argument description
function description
Syntax
onLoad( )
This function returns the name of the object type. Note: In actual applications, this may also be thought of as the "Type".
Syntax
toString( [out] string str )
Parameters
- str
- the name of the object type