to.etc.domui.state

Class UIGoto

java.lang.Object

to.etc.domui.state.UIGoto

public final class UIGoto
extends Object

Moving to other pages.

Author:

Frits Jalvingh Created on Jan 9, 2009

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_ACTION
static String	SINGLESHOT_MESSAGE Deprecated.

Method Summary

Modifier and Type	Method and Description
static void	addAction(IGotoAction action) Add a "goto action" to be executed on the page we will go-to.
static void	addActionMessage(MsgType type, String message) Add a message as a IGotoAction action.
static void	addActionMessage(UIMessage message) Add a message as a IGotoAction action.
static void	back() Move to the previously-shelved page.
static void	clearPageAndReload(Page pg, String msg) Deprecated.
static void	clearPageAndReload(Page pg, String msg, IPageParameters pp) Deprecated.
static void	clearPageAndReload(Page pg, UIMessage msg) Deprecated.
static void	clearPageAndReload(Page pg, UIMessage msg, IPageParameters pp) Deprecated.
static void	moveNew(Class<? extends UrlPage> clz) Clear the entire shelve, then goto a new page.
static void	moveNew(Class<? extends UrlPage> clz, IPageParameters pp) Clear the entire shelf, then goto a new page.
static void	moveNew(Class<? extends UrlPage> clz, Object... param) Clear the entire shelf, then goto a new page.
static void	moveSub(Class<? extends UrlPage> clz) Push (shelve) the current page, then move to a new page.
static void	moveSub(Class<? extends UrlPage> clz, ConversationContext cc, IPageParameters pp) Push (shelve) the current page, then move to a new page.
static void	moveSub(Class<? extends UrlPage> clz, IPageParameters pp) Push (shelve) the current page, then move to a new page.
static void	moveSub(Class<? extends UrlPage> clz, Object... param) Push (shelve) the current page, then move to a new page.
static void	redirect(String targeturl)
static void	reload() Destroy the current page and reload the exact same page with the same parameters as a new one.
static void	reload(Object... parameters)
static void	reload(PageParameters pp) Destroy the current page, and reload a fresh copy with fresh new parameters.
static void	replace(Class<? extends UrlPage> clz) Replace the "current" page with a new page.
static void	replace(Class<? extends UrlPage> clz, IPageParameters pp) Replace the "current" page with a new page.
static void	replace(Page pg, Class<? extends UrlPage> clz, IPageParameters pp, UIMessage msg) Replace the "current" page with a new page.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLESHOT_MESSAGE

@Deprecated
public static final String SINGLESHOT_MESSAGE

Deprecated.

See Also:

Constant Field Values

PAGE_ACTION

public static final String PAGE_ACTION

See Also:

Constant Field Values

Method Detail

reload

public static void reload()

Destroy the current page and reload the exact same page with the same parameters as a new one. This has the effect of fully refreshing all data, and reinitializing the page at it's initial state.

reload

public static void reload(@Nonnull
                          PageParameters pp)

Destroy the current page, and reload a fresh copy with fresh new parameters.

Parameters:

pp -

reload

public static void reload(@Nonnull
                          Object... parameters)

addAction

public static void addAction(@Nonnull
                             IGotoAction action)

Add a "goto action" to be executed on the page we will go-to.

Parameters:

action -

addActionMessage

public static void addActionMessage(@Nonnull
                                    UIMessage message)

Add a message as a IGotoAction action. It will be shown as a MessageFlare.

Parameters:

message -

addActionMessage

public static void addActionMessage(@Nonnull
                                    MsgType type,
                                    @Nonnull
                                    String message)

Add a message as a IGotoAction action. It will be shown as a MessageFlare.

Parameters:

type -

message -

moveSub

public static void moveSub(Class<? extends UrlPage> clz)

Push (shelve) the current page, then move to a new page. The page is parameterless, and is started in a NEW ConversationContext.

Parameters:

clz -

moveSub

public static void moveSub(Class<? extends UrlPage> clz,
                           IPageParameters pp)

Push (shelve) the current page, then move to a new page. The page is started in a NEW ConversationContext.

Parameters:

clz -

pp -

moveSub

public static void moveSub(Class<? extends UrlPage> clz,
                           Object... param)

Push (shelve) the current page, then move to a new page. The page is started in a NEW ConversationContext.

Parameters:

clz -

param - A list of parameters, in PageParameters.addParameters(Object...) format.

moveSub

public static void moveSub(Class<? extends UrlPage> clz,
                           ConversationContext cc,
                           IPageParameters pp)

Push (shelve) the current page, then move to a new page. The page JOINS the conversation context passed; if the page does not accept that conversation an exception is thrown.

Parameters:

clz -

cc -

pp -

moveNew

public static void moveNew(Class<? extends UrlPage> clz,
                           IPageParameters pp)

Clear the entire shelf, then goto a new page. The page uses a NEW ConversationContext.

Parameters:

clz -

pp -

moveNew

public static void moveNew(Class<? extends UrlPage> clz,
                           Object... param)

Clear the entire shelf, then goto a new page. The page uses a NEW ConversationContext.

Parameters:

clz -

param - A list of parameters, in PageParameters.addParameters(Object...) format.

moveNew

public static void moveNew(Class<? extends UrlPage> clz)

Clear the entire shelve, then goto a new page. The page uses a NEW ConversationContext.

Parameters:

clz -

replace

public static void replace(Class<? extends UrlPage> clz)

Replace the "current" page with a new page. The current page is destroyed; the shelve stack is not changed.

Parameters:

clz -

replace

public static void replace(Class<? extends UrlPage> clz,
                           IPageParameters pp)

Replace the "current" page with a new page. The current page is destroyed; the shelve stack is not changed.

Parameters:

clz -

pp -

replace

public static final void replace(Page pg,
                                 Class<? extends UrlPage> clz,
                                 IPageParameters pp,
                                 UIMessage msg)

Replace the "current" page with a new page. The current page is destroyed; the shelve stack is not changed. On the new page show the specified message as an UI message.

Parameters:

pg -

clz -

pp -

msg -

redirect

public static void redirect(String targeturl)

back

public static void back()

Move to the previously-shelved page. That page is UNSHELVED and activated. If the shelve is EMPTY when this call is made the application moves back to the HOME page.

clearPageAndReload

@Deprecated
public static final void clearPageAndReload(Page pg,
                                                        String msg)

Deprecated.

Deprecated - use reload() or one of it's variants instead. Destroy the current page and replace it with the new page specified. On the new page show the specified message as an ERROR message.

Parameters:

pg -

msg -

clearPageAndReload

@Deprecated
public static final void clearPageAndReload(Page pg,
                                                        String msg,
                                                        IPageParameters pp)

Deprecated.

Deprecated - use reload() or one of it's variants instead. Destroy the current page and replace it with the new page specified with provided page parameters. On the new page show the specified message as an ERROR message.

Parameters:

pg -

msg -

pp -

clearPageAndReload

@Deprecated
public static final void clearPageAndReload(Page pg,
                                                        UIMessage msg)

Deprecated.

Deprecated - use reload() or one of it's variants instead. Destroy the current page and replace it with the new page specified. On the new page show the specified message.

Parameters:

pg -

msg -

clearPageAndReload

@Deprecated
public static final void clearPageAndReload(Page pg,
                                                        UIMessage msg,
                                                        IPageParameters pp)

Deprecated.

Deprecated - use reload() or one of it's variants instead. Destroy the current page and replace it with the new page specified. On the new page show the specified message.

Parameters:

pg -

msg -

pp -