public abstract class

CanvasScreen

extends Screen

java.lang.Object
↳	com.neomades.app.Screen
	↳	com.neomades.graphics.CanvasScreen

Class Overview

A canvas screen is used to perform 2D drawing operations. By overriding the paint method, you can draw to the screen.

Summary

[Expand]

Inherited Constants

From class com.neomades.app.Screen

From interface com.neomades.app.Keys

From interface com.neomades.app.Orientation

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

[Expand]

Inherited Fields

From class com.neomades.app.Screen

Public Constructors
	CanvasScreen() Create a new CanvasScreen.

Public Methods
final int	getHeight() Returns the height of the canvas screen in pixels.
Rect	getScreenRect() Returns the rectangle corresponding to the screen.
final int	getWidth() Returns the width of the canvas screen in pixels.
void	refresh() Refresh the entire screen.
void	startAutoRefresh(int timer) Indicates that the screen will be refreshed at a regular interval.
void	stopAutoRefresh() Stops the screen from being automatically refreshed.

Protected Methods
View	getContent() Cannot be called for CanvasScreen.
void	onSizeChanged(int w, int h) Override this method to provide a behavior when the size of the canvas screen is changed For example, when the device is set in landscape mode.
void	onUpdate()
abstract void	paint(Graphics g) Override this method to do the painting to the screen.
void	setContent(View content) Cannot be called for CanvasScreen.

[Expand]

Inherited Methods

From class com.neomades.app.Screen

final void	applyTitleBackgroundColorToStatusBar() Configure the color of the status bar to be the same as the title bar.
View	findView(int viewId)
EventBus	getApplicationEventBus() Gets the application's eventBus if exist.
View	getContent() Gets the content of this screen.
final Controller	getController() Gets the navigation Controller instance.
Keyboard	getKeyboard() Returns a `Keyboard` instance for the current `Screen`.
final int	getOrientation() Returns the current device orientation.
ScreenParams	getScreenParams() Return the parameters.
final void	hideTitleBarLeftMenuItem() Hide the default "Home" button item that appears in the left menu of the Title Bar of the first screen in the Android version of the application.
void	onContentError(ContentError error) Called when an error has been broadcasting to this screen.
void	onContentResponse(ContentResponse response) Called when a content response has been broadcasting to this screen.
abstract void	onCreate() This method has to be overridden to initialize the screen : creation and layout of UI elements, initializations, ...
void	onDestroy() This method can be overridden to provide a specific behavior when the screen is destroyed.
void	onKeyEvent(KeyEvent keyEvent) Called when a key is dispatched to a screen.
void	onMenuAction(MenuItem item) This method can be overridden to provide a specific behavior when a item of the Menu is chosen.
void	onMenuCreate(Menu menu) This method can be overridden to retrieve the menu corresponding to this screen.
void	onOrientationChanged(int orientation) Called when the screen orientation has changed.
void	onPause() This method can be overridden to provide a specific behavior when the screen is paused.
void	onReceiveEvent(Event event) Called when this screen has received an event (inside UI-Thread).
void	onResume() This method can be overridden to provide a specific behavior when the screen is resumed, after it has been paused.
void	onTouchEvent(TouchEvent touchEvent) Called when a touch is dispatched to a screen.
void	postQuery(Query query) Posts a query to a `ContentManager`.
void	registerContentError() Registers this screen to receive all `ContentError` event's type.
void	registerEvent(String type) Registers this screen to receive the given `ContentResponse` event's type.
void	registerEvents() This method is deprecated. Use `registerContentError()` instead.
void	send(Event event) Sends an event into Application's event bus.
void	setActivityIndicatorVisible(boolean visible) Shows or hides the activity indicator.
final void	setBackButtonText(String backButtonText) Replaces the "Back" button text for the current screen.
final void	setBackButtonTextColor(Color backButtonTextColor) Changes the "Back" button text color for the current screen.
final void	setBackground(Background background) Set the background for this screen.
final void	setBackgroundColor(Color color) Sets the background color of the screen.
final void	setBackgroundImage(int imageID) Set the background image for this screen.
final void	setBackgroundImage(Image image) Set the background image for this screen.
void	setContent(int layoutResId) Sets the content of this screen, with the root view of the layout.
void	setContent(View content) Sets the content of this screen, with the view passed in parameter.
final void	setFullscreenMode(boolean fullscreen) Hides title bar and bottom toolbar.
final void	setResult(ScreenParams result) Close the screen and send result to the `ScreenResultListener`.
final void	setSupportedOrientation(int orientation) Forces the screen to be in portrait and/or landscape mode.
final void	setTitle(int resId) Sets the title of the screen, which will be displayed at the top of the screen
final void	setTitle(String title) Sets the title of the screen, which will be displayed at the top of the screen.
final void	setTitleBackground(Background background) Sets the title bar background
final void	setTitleBackgroundColor(Color bgColor) Sets the title bar background color
final void	setTitleBackgroundImage(Image image) Sets the title bar background image
final void	setTitleBackgroundImage(int resImage) Sets the title bar background image
final void	setTitleBarStyle(int style) Sets the iOS title bar style
final void	setTitleBarTranslucent(boolean translucent) Sets the title bar translucent or not
final void	setTitleBarVisible(boolean visible) Set the navigation bar (iOS), action bar (Android) or title bar visible or not without animation.
final void	setTitleBarVisibleAnimated(boolean visible) Set the navigation bar (iOS), action bar (Android) or title bar visible or not with animation.
final void	setTitleColor(Color titleColor) Sets the title text color
final void	setTitleFont(Font font) Sets the title font
void	setTitleKeepNativeCase(boolean enabled) Enables or disables the title native case.
final void	setTitleView(View view) Replaces the title view (inside the title bar) with a custom View.
void	unregisterEvent(String type) Unregisters this screen to receive the given event's type.
void	unregisterEvents() Unregisters this screen to receive all event's type.

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public Constructors

