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

Constructor and Description
AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus peventBus) default constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract List<NavigationEntryInterface>	buildNavigation() build the navigation list.
void	buildVisibleNavigation(User puser) build the visible navigation entries.
protected com.google.gwt.safehtml.shared.SafeHtml	createMenuEntry(com.google.gwt.resources.client.ImageResource pimage, String ptext)
NavigationEntryInterface	getActiveNavigationEntryInterface() get active navigation entry interface.
List<NavigationEntryInterface>	getFullNavigationList() get full navigation list.
NavigationEntryInterface	getNavigationForToken(String ptoken) get navigation entry for given token.
List<NavigationEntryInterface>	getNavigationList() get navigation list.
void	init(Session psession)
void	onChangePlace(ChangePlaceEvent pevent) called on place changed.
void	setActiveNavigationEntryInterface(NavigationEntryInterface pactiveNavigationEntryInterface) set active navigation entry interface.
void	setActiveNavigationEntryInterface(String ptoken) set active navigation entry interface.
void	setNavigationList(List<NavigationEntryInterface> pnavigationList) set navigation list.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNavigationStructure

@Inject
public AbstractNavigationStructure(com.google.web.bindery.event.shared.EventBus peventBus)

default constructor.

Method Detail

init

@Inject
public void init(Session psession)

buildVisibleNavigation

public final void buildVisibleNavigation(User puser)

Description copied from interface: NavigationStructure

build the visible navigation entries.

Specified by:

buildVisibleNavigation in interface NavigationStructure

Parameters:

puser - 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> pnavigationList)

Description copied from interface: NavigationStructure

set navigation list.

Specified by:

setNavigationList in interface NavigationStructure

Parameters:

pnavigationList - 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 pactiveNavigationEntryInterface)

Description copied from interface: NavigationStructure

set active navigation entry interface.

Specified by:

setActiveNavigationEntryInterface in interface NavigationStructure

Parameters:

pactiveNavigationEntryInterface - the activeNavigationEntryInterface to set

setActiveNavigationEntryInterface

public final void setActiveNavigationEntryInterface(String ptoken)

Description copied from interface: NavigationStructure

set active navigation entry interface.

Specified by:

setActiveNavigationEntryInterface in interface NavigationStructure

Parameters:

ptoken - the token to set

getNavigationForToken

public final NavigationEntryInterface getNavigationForToken(String ptoken)

Description copied from interface: NavigationStructure

get navigation entry for given token.

Specified by:

getNavigationForToken in interface NavigationStructure

Parameters:

ptoken - 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 pevent)

Description copied from interface: NavigationStructure

called on place changed.

Specified by:

onChangePlace in interface ChangePlaceEvent.ChangePlaceHandler

Specified by:

onChangePlace in interface NavigationStructure

Parameters:

pevent - change place event fired on place change

createMenuEntry

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