io.crysknife.ui.navigation.client.local.spi

Interface PageNode<P>

public interface PageNode<P>

Represents a page (a distinct place that can be navigated to and bookmarked to return to later).

Thinking of the application flow as a directed graph, Pages are the nodes and TransitionTos are the edges.

Author:

Jonathan Fuerth

Method Summary

Modifier and Type	Method and Description
Class<P>	contentType() Returns the type of widget that this page node's produceContent(CreationalCallback) method will produce.
void	destroy(P page) Used by the framework to destroy Dependent scoped beans after a page is no longer needed.
String	getURL() Returns the URL template specified for this page by Page.path().
String	name() Returns the name of this page.
void	pageHidden(P page) Called by the framework after this page has been removed from the navigation content panel.
void	pageHiding(P page, NavigationControl control) Called by the framework when this page node is about to be removed from the navigation content panel.
void	pageShowing(P page, HistoryToken state, NavigationControl control) Called by the framework when this page node is about to be displayed in the navigation content panel.
void	pageShown(P page, HistoryToken state) Called by the framework when this page node was displayed in the navigation content panel.
void	pageUpdate(P page, HistoryToken state) Called by the framework when this page node state was updated Navigation.updateState(Multimap).
void	produceContent(CreationalCallback<P> callback) Retrieves the widget that provides this page's content from the client-side bean manager.

Method Detail

name

String name()

Returns the name of this page.

Returns:

This page's name. Never null.

getURL

String getURL()

Returns the URL template specified for this page by Page.path(). If no template is specified, it returns the page name.

Returns:

This page's URL. Never null.

produceContent

void produceContent(CreationalCallback<P> callback)

Retrieves the widget that provides this page's content from the client-side bean manager.

Parameters:

callback - The callback that will receive the widget to display for this page. The Widget will have the same runtime type as returned by contentType(), and will never be null.

contentType

Class<P> contentType()

Returns the type of widget that this page node's produceContent(CreationalCallback) method will produce.

Returns:

The type of widget that supplies this page's content. Never null.

pageShowing

void pageShowing(P page,
                 HistoryToken state,
                 NavigationControl control)

Called by the framework when this page node is about to be displayed in the navigation content panel.

If this method throws an exception when called, framework behaviour is undefined.

Parameters:

page - the page instance that was just returned from a call to produceContent(CreationalCallback). Never null.

state - the state of the page, parsed from the history token on the URL. Never null.

pageShown

void pageShown(P page,
               HistoryToken state)

Called by the framework when this page node was displayed in the navigation content panel.

If this method throws an exception when called, framework behaviour is undefined.

Parameters:

page - the page instance that was just returned from a call to produceContent(CreationalCallback). Never null.

state - the state of the page, parsed from the history token on the URL. Never null.

pageHiding

void pageHiding(P page,
                NavigationControl control)

Called by the framework when this page node is about to be removed from the navigation content panel.

If this method throws an exception when called, framework behaviour is undefined.

Parameters:

page - the page instance (which is currently in the navigation content panel) that was previously used in the call to #pageShowing(P, HistoryToken, NavigationControl). Never null.

pageHidden

void pageHidden(P page)

Called by the framework after this page has been removed from the navigation content panel.

If this method throws an exception when called, framework behaviour is undefined.

Parameters:

page - the page instance (which was in the navigation content panel) that was previously used in the call to #pageShowing(P, HistoryToken, NavigationControl). Never null.

pageUpdate

void pageUpdate(P page,
                HistoryToken state)

Called by the framework when this page node state was updated Navigation.updateState(Multimap).

If this method throws an exception when called, framework behaviour is undefined.

Parameters:

page - the page instance that was just returned from a call to produceContent(CreationalCallback). Never null.

state - the state of the page, parsed from the history token on the URL. Never null.

destroy

void destroy(P page)

Used by the framework to destroy Dependent scoped beans after a page is no longer needed. For ApplicationScoped beans this method is a noop.

Parameters:

page - The page instance that will be destroyed if it is a dependent-scoped bean. Never null.