Package com.levigo.jadice.web.client.event

Class LoadingEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<LoadingEvent.Handler>

com.google.gwt.event.shared.GwtEvent<LoadingEvent.Handler>

com.levigo.jadice.web.client.event.JadiceEvent<LoadingEvent.Handler>

com.levigo.jadice.web.client.event.LoadingEvent

public final class LoadingEvent
extends JadiceEvent<LoadingEvent.Handler>

An Event fired to indicate that something (tiles/document) is currently loading or the loading has finished.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoadingEvent.Handler
static enum	LoadingEvent.LoadingState

Nested classes/interfaces inherited from class com.levigo.jadice.web.client.event.JadiceEvent

JadiceEvent.Type<H>

Constructor Summary

Constructors

Constructor	Description
LoadingEvent(com.google.gwt.event.shared.HasHandlers source, LoadingEvent.LoadingState loadingState, Object loadingObject)	Create a new LoadingEvent
LoadingEvent(com.google.gwt.event.shared.HasHandlers source, LoadingEvent.LoadingState loadingState, Object loadingObject, String errorMessage)	Create a new LoadingEvent

Method Summary

Modifier and Type	Method	Description
protected void	dispatch(LoadingEvent.Handler handler)
static <T> void	fire(com.google.gwt.event.shared.HasHandlers source, LoadingEvent.LoadingState loadingState, Object loadingObject)	Fires a new LoadingEvent
static <T> void	fire(com.google.gwt.event.shared.HasHandlers source, LoadingEvent.LoadingState loadingState, Object loadingObject, String errorMessage)	Fires a new LoadingEvent
com.google.gwt.event.shared.GwtEvent.Type<LoadingEvent.Handler>	getAssociatedType()
String	getErrorMessage()	If the loading failed due to an error this will return an error message or an HTTP status code.
Object	getLoadingObject()
LoadingEvent.LoadingState	getLoadingState()
String	getTag()	Deprecated. use getLoadingObject() instead
static JadiceEvent.Type<LoadingEvent.Handler>	getType()

Methods inherited from class com.levigo.jadice.web.client.event.JadiceEvent

getSource

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LoadingEvent

public LoadingEvent(com.google.gwt.event.shared.HasHandlers source,
 LoadingEvent.LoadingState loadingState,
 Object loadingObject)

Create a new LoadingEvent

Parameters:

source - the source of the event

loadingState - the LoadingEvent.LoadingState

loadingObject - the object which is/was loading for example a Tile or a Document

LoadingEvent

public LoadingEvent(com.google.gwt.event.shared.HasHandlers source,
 LoadingEvent.LoadingState loadingState,
 Object loadingObject,
 String errorMessage)

Create a new LoadingEvent

Parameters:

source - the source of the event

loadingState - the LoadingEvent.LoadingState

loadingObject - the object which is/was loading for example a Tile or a Document

errorMessage - the error message when the loading failed due to an error

Method Details

getType

public static JadiceEvent.Type<LoadingEvent.Handler> getType()

fire

public static <T> void fire(com.google.gwt.event.shared.HasHandlers source,
 LoadingEvent.LoadingState loadingState,
 Object loadingObject)

Fires a new LoadingEvent

Parameters:

source - the source of the event

loadingState - the LoadingEvent.LoadingState

loadingObject - the object which is/was loading for example a Tile or a Document

fire

public static <T> void fire(com.google.gwt.event.shared.HasHandlers source,
 LoadingEvent.LoadingState loadingState,
 Object loadingObject,
 String errorMessage)

Fires a new LoadingEvent

Parameters:

source - the source of the event

loadingState - the LoadingEvent.LoadingState

loadingObject - the object which is/was loading for example a Tile or a Document

errorMessage - the error message when the loading failed due to an error

getLoadingState

public LoadingEvent.LoadingState getLoadingState()

getLoadingObject

public Object getLoadingObject()

getErrorMessage

public String getErrorMessage()

If the loading failed due to an error this will return an error message or an HTTP status code.

In some cases the message can differ from the reason why the loading failed. This happens when loading an image via an image tag. We don't get information about the failure form the error event of the onerror-function of the image tag so we return the most likely reason by returning the fetch response.

Returns:

an error message

getTag

@Deprecated
public String getTag()

Deprecated.

use getLoadingObject() instead

Returns:

the loading object as a string or "tile" in case of tiles

dispatch

protected void dispatch(LoadingEvent.Handler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<LoadingEvent.Handler>

getAssociatedType

public com.google.gwt.event.shared.GwtEvent.Type<LoadingEvent.Handler> getAssociatedType()

Specified by:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<LoadingEvent.Handler>