Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

j_signal_delete

<static> void j_signal_delete(<int> sid)

Removes a signal from the registry; along with all registered handlers.

Parameters:
sid - The signal identifier to be removed.

j_signal_emit

<static> void j_signal_emit(<Object> obj, <int> sid, <Array> data)

Emits a signal.

Parameters:
obj - The instance emitting the signal
sid - The id of the signal to emit
data - Collection of name => value pairs detailing the event

Throws:
- UnknownSignalException If the specified signal is unregistered
See:
- j_signal_emit_by_name()

j_signal_emit_by_name

<static> void j_signal_emit_by_name(<Object> obj, <int> name, <Array> data)

Similiar to j_signal_emit but accepts a signal name instead of a signal identifier. This is slower than emitting the signal by the identifier as the signal must first be located within the registry. Ancestors of the specified object instance will be searched to determine if superclasses registered the specified signal. However this requires that the

obj

parameter has - within its prototype - a member named

parent

which points to the constructor of the object's superclass.

Parameters:
obj - The instance emitting the signal
name - The name of the signal to emit
data - Collection of name => value pairs detailing the event

Throws:
- UnknownSignalException If the specified signal is unregistered
See:
- j_signal_emit()

j_signal_handler_block

<static> void j_signal_handler_block(<Object> obj, <int> hid)

Temporarily deactivates the specified handler.

Parameters:
obj - The instance on which the handler is defined
hid - The handler's identifier

Throws:
- UnknownInstanceException If the specified object has no registered handlers
- UnknownHandlerException If the handler is not found within the instance's registry
See:
- j_signal_handler_unblock()

j_signal_handler_connect

<static> int j_signal_handler_connect(<Object> obj, <String> name, <Function> cb, <Object> data)

Connects a callback function to a signal for a particular object.

Parameters:
obj - The instance to register to
name - The name of the signal to recieve
cb - A pointer to the callback function
data - Data to be passed to the callback pointer.

Returns:
The handler ID

Throws:
- UnknownSignalException If the specified signal is unregistered

j_signal_handler_connect_global

<static> int j_signal_handler_connect_global(<String> name, <Function> cb, <Object> data)

Connects a callback function to a signal that is registered as a global signal (created via j_signal_new_global). The handler will be executed whenever the signal is emitted regardless of the emitting instance. Note that all global handlers will be executed BEFORE instance-specific handlers.

Parameters:
name - The name of the signal to recieve
cb - A pointer to the callback function
data - Data to be passed to the callback pointer.

Returns:
The handler ID

Throws:
- UnknownSignalException If the specified signal is unregistered

j_signal_handler_disconnect

<static> void j_signal_handler_disconnect(<Object> obj, <int> hid)

Disconnects (deletes) a specified handler.

Parameters:
obj - Instance the handler is currently attached to
hid - Handler identifier

j_signal_handler_is_connected

<static> boolean j_signal_handler_is_connected(<Object> obj, <int> hid)

Determines if a specified handler is connected to the given instance.

Parameters:
obj - handler-owning instance
hid - Handler identifier

Returns:
true if the specified handler is connected to the given instance; false otherwise

j_signal_handler_unblock

<static> void j_signal_handler_unblock(<Object> obj, <int> hid)

Removes a block placed upon a handler.

Parameters:
obj - The instance on which the handler is defined
hid - The handler's identifier

Throws:
- UnknownInstanceException If the specified object has no registered handlers
- UnknownHandlerException If the handler is not found within the instance's registry
See:
- j_signal_handler_block()

j_signal_list_all_ids

<static> Array j_signal_list_all_ids(<ObjectType> ctype)

Retrieves a list of signal identifiers for a given class type. Note: In order for this function to work properly it is required that the ctype argument have a member variable named 'parent' which is a reference to the class's superclass constructor.

Parameters:
ctype - A reference to the class constructor

Returns:
Array of signal IDs

See:
- j_signal_list_ids()

j_signal_list_ids

<static> Array j_signal_list_ids(<ObjectType> ctype)

Retrieves a list of signal identifiers registered by the given class type. This function does NOT list those signals registered by the class's supertype.

Parameters:
ctype - A reference to the class constructor

Returns:
Array of signal IDs

See:
- j_signal_list_all_ids()

j_signal_lookup

<static> int j_signal_lookup(<String> name, <ObjectType> ctype)

Given the name of the signal and the class it connects to, gets the signal's identifier. Emitting the signal by number is typically fater than by name. Note: In order for this function to work properly it is required that the ctype argument have a member variable named 'parent' which is a reference to the class's superclass constructor.

Parameters:
name - The signals name
ctype - The type that the signal is registered under

Returns:
The ID of the specified signal; -1 if the signal is not found.

j_signal_name

<static> String j_signal_name(<int> sid)

Given the signal's identifier returns the signal's name.

Parameters:
sid - Signal identifier

Returns:
The name of the signal or null if the identifier is invalid.

j_signal_new

<static> int j_signal_new(<String> name, <ObjectType> ctype)

Registers a new signal.

Parameters:
name - The name of the signal
ctype - The class from which this signal will originate.

Returns:
The id of the newly created signal

j_signal_new_global

<static> int j_signal_new_global(<String> name)

Registers a new global signal that can be used (emitted) by any and all objects.

Parameters:
name - The name of the signal

Returns:
The id of the newly created signal