Package de.knightsoftnet.navigation.client.ui.navigation

Class AbstractNavigationStructure

java.lang.Object

de.knightsoftnet.navigation.client.ui.navigation.AbstractNavigationStructure

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, ChangePlaceEvent.ChangePlaceHandler, NavigationStructure

Direct Known Subclasses:

DummyNavigationStructure

public abstract class AbstractNavigationStructure
extends Object
implements ChangePlaceEvent.ChangePlaceHandler, NavigationStructure

The AbstractNavigationPlace defines the methods which are used to handle navigation/menu entries.

Author:

Manfred Tremmel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus eventBus)	default constructor.
protected	AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus eventBus, String loginToken)	constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract List<NavigationEntryInterface>	buildNavigation()	build the navigation list.
final void	buildVisibleNavigation(de.knightsoftnet.gwtp.spring.shared.models.User user)	build the visible navigation entries.
protected com.google.gwt.safehtml.shared.SafeHtml	createMenuEntry(com.google.gwt.resources.client.ImageResource image, String text)
final NavigationEntryInterface	getActiveNavigationEntryInterface()	get active navigation entry interface.
final List<NavigationEntryInterface>	getFullNavigationList()	get full navigation list.
final String	getLoginToken()	get the login token.
final NavigationEntryInterface	getNavigationForToken(String token)	get navigation entry for given token.
final List<NavigationEntryInterface>	getNavigationList()	get navigation list.
void	init(Session session)
void	onChangePlace(ChangePlaceEvent event)	called on place changed.
final void	setActiveNavigationEntryInterface(NavigationEntryInterface activeNavigationEntryInterface)	set active navigation entry interface.
final void	setActiveNavigationEntryInterface(String token)	set active navigation entry interface.
final void	setLoginToken(String loginToken)	set the login token.
final void	setNavigationList(List<NavigationEntryInterface> navigationList)	set navigation list.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractNavigationStructure

@Inject
protected AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus eventBus)

default constructor.

AbstractNavigationStructure

protected AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus eventBus,
 String loginToken)

constructor.

Parameters:

eventBus - event bus

loginToken - login token

Method Details

init

@Inject
public void init(Session session)

buildVisibleNavigation

public final void buildVisibleNavigation(de.knightsoftnet.gwtp.spring.shared.models.User user)

Description copied from interface: NavigationStructure

build the visible navigation entries.

Specified by:

buildVisibleNavigation in interface NavigationStructure

Parameters:

user - the user to build navigation for

buildNavigation

protected abstract List<NavigationEntryInterface> buildNavigation()

build the navigation list.

Returns:

list of navigation entries

getFullNavigationList

public final List<NavigationEntryInterface> getFullNavigationList()

Description copied from interface: NavigationStructure

get full navigation list.

Specified by:

getFullNavigationList in interface NavigationStructure

Returns:

the fullNavigationList

getNavigationList

public final List<NavigationEntryInterface> getNavigationList()

Description copied from interface: NavigationStructure

get navigation list.

Specified by:

getNavigationList in interface NavigationStructure

Returns:

the navigationList

setNavigationList

public final void setNavigationList(List<NavigationEntryInterface> navigationList)

Description copied from interface: NavigationStructure

set navigation list.

Specified by:

setNavigationList in interface NavigationStructure

Parameters:

navigationList - the navigationList to set

getActiveNavigationEntryInterface

public final NavigationEntryInterface getActiveNavigationEntryInterface()

Description copied from interface: NavigationStructure

get active navigation entry interface.

Specified by:

getActiveNavigationEntryInterface in interface NavigationStructure

Returns:

the activeNavigationEntryInterface

setActiveNavigationEntryInterface

public final void setActiveNavigationEntryInterface(NavigationEntryInterface activeNavigationEntryInterface)

Description copied from interface: NavigationStructure

set active navigation entry interface.

Specified by:

setActiveNavigationEntryInterface in interface NavigationStructure

Parameters:

activeNavigationEntryInterface - the activeNavigationEntryInterface to set

setActiveNavigationEntryInterface

public final void setActiveNavigationEntryInterface(String token)

Description copied from interface: NavigationStructure

set active navigation entry interface.

Specified by:

setActiveNavigationEntryInterface in interface NavigationStructure

Parameters:

token - the token to set

getNavigationForToken

public final NavigationEntryInterface getNavigationForToken(String token)

Description copied from interface: NavigationStructure

get navigation entry for given token.

Specified by:

getNavigationForToken in interface NavigationStructure

Parameters:

token - the token of the place to get navigation entry for

Returns:

navigation entry for place or null if none found

onChangePlace

public void onChangePlace(ChangePlaceEvent event)

Description copied from interface: NavigationStructure

called on place changed.

Specified by:

onChangePlace in interface ChangePlaceEvent.ChangePlaceHandler

Specified by:

onChangePlace in interface NavigationStructure

Parameters:

event - change place event fired on place change

getLoginToken

public final String getLoginToken()

Description copied from interface: NavigationStructure

get the login token.

Specified by:

getLoginToken in interface NavigationStructure

Returns:

login token

setLoginToken

public final void setLoginToken(String loginToken)

Description copied from interface: NavigationStructure

set the login token.

Specified by:

setLoginToken in interface NavigationStructure

Parameters:

loginToken - login token

createMenuEntry

protected com.google.gwt.safehtml.shared.SafeHtml createMenuEntry(com.google.gwt.resources.client.ImageResource image,
 String text)