com.rightware.kanzi

Class KanziView

java.lang.Object

SurfaceView

com.rightware.kanzi.KanziView

public class KanziView
extends SurfaceView

A view that owns the native Kanzi application and provides the output surface.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.rightware.kanzi.KanziView.State	mState Current KanziView lifecycle state.
protected Surface	mSurface Valid Surface.

Constructor Summary

Constructors

Constructor and Description
KanziView(Context context) Simple constructor to use when creating a KanziView from code.
KanziView(Context context, AttributeSet attrs) Constructor that is called when inflating a KanziView from XML.

Method Summary

Modifier and Type	Method and Description
void	createNativeApplication() Lifecycle handler for Lifecycle.Event.ON_CREATE events.
void	destroyNativeApplication() Lifecycle handler for Lifecycle.Event.ON_DESTROY events.
protected void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this KanziView changes.
boolean	onKeyDown(int keyCode, KeyEvent event) A key down handler.
boolean	onKeyUp(int keyCode, KeyEvent event) A key up handler.
boolean	onTouchEvent(MotionEvent event) Handler for touches inside KanziView.
void	pauseNativeApplication() Lifecycle handler for Lifecycle.Event.ON_PAUSE events.
int	queueEvent(java.lang.Runnable runnable) Submits a runnable task to Kanzi's task dispatcher.
void	registerLifecycle(Lifecycle lifecycle) Attaches KanziView to the given Lifecycle.
void	resumeNativeApplication() Lifecycle handler for Lifecycle.Event.ON_RESUME events.
void	setOrientation(int orientation) Handler for device/display orientation changes.
void	startNativeApplication() Lifecycle handler for Lifecycle.Event.ON_START events.
void	stopNativeApplication() Lifecycle handler for Lifecycle.Event.ON_STOP events.
void	surfaceChanged(SurfaceHolder holder, int format, int width, int height) This is called immediately after any structural changes (format or size) have been made to the surface.
void	surfaceCreated(SurfaceHolder holder) This is called immediately after the surface is first created.
void	surfaceDestroyed(SurfaceHolder holder) This is called immediately before a surface is being destroyed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mState

protected com.rightware.kanzi.KanziView.State mState

Current KanziView lifecycle state.

mSurface

protected Surface mSurface

Valid Surface. The surface will be captured during the onSurfaceCreated event.

Constructor Detail

KanziView

public KanziView(Context context)

Simple constructor to use when creating a KanziView from code.

Parameters:

context - The Context the KanziView is running in, through which it can access the current theme, resources, etc.

KanziView

public KanziView(Context context,
                 AttributeSet attrs)

Constructor that is called when inflating a KanziView from XML.

Parameters:

context - The Context the KanziView is running in, through which it can access the current theme, resources, etc.

attrs - The attributes of the XML tag that is inflating the KanziView.

Method Detail

onFocusChanged

protected void onFocusChanged(boolean gainFocus,
                              int direction,
                              Rect previouslyFocusedRect)

Called by the view system when the focus state of this KanziView changes.

Parameters:

gainFocus - True if the KanziView has focus; false otherwise.

direction - The direction focus has moved when requestFocus() is called to give this KanziView focus.

previouslyFocusedRect - The rectangle, in this KanziView's coordinate system, of the previously focused view. May be null.

See Also:

android.view.View#View(Context context, AttributeSet attrs)

onKeyDown

public boolean onKeyDown(int keyCode,
                         KeyEvent event)

A key down handler. Passes the key down event to the key event handler.

Parameters:

keyCode - A key code that represents the button pressed, from android.view.KeyEvent.

event - The KeyEvent object that defines the button action.

Returns:

If the event was handled by the superclass' handler, return true.

onKeyUp

public boolean onKeyUp(int keyCode,
                       KeyEvent event)

A key up handler. Passes the key up event to the key event handler.

Parameters:

keyCode - A key code that represents the button pressed, from android.view.KeyEvent.

event - The KeyEvent object that defines the button action.

Returns:

If the event was handled by the superclass' handler, return true.

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

Handler for touches inside KanziView. Translates the received events into the native library's touch states.

Parameters:

event - The motion event.

Returns:

True, always as this is the only touch handler for KanziView.

registerLifecycle

public void registerLifecycle(Lifecycle lifecycle)

Attaches KanziView to the given Lifecycle.

Parameters:

lifecycle - The lifecycle to attach to.

createNativeApplication

public void createNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_CREATE events. Loads the native library providing all Kanzi functionality. Initializes the context and assigns this KanziView for rendering. Creates Kanzi application which loads the Kanzi project.

destroyNativeApplication

public void destroyNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_DESTROY events. Halts and destroys the Kanzi application.

startNativeApplication

public void startNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_START events. Runs the Kanzi application if a surface has already been received.

stopNativeApplication

public void stopNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_STOP events. Stops the Kanzi application.

resumeNativeApplication

public void resumeNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_RESUME events. Logs the event.

pauseNativeApplication

public void pauseNativeApplication()

Lifecycle handler for Lifecycle.Event.ON_PAUSE events. Logs the event.

surfaceChanged

public void surfaceChanged(SurfaceHolder holder,
                           int format,
                           int width,
                           int height)

This is called immediately after any structural changes (format or size) have been made to the surface. This method is always called at least once, after surfaceCreated(SurfaceHolder).

Parameters:

holder - The SurfaceHolder whose surface has changed.

format - The new PixelFormat of the surface.

width - The new width of the surface.

height - The new height of the surface.

surfaceCreated

public void surfaceCreated(SurfaceHolder holder)

This is called immediately after the surface is first created. Passes the created surface to the native library for rendering target.

Parameters:

holder - The SurfaceHolder whose surface is being created.

surfaceDestroyed

public void surfaceDestroyed(SurfaceHolder holder)

This is called immediately before a surface is being destroyed.

Parameters:

holder - The SurfaceHolder whose surface is being destroyed.

queueEvent

public int queueEvent(java.lang.Runnable runnable)

Submits a runnable task to Kanzi's task dispatcher. This function fails if the task dispatcher is not yet initialized.

Parameters:

runnable - The task to be run.

Returns:

Zero on success, non-zero on failure.

setOrientation

public void setOrientation(int orientation)

Handler for device/display orientation changes. Translates the received orientation qualifiers into the native library's orientation constants.

Parameters:

orientation - The orientation qualifier from onOrientationChanged().