crystalspace.jbind.impl.csutil.csinput
Class csKeyComposer

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.csutil.csinput.csKeyComposer

All Implemented Interfaces:

iBase, iKeyComposer, iPointer

public class csKeyComposer

extends csBase

implements iKeyComposer

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csKeyComposer(iPointer nPointer)

Method Summary

static java.lang.Class	getInterfaceClass()
static java.lang.String	getInterfaceName()
static int	getInterfaceVersion()
java.lang.String	getName() Return the name of the interface
int	getVersion() Return the version of the interface
csNativeIntArray	handleKey(csKeyEventData keyEventData, csNativeIntArray buf) Handle keyboard input.
static void	initSCF()
protected boolean	isNativePointerValidSafe(long pointer)
void	resetState() Reset the composer's internal state.

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

csKeyComposer

public csKeyComposer(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

handleKey

public csNativeIntArray handleKey(csKeyEventData keyEventData,
                                  csNativeIntArray buf)

Description copied from interface: iKeyComposer

Handle keyboard input. Converts the input to characters, if possible. If the key passed in is a dead key, it will be stored internally and affect the returned data of the subsequent keypress. Parameters: keyEventData Information from a keyboard event. buf Buffer to store the output in. Should be at least contain 2 characters (however, the method will work with smaller buffers as well.) bufChars Number of characters the output buffer is actually sized. return[1] returns the number of characters written to the outpuit buffer. return[0] The type of character(s) that has been written to the output buffer.

Specified by:

handleKey in interface iKeyComposer

Parameters:

keyEventData -

buf -

Returns:

See Also:

crystalspace.jbind.interfaces.iutil.csinput.iKeyComposer#handleKey(crystalspace.jbind.impl.csutil.event.csKeyEventData, int[], int)

resetState

public void resetState()

Description copied from interface: iKeyComposer

Reset the composer's internal state. Specifically, it will clear any stored dead key - the next key won't be combined with it.

Specified by:

resetState in interface iKeyComposer

See Also:

iKeyComposer.resetState()