com.badlogic.gdx.backends.gwt

Class GwtApplication

java.lang.Object

com.badlogic.gdx.backends.gwt.GwtApplication

All Implemented Interfaces:

Application

public abstract class GwtApplication
extends java.lang.Object
implements Application

Implementation of an Application based on GWT. Clients have to override getConfig() and createApplicationListener(). Clients can override the default loading screen via getPreloaderCallback() and implement any loading screen drawing via GWT widgets.

Author:

mzechner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GwtApplication.AgentInfo Returned by agentInfo.
static interface	GwtApplication.LoadingListener LoadingListener interface main purpose is to do some things before or after setupLoop()

Nested classes/interfaces inherited from interface com.badlogic.gdx.Application

Application.ApplicationType

Field Summary

Fields

Modifier and Type	Field and Description
protected TextArea	log

Fields inherited from interface com.badlogic.gdx.Application

LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_NONE

Constructor Summary

Constructors

Constructor and Description
GwtApplication()

Method Summary

Modifier and Type	Method and Description
void	addLifecycleListener(LifecycleListener listener) Adds a new LifecycleListener to the application.
protected void	adjustMeterPanel(Panel meterPanel, Style meterStyle) called by createPreloaderPanel(String) for overriding purpose.
static GwtApplication.AgentInfo	agentInfo() Contains precomputed information on the user-agent.
static void	consoleLog(java.lang.String message)
abstract ApplicationListener	createApplicationListener()
protected GwtAudio	createAudio()
protected Files	createFiles()
protected GwtInput	createInput(CanvasElement canvas, GwtApplicationConfiguration config)
Preloader	createPreloader()
protected PreloaderCallback	createPreloaderPanel(java.lang.String logoUrl)
void	debug(java.lang.String tag, java.lang.String message) Logs a debug message to the console or logcat
void	debug(java.lang.String tag, java.lang.String message, java.lang.Throwable exception) Logs a debug message to the console or logcat
void	error(java.lang.String tag, java.lang.String message) Logs an error message to the console or logcat
void	error(java.lang.String tag, java.lang.String message, java.lang.Throwable exception) Logs an error message to the console or logcat
void	exit() Schedule an exit from the application.
ApplicationListener	getApplicationListener()
ApplicationLogger	getApplicationLogger()
Audio	getAudio()
java.lang.String	getBaseUrl()
CanvasElement	getCanvasElement()
Clipboard	getClipboard()
abstract GwtApplicationConfiguration	getConfig()
Files	getFiles()
Graphics	getGraphics()
Input	getInput()
long	getJavaHeap()
GwtApplication.LoadingListener	getLoadingListener()
int	getLogLevel() Gets the log level.
long	getNativeHeap()
Net	getNet()
Widget	getNoWebGLSupportWidget() Override this method to return a custom widget informing the that their browser lacks support of WebGL.
Preferences	getPreferences(java.lang.String name) Returns the Preferences instance of this Application.
Preloader	getPreloader()
java.lang.String	getPreloaderBaseURL()
PreloaderCallback	getPreloaderCallback() This procedure creates the preloader panel and returns a preloader callback to update it.
Panel	getRootPanel()
Application.ApplicationType	getType()
int	getVersion()
static boolean	isMobileDevice()
void	log(java.lang.String tag, java.lang.String message) Logs a message to the console or logcat
void	log(java.lang.String tag, java.lang.String message, java.lang.Throwable exception) Logs a message to the console or logcat
void	onModuleLoad()
void	postRunnable(java.lang.Runnable runnable) Posts a Runnable on the main loop thread.
void	removeLifecycleListener(LifecycleListener listener) Removes the LifecycleListener.
void	setApplicationLogger(ApplicationLogger applicationLogger) Sets the current Application logger.
void	setLoadingListener(GwtApplication.LoadingListener loadingListener)
void	setLogLevel(int logLevel) Sets the log level.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected TextArea log

Constructor Detail