public CanvasScreen ()

Create a new CanvasScreen.

Public Methods

public final int getHeight ()

Returns the height of the canvas screen in pixels.

Returns

the height of the canvas screen in pixels

public Rect getScreenRect ()

Returns the rectangle corresponding to the screen.

Returns

the rectangle corresponding to the screen

public final int getWidth ()

Returns the width of the canvas screen in pixels.

Returns

the width of the canvas screen in pixels

public void refresh ()

Refresh the entire screen.

public void startAutoRefresh (int timer)

Indicates that the screen will be refreshed at a regular interval. this will create a timer that will refresh the screen. The timer is started when this method is called.

Parameters

timer	the time between two refresh call

public void stopAutoRefresh ()

Stops the screen from being automatically refreshed.

Protected Methods

protected View getContent ()

Cannot be called for CanvasScreen.

Returns

null

protected void onSizeChanged (int w, int h)

Override this method to provide a behavior when the size of the canvas screen is changed For example, when the device is set in landscape mode.

Parameters

w	the new canvas width
h	the new canvas height

protected void onUpdate ()

protected abstract void paint (Graphics g)

Override this method to do the painting to the screen.

Parameters

g	the graphics used to draw

protected void setContent (View content)

Cannot be called for CanvasScreen.

Parameters

content	the content of this screen

Interfaces

Classes

CanvasScreen

Class Overview

Summary

Public Constructors

public CanvasScreen ()

Public Methods

public final int getHeight ()

Returns

public Rect getScreenRect ()

Returns

public final int getWidth ()

Returns

public void refresh ()

public void startAutoRefresh (int timer)

Parameters

See Also

public void stopAutoRefresh ()

See Also

Protected Methods

protected View getContent ()

Returns

protected void onSizeChanged (int w, int h)

Parameters

protected void onUpdate ()

protected abstract void paint (Graphics g)

Parameters

protected void setContent (View content)

Parameters