com.ansca.corona

Class CoronaView

java.lang.Object

FrameLayout

com.ansca.corona.CoronaView

public class CoronaView
extends FrameLayout

The view the that will display the Corona content.

See Also:

FrameLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CoronaView.CoronaEventListener The object that will be called when an event is sent from lua to a CoronaView.
static interface	CoronaView.SendEventListener The callback from calls to sendEvent().

Constructor Summary

Constructors

Constructor and Description
CoronaView(Context context)
CoronaView(Context context, AttributeSet attrs)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Deinitializes the CoronaView and releases the resources associated with the CoronaView.
void	init() Initalizes the CoronaView so that it can be used.
void	init(String baseDir) Initalizes the CoronaView so that it can be used.
protected void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
protected Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	pause() Pauses the CoronaView, stopping rendering.
void	resume() Starts rendering the CoronaView.
void	sendEvent(Hashtable<Object,Object> hashtable) Dispatches the given hash table as a Lua runtime event, to be received by Lua listeners that have been registered via the Runtime:addEventListener() function.
void	sendEvent(Hashtable<Object,Object> hashtable, CoronaView.SendEventListener listener) Dispatches the given hash table as a Lua runtime event, to be received by Lua listeners that have been registered via the Runtime:addEventListener() function.
void	setCoronaEventListener(CoronaView.CoronaEventListener listener) Registers a CoronaEventListener to be called when coronaView events are fired from lua.
void	setOnKeyListener(View.OnKeyListener listener) Register a callback to be invoked when a hardware key is pressed in this CoronaView.
void	setZOrderMediaOverlay(boolean isMediaOverlay) Control whether the GLSurfaceView's surface is placed on top of another regular SurfaceView in the Window (but still behind the Window itself).

Methods inherited from class java.lang.Object

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

Constructor Detail

CoronaView

public CoronaView(Context context)

CoronaView

public CoronaView(Context context,
          AttributeSet attrs)

Method Detail

onRestoreInstanceState

protected void onRestoreInstanceState(Parcelable state)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().

This function will never be called with a null state.

Parameters:

state - The frozen state that had previously been returned by onSaveInstanceState().

onSaveInstanceState

protected Parcelable onSaveInstanceState()

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a TextView (but usually not the text itself since that is stored in a ContentProvider or other persistent storage), the currently selected item in a list view.

Returns:

Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

init

public void init()

Initalizes the CoronaView so that it can be used. Uses the base "assets" directory as the base Corona project directory.

This must be the first function you call!

init

public void init(String baseDir)

Initalizes the CoronaView so that it can be used.

This must be the first function you call!

Parameters:

baseDir - The directory of the Corona project relative to the "assests" directory.

setOnKeyListener

public void setOnKeyListener(View.OnKeyListener listener)

Register a callback to be invoked when a hardware key is pressed in this CoronaView. Key presses in software input methods will generally not trigger the methods of this listener.

Parameters:

listener - The key listener to attach to this CoronaView.

resume

public void resume()

Starts rendering the CoronaView.

pause

public void pause()

Pauses the CoronaView, stopping rendering.

Do not call before calling init()!

setZOrderMediaOverlay

public void setZOrderMediaOverlay(boolean isMediaOverlay)

Control whether the GLSurfaceView's surface is placed on top of another regular SurfaceView in the Window (but still behind the Window itself). This is typically used to place overlays on top of an underlying media SurfaceView.

Note: This must be set before the GLSurfaceView's containing Window is attached to the WindowManager.

destroy

public void destroy()

Deinitializes the CoronaView and releases the resources associated with the CoronaView.

setCoronaEventListener

public void setCoronaEventListener(CoronaView.CoronaEventListener listener)

Registers a CoronaEventListener to be called when coronaView events are fired from lua.

Parameters:

listener - The CoronaEventListener to invoke for coronaView events.

See Also:

Native/Lua Communication

sendEvent

public void sendEvent(Hashtable<Object,Object> hashtable)

Dispatches the given hash table as a Lua runtime event, to be received by Lua listeners that have been registered via the Runtime:addEventListener() function.

Parameters:

hashtable - A Hashtable which will be converted to a lua table and dispatched.

Must contain an entry with a key set to "name" and value set to the unique name of the event to be received by a Lua listener.

See Also:

Native/Lua Communication

sendEvent

public void sendEvent(Hashtable<Object,Object> hashtable,
             CoronaView.SendEventListener listener)

Dispatches the given hash table as a Lua runtime event, to be received by Lua listeners that have been registered via the Runtime:addEventListener() function.

Parameters:

hashtable - A Hashtable which will be converted to a lua table and dispatched.

Must contain an entry with a key set to "name" and value set to the unique name of the event to be received by a Lua listener.

listener - SendEventListener where the result of sendEvent() will be sent.

The result will be send on the thread which called CoronaView.init().

See Also:

Native/Lua Communication