GwtApplication

public GwtApplication()

Method Detail

getConfig

public abstract GwtApplicationConfiguration getConfig()

Returns:

the configuration for the GwtApplication.

getPreloaderBaseURL

public java.lang.String getPreloaderBaseURL()

getApplicationListener

public ApplicationListener getApplicationListener()

Specified by:

getApplicationListener in interface Application

Returns:

the ApplicationListener instance

createApplicationListener

public abstract ApplicationListener createApplicationListener()

onModuleLoad

public void onModuleLoad()

getNoWebGLSupportWidget

public Widget getNoWebGLSupportWidget()

Override this method to return a custom widget informing the that their browser lacks support of WebGL.

Returns:

Widget to display when WebGL is not supported.

getRootPanel

public Panel getRootPanel()

createPreloader

public Preloader createPreloader()

getPreloaderCallback

public PreloaderCallback getPreloaderCallback()

This procedure creates the preloader panel and returns a preloader callback to update it.
You can override it to construct your own preloader animation. You can adjust the progress bar colors to your needs by overriding adjustMeterPanel(Panel, Style).
Example to use an own image (width should be around 300px) placed in webapp folder:

  public PreloaderCallback getPreloaderCallback () {
    return createPreloaderPanel(GWT.getHostPageBaseURL() + "logo_preload.png");
  }
 

Returns:

PreloaderCallback to use for preload()

createPreloaderPanel

protected PreloaderCallback createPreloaderPanel(java.lang.String logoUrl)

adjustMeterPanel

protected void adjustMeterPanel(Panel meterPanel,
                                Style meterStyle)

called by createPreloaderPanel(String) for overriding purpose. override this method to adjust the styles of the loading progress bar. Example for changing the bars padding and color:

  meterPanel.setStyleName("gdx-meter");
  meterPanel.addStyleName("nostripes");
  Style meterPanelStyle = meterPanel.getElement().getStyle();
  meterPanelStyle.setProperty("backgroundColor", "#ff0000");
  meterPanelStyle.setProperty("padding", "0px");
  meterStyle.setProperty("backgroundColor", "#ffffff");
  meterStyle.setProperty("backgroundImage", "none");
 

getGraphics

public Graphics getGraphics()

Specified by:

getGraphics in interface Application

Returns:

the Graphics instance

getAudio

public Audio getAudio()

Specified by:

getAudio in interface Application

Returns:

the Audio instance

getInput

public Input getInput()

Specified by:

getInput in interface Application

Returns:

the Input instance

getFiles

public Files getFiles()

Specified by:

getFiles in interface Application

Returns:

the Files instance

getNet

public Net getNet()

Specified by:

getNet in interface Application

Returns:

the Net instance

log

public void log(java.lang.String tag,
                java.lang.String message)

Description copied from interface: Application

Logs a message to the console or logcat

Specified by:

log in interface Application

log

public void log(java.lang.String tag,
                java.lang.String message,
                java.lang.Throwable exception)

Description copied from interface: Application

Logs a message to the console or logcat

Specified by:

log in interface Application

error

public void error(java.lang.String tag,
                  java.lang.String message)

Description copied from interface: Application

Logs an error message to the console or logcat

Specified by:

error in interface Application

error

public void error(java.lang.String tag,
                  java.lang.String message,
                  java.lang.Throwable exception)

Description copied from interface: Application

Logs an error message to the console or logcat

Specified by:

error in interface Application

debug

public void debug(java.lang.String tag,
                  java.lang.String message)

Description copied from interface: Application

Logs a debug message to the console or logcat

Specified by:

debug in interface Application

debug

public void debug(java.lang.String tag,
                  java.lang.String message,
                  java.lang.Throwable exception)

Description copied from interface: Application

Logs a debug message to the console or logcat

Specified by:

debug in interface Application

setLogLevel

public void setLogLevel(int logLevel)

Description copied from interface: Application

