KanziNativeLibrary (Kanzi Android API reference)

java.lang.Object
- com.rightware.kanzi.KanziNativeLibrary

```
public class KanziNativeLibrary
extends java.lang.Object
```
Provides control and event injection access to the native Kanzi application.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CURSOR_STATE_DOWN`
`static int`	`CURSOR_STATE_MOVE`
`static int`	`CURSOR_STATE_STATIONARY`
`static int`	`CURSOR_STATE_UP`
`static int`	`KEY_STATE_DOWN`
`static int`	`KEY_STATE_REPEAT`
`static int`	`KEY_STATE_UP`
`static int`	`SCREEN_ORIENTATION_LANDSCAPE`
`static int`	`SCREEN_ORIENTATION_PORTRAIT`
`static int`	`TOUCH_STATE_BEGIN`
`static int`	`TOUCH_STATE_CONTINUE`
`static int`	`TOUCH_STATE_END`

Constructor Summary

Constructors
Constructor and Description

KanziNativeLibrary()

Constructors
Constructor and Description
`KanziNativeLibrary()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`applicationExists()` Checks if the native Kanzi application already exists.
`static void`	`createApplication()` Creates and initializes native Kanzi application.
`static void`	`destroyApplication()` Destroys the running native Kanzi application.
`static void`	`focusEvent(boolean focusState)` Updates the focus state of the output View to the native Kanzi application.
`static void`	`haltApplication()` Halts the running native Kanzi application.
`static void`	`keyEvent(int buttonCode, int keyState, int modifiers)` Passes a key event to the native Kanzi application.
`static void`	`orientateEvent(int orientation)` Updates the new orientation of the output surface to the native Kanzi application.
`static void`	`resizeEvent(int width, int height)` After resize, updates the new dimensions of the output surface to the native Kanzi application.
`static void`	`runApplication(java.lang.Object surface)` Starts running the native Kanzi application.
`static int`	`submitTask(java.lang.Object runnable)` Submits a runnable task to Kanzi task dispatcher.
`static long`	`touchEventBegin(int cursorCount, int touchState)` Begins a set of touch events in the native Kanzi application.
`static void`	`touchEventEnd()` Ends the active set of touch events in the native Kanzi application.
`static void`	`touchEventSetCursor(long touchEvent, int index, int id, float x, float y, float pressure, float area, int cursorState)` Adds a touch event cursor to the set of touches in the native Kanzi application.
`static void`	`updateContextReference(java.lang.Object context)` Updates the native side references to current Context.
`static void`	`updateViewReference(java.lang.Object kanziView)` Updates the native side references to the Kanzi UI view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCREEN_ORIENTATION_LANDSCAPE
```
public static final int SCREEN_ORIENTATION_LANDSCAPE
```
    See Also:
    
    Constant Field Values
  - SCREEN_ORIENTATION_PORTRAIT
```
public static final int SCREEN_ORIENTATION_PORTRAIT
```
    See Also:
    
    Constant Field Values
  - TOUCH_STATE_BEGIN
```
public static final int TOUCH_STATE_BEGIN
```
    See Also:
    
    Constant Field Values
  - TOUCH_STATE_CONTINUE
```
public static final int TOUCH_STATE_CONTINUE
```
    See Also:
    
    Constant Field Values
  - TOUCH_STATE_END
```
public static final int TOUCH_STATE_END
```
    See Also:
    
    Constant Field Values
  - CURSOR_STATE_DOWN
```
public static final int CURSOR_STATE_DOWN
```
    See Also:
    
    Constant Field Values
  - CURSOR_STATE_STATIONARY
```
public static final int CURSOR_STATE_STATIONARY
```
    See Also:
    
    Constant Field Values
  - CURSOR_STATE_MOVE
```
public static final int CURSOR_STATE_MOVE
```
    See Also:
    
    Constant Field Values
  - CURSOR_STATE_UP
```
public static final int CURSOR_STATE_UP
```
    See Also:
    
    Constant Field Values
  - KEY_STATE_DOWN
```
public static final int KEY_STATE_DOWN
```
    See Also:
    
    Constant Field Values
  - KEY_STATE_UP
```
public static final int KEY_STATE_UP
```
    See Also:
    
    Constant Field Values
  - KEY_STATE_REPEAT
```
public static final int KEY_STATE_REPEAT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KanziNativeLibrary
```
public KanziNativeLibrary()
```
- Method Detail
  - createApplication
```
public static void createApplication()
                              throws java.lang.IllegalThreadStateException
```
    Creates and initializes native Kanzi application.
    
    Throws:
    
    java.lang.IllegalThreadStateException - if native application already exists.
  - applicationExists
```
public static boolean applicationExists()
```
    Checks if the native Kanzi application already exists.
    
    Returns:
    
    true if native application exists and false otherwise.
  - destroyApplication
```
public static void destroyApplication()
```
    Destroys the running native Kanzi application. The application can not be resumed. Use createApplication() to re-create the application.
  - runApplication
```
public static void runApplication(java.lang.Object surface)
                           throws java.lang.IllegalThreadStateException
