de.swm.commons.mobile.client.presenter

Class AbstractMobilePresenter

java.lang.Object

de.swm.commons.mobile.client.presenter.AbstractMobilePresenter

All Implemented Interfaces:

IMobilePresenter

public abstract class AbstractMobilePresenter
extends Object
implements IMobilePresenter

Abstract presenter class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMobilePresenter.IBackCallback Callback, when the back button is clicked.

Constructor Summary

Constructors

Constructor and Description
AbstractMobilePresenter(com.google.gwt.event.shared.EventBus eventBus) Dispatcher mit evnent Bus.
AbstractMobilePresenter(IDispatcher disp) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected com.google.gwt.event.dom.client.ClickHandler	addBackButtonNavigationHandlers(IPageWithHeader myView, AbstractMobilePresenter.IBackCallback callback) Created and adds a click handler for the back button.
protected com.google.gwt.event.dom.client.ClickHandler	addBackButtonNavigationHandlers(IPageWithHeader myView, IEvent eventToFire) Created and adds a click handler for the back button.
protected com.google.gwt.event.dom.client.ClickHandler	addBackButtonNavigationHandlers(IPageWithHeader myView, IEvent eventToFire, boolean showSpinner) Created and adds a click handler for the back button.
protected void	beforeBack() Will be called, before back action is executed.
com.google.gwt.event.dom.client.ClickHandler	createLoadingIndicatorClickHandler(com.google.gwt.event.dom.client.ClickHandler toWrap) Will create a click hanlder, which will automatically crerate a loading indicator when clicked (if loadimng indicator is globally enabled)
void	fireMobileEvent(MobileEvent eventToFire, IPage originatorPage)
IDispatcher	getDispatcher() Will return the dispatcher.
IEvent	getLeaveToEvent()
static Direction	getNextTransitionDirection() Liefert die richtung der naechsten Transition.
protected static boolean	getTransitionIsRunning() Returns {code}true{code} if a transition is currently running (in this case, goToPage() has no effect).
void	gotoPage(IPage originator, IPageWithoutHeader targetView) Generic method to switch to another page.
void	gotoPage(IPage originator, IPageWithoutHeader targetView, boolean automaticTransition, Transition transition, Direction transitionDirection) Generic method to switch to another page.
void	gotoPageWithRootAsContentArea(IPageWithoutHeader targetView) Generische trasitionsmethode fuer den Seitenwechsel.
static boolean	isAllTransitionsDisabled() Return value of transitionsFromMainViewDisabled (see setAllTransitionsDisabled(boolean) ).
boolean	isOwningViewVisible() Liefert rue wenn der vom Presenter kontollierte View sichtbar ist.
boolean	isScreenActive() Returns true if this screen is active.
boolean	isTransitionsFromMainViewDisabled() Return value of transitionsFromMainViewDisabled (see {@link #setTransitionsFromMainViewDisabled(boolean)).
LeavePageResponse	leavePageRequest() Will return the decission to leave this Page.
static void	setAllTransitionsDisabled(boolean allTransitionsDisabled) If set to {code}true{code}, no transition effect is performed when page switch originates from ANY view (i.e., in {@link #gotoPage(IPage, IPageWithoutHeader)
void	setLeaveToEvent(IEvent leaveToEvent)
void	setRootContentArea(IPage newRootContentArea, IPageWithoutHeader startupContent) Generische trasitionsmethode fuer den Seitenwechsel.
static void	setShowSpinnerBetweenTransitions(boolean showSpinnerBetweenTransitions) Enabled or disabled the spinner between transitions.
void	setTransitionsFromMainViewDisabled(boolean transitionsFromMainViewDisabled) If set to {code}true{code}, no transition effect is performed when page switch originates from main view (i.e., in #gotoPage(IPage, IPageWithoutHeader) the originator is an instance of {@link IMainView}).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMobilePresenter

public AbstractMobilePresenter(IDispatcher disp)

Default constructor.

Parameters:

disp - der dispatcher.

AbstractMobilePresenter

public AbstractMobilePresenter(com.google.gwt.event.shared.EventBus eventBus)

Dispatcher mit evnent Bus.

Parameters:

eventBus - der event bus

Method Detail

getNextTransitionDirection

public static Direction getNextTransitionDirection()

Liefert die richtung der naechsten Transition. Dieses ist normalerweise recht. Falls ein Back-Navigatiosnevent vorgemerkt ist ist es ausnahmsweise rechts.

Returns:

die Richtung des naechsten ueberganges.

setShowSpinnerBetweenTransitions

public static void setShowSpinnerBetweenTransitions(boolean showSpinnerBetweenTransitions)

Enabled or disabled the spinner between transitions.

Parameters:

showSpinnerBetweenTransitions - true if the spinner should be shown between transitions.

isAllTransitionsDisabled

public static boolean isAllTransitionsDisabled()

Return value of transitionsFromMainViewDisabled (see setAllTransitionsDisabled(boolean) ).

Returns:

value

setAllTransitionsDisabled

public static void setAllTransitionsDisabled(boolean allTransitionsDisabled)

If set to {code}true{code}, no transition effect is performed when page switch originates from ANY view (i.e., in {@link #gotoPage(IPage, IPageWithoutHeader)

Parameters:

allTransitionsDisabled - setting of allTransitionsDisabled

getDispatcher

public IDispatcher getDispatcher()

Description copied from interface: IMobilePresenter

Will return the dispatcher.

Specified by:

getDispatcher in interface IMobilePresenter

Returns:

the dispatcher.

leavePageRequest

public LeavePageResponse leavePageRequest()

Description copied from interface: IMobilePresenter

Will return the decission to leave this Page. The dafault beahviour is to leave the current Page.

Specified by:

leavePageRequest in interface IMobilePresenter

Returns:

the decission to leave the Page.

isOwningViewVisible

public boolean isOwningViewVisible()

Liefert rue wenn der vom Presenter kontollierte View sichtbar ist.

Specified by:

isOwningViewVisible in interface IMobilePresenter

Returns:

true wenn sichtbar.

gotoPage

public void gotoPage(IPage originator,
            IPageWithoutHeader targetView)

Generic method to switch to another page. Shortcut for {code}gotoPage(originator, targetView, true, null, null){code}.

Specified by:

gotoPage in interface IMobilePresenter

Parameters:

originator - the view which the event to switch the page originated from

targetView - view to switch to (usually the view of the current presenter)

gotoPage

public void gotoPage(IPage originator,
            IPageWithoutHeader targetView,
            boolean automaticTransition,
            Transition transition,
            Direction transitionDirection)

Generic method to switch to another page.

Specified by:

gotoPage in interface IMobilePresenter

Parameters:

originator - the view which the event to switch the page originated from

targetView - view to switch to (usually the view of the current presenter)

automaticTransition - whether the transition effect should be determined automatically (parameters transition, transitionDirection are ignored)

transition - transition effect ({code}null{code} for no transition effect)

transitionDirection - transition direction

gotoPageWithRootAsContentArea

public void gotoPageWithRootAsContentArea(IPageWithoutHeader targetView)

Generische trasitionsmethode fuer den Seitenwechsel.

Specified by:

gotoPageWithRootAsContentArea in interface IMobilePresenter

Parameters:

targetView - die view des aktuellen Presenters (Ziel) - als Content area des Ziels wird Root gesetzt.

setRootContentArea

public void setRootContentArea(IPage newRootContentArea,
                      IPageWithoutHeader startupContent)

Generische trasitionsmethode fuer den Seitenwechsel.

Parameters:

newRootContentArea - new root content area. All new sceens will be places as chidlern of this area.

startupContent - view which should be deplayed as content of the new root panel

fireMobileEvent

public void fireMobileEvent(MobileEvent eventToFire,
                   IPage originatorPage)

createLoadingIndicatorClickHandler

public com.google.gwt.event.dom.client.ClickHandler createLoadingIndicatorClickHandler(com.google.gwt.event.dom.client.ClickHandler toWrap)

Will create a click hanlder, which will automatically crerate a loading indicator when clicked (if loadimng indicator is globally enabled)

Parameters:

toWrap - the callback to wrap

Returns:

the wrapped click handler.

isScreenActive

public boolean isScreenActive()

Returns true if this screen is active.

Returns:

true if this screen is active.

isTransitionsFromMainViewDisabled

public boolean isTransitionsFromMainViewDisabled()

Return value of transitionsFromMainViewDisabled (see {@link #setTransitionsFromMainViewDisabled(boolean)).

Returns:

value

setTransitionsFromMainViewDisabled

public void setTransitionsFromMainViewDisabled(boolean transitionsFromMainViewDisabled)

If set to {code}true{code}, no transition effect is performed when page switch originates from main view (i.e., in #gotoPage(IPage, IPageWithoutHeader) the originator is an instance of {@link IMainView}). I.E., if the main view is a tab panel, direct navigation via the tab header does not lead to a transition effect.

Parameters:

transitionsFromMainViewDisabled - setting of transitionsFromMainViewDisabled

getLeaveToEvent

public IEvent getLeaveToEvent()

setLeaveToEvent

public void setLeaveToEvent(IEvent leaveToEvent)

addBackButtonNavigationHandlers

protected com.google.gwt.event.dom.client.ClickHandler addBackButtonNavigationHandlers(IPageWithHeader myView,
                                                                           IEvent eventToFire)

Created and adds a click handler for the back button. When the back button will be clicked the passed event will be fired (which should display the new page). ClickHandler does not show a spinner.

Parameters:

myView - currently displayed view.

eventToFire - the event to fire after the back button will be clicked.

Returns:

the created internal click handler (e.g. to fire the event manually)

addBackButtonNavigationHandlers

protected com.google.gwt.event.dom.client.ClickHandler addBackButtonNavigationHandlers(IPageWithHeader myView,
                                                                           IEvent eventToFire,
                                                                           boolean showSpinner)

Created and adds a click handler for the back button. When the back button will be clicked the passed event will be fired (which should display the new page). Optional showing of a spinner.

Parameters:

myView - currently displayed view.

eventToFire - the event to fire after the back button will be clicked.

showSpinner - Flag if spinner should be shown

Returns:

the created internal click handler (e.g. to fire the event manually)

addBackButtonNavigationHandlers

protected com.google.gwt.event.dom.client.ClickHandler addBackButtonNavigationHandlers(IPageWithHeader myView,
                                                                           AbstractMobilePresenter.IBackCallback callback)

Created and adds a click handler for the back button. When the back button will be clicked the passed callback will be executed.

Parameters:

myView - currently displayed view.

callback - the callback executed after the back button will be clicked.

Returns:

the created internal click handler (e.g. to fire the event manually)

beforeBack

protected void beforeBack()

Will be called, before back action is executed.

getTransitionIsRunning

protected static boolean getTransitionIsRunning()

Returns {code}true{code} if a transition is currently running (in this case, goToPage() has no effect).

Returns:

{code}true{code} if a transition is currently running