Sets the log level. Application.LOG_NONE will mute all log output. Application.LOG_ERROR will only let error messages through. Application.LOG_INFO will let all non-debug messages through, and Application.LOG_DEBUG will let all messages through.

Specified by:

setLogLevel in interface Application

Parameters:

logLevel - Application.LOG_NONE, Application.LOG_ERROR, Application.LOG_INFO, Application.LOG_DEBUG.

getLogLevel

public int getLogLevel()

Description copied from interface: Application

Gets the log level.

Specified by:

getLogLevel in interface Application

setApplicationLogger

public void setApplicationLogger(ApplicationLogger applicationLogger)

Description copied from interface: Application

Sets the current Application logger. Calls to Application.log(String, String) are delegated to this ApplicationLogger

Specified by:

setApplicationLogger in interface Application

getApplicationLogger

public ApplicationLogger getApplicationLogger()

Specified by:

getApplicationLogger in interface Application

Returns:

the current ApplicationLogger

getType

public Application.ApplicationType getType()

Specified by:

getType in interface Application

Returns:

what Application.ApplicationType this application has, e.g. Android or Desktop

getVersion

public int getVersion()

Specified by:

getVersion in interface Application

Returns:

the Android API level on Android, the major OS version on iOS (5, 6, 7, ..), or 0 on the desktop.

getJavaHeap

public long getJavaHeap()

Specified by:

getJavaHeap in interface Application

Returns:

the Java heap memory use in bytes

getNativeHeap

public long getNativeHeap()

Specified by:

getNativeHeap in interface Application

Returns:

the Native heap memory use in bytes

getPreferences

public Preferences getPreferences(java.lang.String name)

Description copied from interface: Application

Returns the Preferences instance of this Application. It can be used to store application settings across runs.

Specified by:

getPreferences in interface Application

Parameters:

name - the name of the preferences, must be useable as a file name.

Returns:

the preferences.

getClipboard

public Clipboard getClipboard()

Specified by:

getClipboard in interface Application

postRunnable

public void postRunnable(java.lang.Runnable runnable)

Description copied from interface: Application

Posts a Runnable on the main loop thread. In a multi-window application, the Gdx.graphics and Gdx.input values may be unpredictable at the time the Runnable is executed. If graphics or input are needed, they can be copied to a variable to be used in the Runnable. For example:

final Graphics graphics = Gdx.graphics;

Specified by:

postRunnable in interface Application

Parameters:

runnable - the runnable.

exit

public void exit()

Description copied from interface: Application

Schedule an exit from the application. On android, this will cause a call to pause() and dispose() some time in the future, it will not immediately finish your application. On iOS this should be avoided in production as it breaks Apples guidelines

Specified by:

exit in interface Application

createAudio

protected GwtAudio createAudio()

createFiles

protected Files createFiles()

createInput

protected GwtInput createInput(CanvasElement canvas,
                               GwtApplicationConfiguration config)

isMobileDevice

public static boolean isMobileDevice()

Returns:

true if application runs on a mobile device

agentInfo

public static GwtApplication.AgentInfo agentInfo()

Contains precomputed information on the user-agent. Useful for dealing with browser and OS behavioral differences. Kindly borrowed from PlayN

getBaseUrl

public java.lang.String getBaseUrl()

getPreloader

public Preloader getPreloader()

getCanvasElement

public CanvasElement getCanvasElement()

getLoadingListener

public GwtApplication.LoadingListener getLoadingListener()

setLoadingListener

public void setLoadingListener(GwtApplication.LoadingListener loadingListener)

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Description copied from interface: Application

Adds a new LifecycleListener to the application. This can be used by extensions to hook into the lifecycle more easily. The ApplicationListener methods are sufficient for application level development.

Specified by:

addLifecycleListener in interface Application

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Description copied from interface: Application

Removes the LifecycleListener.

Specified by:

removeLifecycleListener in interface Application

consoleLog

public static void consoleLog(java.lang.String message)