crystalspace.jbind.impl.csutil.event
Class csEventCord

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.csutil.event.csEventCord

All Implemented Interfaces:

iBase, iEventCord, iPointer

public class csEventCord

extends csBase

implements iEventCord

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csEventCord(iPointer nPointer)

Method Summary

int	getCategory() Get the category of this cord.
static java.lang.Class	getInterfaceClass()
static java.lang.String	getInterfaceName()
static int	getInterfaceVersion()
java.lang.String	getName() Return the name of the interface
boolean	getPass() Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent();.
int	getVersion() Return the version of the interface
static void	initSCF()
int	insert(iEventHandler handler, int priority) Insert an event handler into the cord.
protected boolean	isNativePointerValidSafe(long pointer)
void	remove(iEventHandler handler) Remove an event handler from the cord.
void	setPass(boolean pass) Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent();.

Methods inherited from class crystalspace.jbind.impl.csutil.scf.csBase

decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Constructor Detail

csEventCord

public csEventCord(iPointer nPointer)

Parameters:

nPointer -

Method Detail

getVersion

public int getVersion()

Description copied from interface: iBase

Return the version of the interface

Specified by:

getVersion in interface iBase

Specified by:

getVersion in class csBase

getName

public java.lang.String getName()

Description copied from interface: iBase

Return the name of the interface

Specified by:

getName in interface iBase

Specified by:

getName in class csBase

initSCF

public static void initSCF()

getInterfaceVersion

public static int getInterfaceVersion()

getInterfaceName

public static java.lang.String getInterfaceName()

getInterfaceClass

public static java.lang.Class getInterfaceClass()

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)

Specified by:

isNativePointerValidSafe in class csNativeObject

getCategory

public int getCategory()

Description copied from interface: iEventCord

Get the category of this cord. Implemented in csEventCord.

Specified by:

getCategory in interface iEventCord

Returns:

See Also:

iEventCord.getCategory()

getPass

public boolean getPass()

Description copied from interface: iEventCord

Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent();. Implemented in csEventCord.

Specified by:

getPass in interface iEventCord

Returns:

See Also:

iEventCord.getPass()

insert

public int insert(iEventHandler handler,
                  int priority)

Description copied from interface: iEventCord

Insert an event handler into the cord. The priority defines when it will receive the event with respect to other registered event handlers. Event handlers with the same priority are handled in a first-come first-served fashion. This is significant since returning true from HandleEvent(); will stop further event processing. Implemented in csEventCord.

Specified by:

insert in interface iEventCord

Parameters:

handler -

priority -

Returns:

See Also:

iEventCord.insert(crystalspace.jbind.interfaces.iutil.event.iEventHandler, int)

remove

public void remove(iEventHandler handler)

Description copied from interface: iEventCord

Remove an event handler from the cord. Implemented in csEventCord.

Specified by:

remove in interface iEventCord

Parameters:

handler -

See Also:

iEventCord.remove(crystalspace.jbind.interfaces.iutil.event.iEventHandler)

setPass

public void setPass(boolean pass)

Description copied from interface: iEventCord

Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent();. Implemented in csEventCord

Specified by:

setPass in interface iEventCord

Parameters:

pass -

See Also:

iEventCord.setPass(boolean)