```
    Starts running the native Kanzi application.
    
    Parameters:
    
    surface - A render surface from KanziView.
    
    Throws:
    
    java.lang.IllegalThreadStateException - if native application is not created or is already running.
  - haltApplication
```
public static void haltApplication()
```
    Halts the running native Kanzi application. To resume the application, call runApplication().
  - resizeEvent
```
public static void resizeEvent(int width,
                               int height)
```
    After resize, updates the new dimensions of the output surface to the native Kanzi application. The SurfaceHolder callback of KanziView calls this method internally.
    
    Parameters:
    
    width - Width of the output surface in pixels.
    
    height - Height of the output surface in pixels.
  - orientateEvent
```
public static void orientateEvent(int orientation)
```
    Updates the new orientation of the output surface to the native Kanzi application. The SurfaceHolder callback of KanziView calls this method internally.
    
    Parameters:
    
    orientation - SCREEN_ORIENTATION_LANDSCAPE or SCREEN_ORIENTATION_PORTRAIT.
  - keyEvent
```
public static void keyEvent(int buttonCode,
                            int keyState,
                            int modifiers)
```
    Passes a key event to the native Kanzi application. The KeyEvent callback of KanziView calls this method internally.
    
    Parameters:
    
    buttonCode - A key code that represents the button pressed from android.view.KeyEvent.
    
    keyState - KEY_STATE_DOWN, KEY_STATE_UP or KEY_STATE_REPEAT.
    
    modifiers - Modifier key states from android.view.KeyEvent#getMetaState().
  - focusEvent
```
public static void focusEvent(boolean focusState)
```
    Updates the focus state of the output View to the native Kanzi application. KanziView calls this method internally.
    
    Parameters:
    
    focusState - If KanziView has focus, true, otherwise false.
  - touchEventBegin
```
public static long touchEventBegin(int cursorCount,
                                   int touchState)
```
    Begins a set of touch events in the native Kanzi application. You must end the set using touchEventEnd(). KanziView calls this method internally.
    
    Parameters:
    
    cursorCount - The number of cursors to allocate.
    
    touchState - TOUCH_STATE_BEGIN, TOUCH_STATE_CONTINUE or TOUCH_STATE_END.
    
    Returns:
    
    A pointer to the currently active set of touches. 0 if the state of the native Kanzi application prevents handling of the events.
  - touchEventSetCursor
```
public static void touchEventSetCursor(long touchEvent,
                                       int index,
                                       int id,
                                       float x,
                                       float y,
                                       float pressure,
                                       float area,
                                       int cursorState)
```
    Adds a touch event cursor to the set of touches in the native Kanzi application. KanziView calls this method internally.
    
    Parameters:
    
    touchEvent - A pointer to the currently active set of touches.
    
    index - Cursor index in touchEvent.
    
    id - Cursor ID from android.view.MotionEvent#getPointerId(int).
    
    x - X coordinate of the cursor from android.view.MotionEvent#getX().
    
    y - Y coordinate of the cursor from android.view.MotionEvent#getY().
    
    pressure - Pressure of the cursor from android.view.MotionEvent#getPressure().
    
    area - Area of the cursor from @link android.view.MotionEvent#getSize()}.
    
    cursorState - CURSOR_STATE_DOWN, CURSOR_STATE_STATIONARY, CURSOR_STATE_MOVE or CURSOR_STATE_UP.
  - touchEventEnd
```
public static void touchEventEnd()
```
    Ends the active set of touch events in the native Kanzi application. KanziView calls this method internally.
  - updateViewReference
```
public static void updateViewReference(java.lang.Object kanziView)
```
    Updates the native side references to the Kanzi UI view.
    
    Parameters:
    
    kanziView - Reference to output.
  - updateContextReference
```
public static void updateContextReference(java.lang.Object context)
```
    Updates the native side references to current Context.
    
    Parameters:
    
    context - Reference to context.
  - submitTask
```
public static int submitTask(java.lang.Object runnable)
```
    Submits a runnable task to Kanzi task dispatcher. If the task dispatcher is not initialized, this function fails.
    
    Parameters:
    
    runnable - The task to be run.
    
    Returns:
    
    If run successfully, zero, otherwise non-zero.

Class KanziNativeLibrary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCREEN_ORIENTATION_LANDSCAPE

SCREEN_ORIENTATION_PORTRAIT

TOUCH_STATE_BEGIN

TOUCH_STATE_CONTINUE

TOUCH_STATE_END

CURSOR_STATE_DOWN

CURSOR_STATE_STATIONARY

CURSOR_STATE_MOVE

CURSOR_STATE_UP

KEY_STATE_DOWN

KEY_STATE_UP

KEY_STATE_REPEAT

Constructor Detail

KanziNativeLibrary

Method Detail

createApplication

applicationExists

destroyApplication

runApplication

haltApplication

resizeEvent

orientateEvent

keyEvent

focusEvent

touchEventBegin

touchEventSetCursor

touchEventEnd

updateViewReference

updateContextReference

submitTask