public interface

Activity

com.google.gwt.activity.shared.Activity
Known Indirect Subclasses

Class Overview

Implemented by objects that control a piece of user interface, with a life cycle managed by an ActivityManager, in response to PlaceChangeEvent events as the user navigates through the app.

Summary

Public Methods
abstract String mayStop()
Called when the user is trying to navigate away from this activity.
abstract void onCancel()
Called when start(AcceptsOneWidget, EventBus) has not yet replied to its callback, but the user has lost interest.
abstract void onStop()
Called when the Activity's widget has been removed from view.
abstract void start(AcceptsOneWidget panel, EventBus eventBus)
Called when the Activity should ready its widget for the user.

Public Methods

public abstract String mayStop ()

Called when the user is trying to navigate away from this activity.

Returns
  • A message to display to the user, e.g. to warn of unsaved work, or null to say nothing

public abstract void onCancel ()

Called when start(AcceptsOneWidget, EventBus) has not yet replied to its callback, but the user has lost interest.

public abstract void onStop ()

Called when the Activity's widget has been removed from view. All event handlers it registered will have been removed before this method is called.

public abstract void start (AcceptsOneWidget panel, EventBus eventBus)

Called when the Activity should ready its widget for the user. When the widget is ready (typically after an RPC response has been received), receiver should present it by calling setWidget(IsWidget) on the given panel.

Any handlers attached to the provided event bus will be de-registered when the activity is stopped, so activities will rarely need to hold on to the HandlerRegistration instances returned by addHandler(GwtEvent.Type, H).

Parameters
panel the panel to display this activity's widget when it is ready
eventBus the event bus