com.helger.photon.basic.app.menu

Class MenuItemDeterminatorCallback

java.lang.Object

com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback<com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>

com.helger.photon.basic.app.menu.AbstractMenuItemDeterminatorCallback

com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

All Implemented Interfaces:

com.helger.commons.callback.ICallback, com.helger.commons.hierarchy.visit.IHierarchyVisitorCallback<com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, IMenuItemDeterminatorCallback, Serializable

public class MenuItemDeterminatorCallback
extends AbstractMenuItemDeterminatorCallback

Determine all menu items to show, depending on the currently selected menu item.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MenuItemDeterminatorCallback(IMenuTree aMenuTree, String sSelectedMenuItemID)

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.collection.ext.ICommonsMap<String,Boolean>	getAllDisplayMenuItemIDs(IMenuItemDeterminatorCallback aDeterminator)
static com.helger.commons.collection.ext.ICommonsMap<String,Boolean>	getAllDisplayMenuItemIDs(IMenuTree aMenuTree, String sSelectedMenuItemID)
com.helger.commons.collection.ext.ICommonsMap<String,Boolean>	getAllItemIDs()
static com.helger.commons.collection.ext.ICommonsMap<String,Boolean>	getAllMenuItemIDs(IMenuTree aMenuTree) Get all menu items without usage a separate MenuItemDeterminatorCallback instance.
protected boolean	isMenuItemValidToBeDisplayed(IMenuObject aMenuObj)
com.helger.commons.hierarchy.visit.EHierarchyVisitorReturn	onItemBeforeChildren(com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject> aItem)
protected void	rememberMenuItemForDisplay(String sMenuItemID, boolean bExpanded)

Methods inherited from class com.helger.photon.basic.app.menu.AbstractMenuItemDeterminatorCallback

getMenuTree

Methods inherited from class com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback

getLevel, onItemAfterChildren, onLevelDown, onLevelUp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.hierarchy.visit.IHierarchyVisitorCallback

begin, end, getLevel, onItemAfterChildren, onLevelDown, onLevelUp

Constructor Detail

MenuItemDeterminatorCallback

public MenuItemDeterminatorCallback(@Nonnull
                                    IMenuTree aMenuTree,
                                    @Nullable
                                    String sSelectedMenuItemID)

Method Detail

isMenuItemValidToBeDisplayed

@OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected boolean isMenuItemValidToBeDisplayed(@Nonnull
                                                                                                      IMenuObject aMenuObj)

rememberMenuItemForDisplay

@OverrideOnDemand
protected void rememberMenuItemForDisplay(@Nonnull @Nonempty
                                                             String sMenuItemID,
                                                             boolean bExpanded)

onItemBeforeChildren

public final com.helger.commons.hierarchy.visit.EHierarchyVisitorReturn onItemBeforeChildren(@Nonnull
                                                                                             com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject> aItem)

Specified by:

onItemBeforeChildren in interface com.helger.commons.hierarchy.visit.IHierarchyVisitorCallback<com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>

Overrides:

onItemBeforeChildren in class com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback<com.helger.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>

getAllItemIDs

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsMap<String,Boolean> getAllItemIDs()

Returns:

A map with all items to be displayed, where the key is the menu item ID and the value is the expansion state of the item.

getAllDisplayMenuItemIDs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,Boolean> getAllDisplayMenuItemIDs(@Nonnull
                                                                                                                                     IMenuTree aMenuTree,
                                                                                                                                     @Nullable
                                                                                                                                     String sSelectedMenuItemID)

getAllDisplayMenuItemIDs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,Boolean> getAllDisplayMenuItemIDs(@Nonnull
                                                                                                                                     IMenuItemDeterminatorCallback aDeterminator)

getAllMenuItemIDs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsMap<String,Boolean> getAllMenuItemIDs(@Nonnull
                                                                                                                              IMenuTree aMenuTree)

Get all menu items without usage a separate MenuItemDeterminatorCallback instance.

Parameters:

aMenuTree - The menu tree to get all items from. May not be null.

Returns:

A non-null map with all menu item IDs as keys and the "expansion state" as the value.