com.helger.photon.basic.app.menu

Class MenuTree

java.lang.Object

com.helger.commons.tree.withid.BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>

com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID<KEYTYPE,DATATYPE,com.helger.commons.tree.withid.DefaultTreeItemWithID<KEYTYPE,DATATYPE>>

com.helger.commons.tree.withid.unique.DefaultTreeWithGlobalUniqueID<String,IMenuObject>

com.helger.photon.basic.app.menu.MenuTree

All Implemented Interfaces:

com.helger.commons.parent.IChildrenProvider<com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, com.helger.commons.parent.IChildrenProviderWithID<String,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, com.helger.commons.parent.IChildrenProviderWithUniqueID<String,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, com.helger.commons.tree.IBasicTree<IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, com.helger.commons.tree.withid.ITreeWithID<String,IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, com.helger.commons.tree.withid.unique.ITreeWithGlobalUniqueID<String,IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>, IMenuOperations, IMenuTree

public class MenuTree
extends com.helger.commons.tree.withid.unique.DefaultTreeWithGlobalUniqueID<String,IMenuObject>
implements IMenuTree

Represents a single menu tree

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
MenuTree()

Method Summary

Methods

Modifier and Type	Method and Description
IMenuItemPage	createItem(IMenuItem aParent, IPage aPage) Append a new menu item below the specified parent.
IMenuItemExternal	createItem(IMenuItem aParent, String sItemID, com.helger.commons.url.ISimpleURL aURL, com.helger.commons.name.IHasDisplayText aName) Append a new menu item below the specified parent.
IMenuItemPage	createItem(String sParentID, IPage aPage) Append a new menu item below the specified parent.
IMenuItemPage	createItem(String sParentID, String sItemID, IPage aPage) Append a new menu item below the specified parent.
IMenuItemExternal	createItem(String sParentID, String sItemID, com.helger.commons.url.ISimpleURL aURL, com.helger.commons.name.IHasDisplayText aName) Append a new menu item below the specified parent.
IMenuItemPage	createRootItem(IPage aPage) Append a new menu item at root level.
IMenuItemPage	createRootItem(String sItemID, IPage aPage) Append a new menu item at root level.
IMenuItemExternal	createRootItem(String sItemID, com.helger.commons.url.ISimpleURL aURL, com.helger.commons.name.IHasDisplayText aName) Append a new menu item at root level.
IMenuSeparator	createRootSeparator() Append a new menu item separator at root level
IMenuSeparator	createSeparator(IMenuItem aParent) Append a new menu item separator as a child of the passed menu item
IMenuSeparator	createSeparator(String sParentID) Append a new menu item separator as a child of the passed menu item
boolean	equals(Object o)
List<String>	getAllDefaultMenuItemIDs()
List<IMenuItemPage>	getAllDefaultMenuItems() Get the default menu item objects in the correct order.
IMenuItemPage	getDefaultMenuItem() Get the default menu item object.
String	getDefaultMenuItemID() Get the default menu item with the highest priority.
IMenuObject	getMenuObjectOfID(String sID) Get the menu object with the specified ID
IMenuObject	getRootItemDataOfItemWithID(String sMenuItemID)
com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>	getRootItemOfItemWithID(String sMenuItemID)
int	hashCode()
void	iterateAllMenuObjects(com.helger.commons.callback.INonThrowingRunnableWithParameter<IMenuObject> aCallback) Iterate all menu objects and invoke the supplied callback.
IMenuItemPage	replaceMenuItem(IPage aNewPage) Replace an eventually existing menu item with the new one.
void	setDefaultMenuItemID(String sDefaultMenuItemID) Set the default menu item.
void	setDefaultMenuItemIDs(List<String> aDefaultMenuItemIDs) Set the default menu items in the priority order.
void	setDefaultMenuItemIDs(String... aDefaultMenuItemIDs) Set the default menu items in the priority order.
String	toString()

Methods inherited from class com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID

containsItemWithID, getAllChildren, getAllItemDatas, getAllItems, getChildCount, getChildWithID, getFactory, getItemCount, getItemDataWithID, getItemWithID, hasChildren, isItemSameOrDescendant, removeItemWithID

Methods inherited from class com.helger.commons.tree.withid.BasicTreeWithID

getRootItem

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.tree.withid.unique.ITreeWithGlobalUniqueID

containsItemWithID, getAllItemDatas, getAllItems, getItemCount, getItemDataWithID, getItemWithID, isItemSameOrDescendant, removeItemWithID

Methods inherited from interface com.helger.commons.tree.IBasicTree

getRootItem

Methods inherited from interface com.helger.commons.parent.IChildrenProviderWithID

getChildWithID

Methods inherited from interface com.helger.commons.parent.IChildrenProvider

getAllChildren, getChildCount, hasChildren

Constructor Detail

MenuTree

public MenuTree()

Method Detail

createRootSeparator

@Nonnull
public IMenuSeparator createRootSeparator()

Description copied from interface: IMenuOperations

Append a new menu item separator at root level

Specified by:

createRootSeparator in interface IMenuOperations

Returns:

The created menu item separator object. Never null.

createSeparator

@Nonnull
public IMenuSeparator createSeparator(@Nonnull
                                     String sParentID)

Description copied from interface: IMenuOperations

Append a new menu item separator as a child of the passed menu item

Specified by:

createSeparator in interface IMenuOperations

Parameters:

sParentID - The parent menu item ID to append the separator to. May not be null.

Returns:

The created menu item separator object. Never null.

createSeparator

@Nonnull
public IMenuSeparator createSeparator(@Nonnull
                                     IMenuItem aParent)

Description copied from interface: IMenuOperations

Append a new menu item separator as a child of the passed menu item

Specified by:

createSeparator in interface IMenuOperations

Parameters:

aParent - The parent menu item to append the separator to. May not be null.

Returns:

The created menu item separator object. Never null.

createRootItem

@Nonnull
public IMenuItemPage createRootItem(@Nonnull
                                   String sItemID,
                                   @Nonnull
                                   IPage aPage)

Description copied from interface: IMenuOperations

Append a new menu item at root level.

Specified by:

createRootItem in interface IMenuOperations

Parameters:

sItemID - The new menu item ID. May not be null.

aPage - The referenced page. May not be null.

Returns:

The created menu item object. Never null.

createRootItem

@Nonnull
public IMenuItemPage createRootItem(@Nonnull
                                   IPage aPage)

Description copied from interface: IMenuOperations

Append a new menu item at root level.

Specified by:

createRootItem in interface IMenuOperations

Parameters:

aPage - The referenced page. May not be null.

Returns:

The created menu item object. The ID of the menu item is the ID of the page. Never null.

createItem

@Nonnull
public IMenuItemPage createItem(@Nonnull
                               String sParentID,
                               @Nonnull
                               String sItemID,
                               @Nonnull
                               IPage aPage)

Description copied from interface: IMenuOperations

Append a new menu item below the specified parent.

Specified by:

createItem in interface IMenuOperations

Parameters:

sParentID - The parent menu item ID to append the item to. May not be null.

sItemID - The new menu item ID. May not be null.

aPage - The referenced page. May not be null.

Returns:

The created menu item object. Never null.

createItem

@Nonnull
public IMenuItemPage createItem(@Nonnull
                               String sParentID,
                               @Nonnull
                               IPage aPage)

Description copied from interface: IMenuOperations

Append a new menu item below the specified parent.

Specified by:

createItem in interface IMenuOperations

Parameters:

sParentID - The parent menu item ID to append the item to. May not be null.

aPage - The referenced page. May not be null.

Returns:

The created menu item object. The ID of the menu item is the ID of the page. Never null.

createItem

@Nonnull
public IMenuItemPage createItem(@Nonnull
                               IMenuItem aParent,
                               @Nonnull
                               IPage aPage)

Description copied from interface: IMenuOperations

Append a new menu item below the specified parent.

Specified by:

createItem in interface IMenuOperations

Parameters:

aParent - The parent menu item to append the item to. May not be null.

aPage - The referenced page. May not be null.

Returns:

The created menu item object. The ID of the menu item is the ID of the page. Never null.

createRootItem

@Nonnull
public IMenuItemExternal createRootItem(@Nonnull
                                       String sItemID,
                                       @Nonnull
                                       com.helger.commons.url.ISimpleURL aURL,
                                       @Nonnull
                                       com.helger.commons.name.IHasDisplayText aName)

Description copied from interface: IMenuOperations

Append a new menu item at root level.

Specified by:

createRootItem in interface IMenuOperations

Parameters:

sItemID - The new menu item ID. May not be null.

aURL - The referenced URL. May not be null.

aName - The name of the menu item. May not be null.

Returns:

The created menu item object. Never null.

createItem

@Nonnull
public IMenuItemExternal createItem(@Nonnull
                                   IMenuItem aParent,
                                   @Nonnull
                                   String sItemID,
                                   @Nonnull
                                   com.helger.commons.url.ISimpleURL aURL,
                                   @Nonnull
                                   com.helger.commons.name.IHasDisplayText aName)

Description copied from interface: IMenuOperations

Append a new menu item below the specified parent.

Specified by:

createItem in interface IMenuOperations

Parameters:

aParent - The parent menu item to append the item to. May not be null.

sItemID - The new menu item ID. May not be null.

aURL - The referenced URL. May not be null.

aName - The name of the menu item. May not be null.

Returns:

The created menu item object. Never null.

createItem

@Nonnull
public IMenuItemExternal createItem(@Nonnull
                                   String sParentID,
                                   @Nonnull
                                   String sItemID,
                                   @Nonnull
                                   com.helger.commons.url.ISimpleURL aURL,
                                   @Nonnull
                                   com.helger.commons.name.IHasDisplayText aName)

Description copied from interface: IMenuOperations

Append a new menu item below the specified parent.

Specified by:

createItem in interface IMenuOperations

Parameters:

sParentID - The parent menu item ID to append the item to. May not be null.

sItemID - The new menu item ID. May not be null.

aURL - The referenced URL. May not be null.

aName - The name of the menu item. May not be null.

Returns:

The created menu item object. Never null.

setDefaultMenuItemID

public void setDefaultMenuItemID(@Nullable
                        String sDefaultMenuItemID)

Description copied from interface: IMenuOperations

Set the default menu item. This is a shortcut for setDefaultMenuItemIDs (new ArrayList (sDefaultMenuItemID));. The passed menu item ID must resolve to an IMenuItemPage object.

Specified by:

setDefaultMenuItemID in interface IMenuOperations

Parameters:

sDefaultMenuItemID - The default menu item to be set. May be null.

setDefaultMenuItemIDs

public void setDefaultMenuItemIDs(@Nullable
                         String... aDefaultMenuItemIDs)

Description copied from interface: IMenuOperations

Set the default menu items in the priority order. The passed menu item IDs must resolve to IMenuItemPage objects.

Specified by:

setDefaultMenuItemIDs in interface IMenuOperations

Parameters:

aDefaultMenuItemIDs - The default menu items to be set. May be null. This array may not contain any null entries.

setDefaultMenuItemIDs

public void setDefaultMenuItemIDs(@Nullable
                         List<String> aDefaultMenuItemIDs)

Description copied from interface: IMenuOperations

Set the default menu items in the priority order. The passed menu item IDs must resolve to IMenuItemPage objects.

Specified by:

setDefaultMenuItemIDs in interface IMenuOperations

Parameters:

aDefaultMenuItemIDs - The default menu items to be set. May be null. This list may not contain any null entries.

getDefaultMenuItemID

@Nullable
public String getDefaultMenuItemID()

Description copied from interface: IMenuOperations

Get the default menu item with the highest priority. Similar to getAllDefaultMenuItemIDs().get(0).

Specified by:

getDefaultMenuItemID in interface IMenuOperations

Returns:

The default menu item ID. May be null.

getAllDefaultMenuItemIDs

@Nonnull
@ReturnsMutableCopy
public List<String> getAllDefaultMenuItemIDs()

Specified by:

getAllDefaultMenuItemIDs in interface IMenuOperations

Returns:

The default menu item IDs. May not be null but may be empty.

getDefaultMenuItem

@Nullable
public IMenuItemPage getDefaultMenuItem()

Description copied from interface: IMenuOperations

Get the default menu item object. Similar to getAllDefaultMenuItems().get(0).

Specified by:

getDefaultMenuItem in interface IMenuOperations

Returns:

null if either no default menu item is present, or the default menu item ID could not be resolved to a menu item

getAllDefaultMenuItems

@Nonnull
@ReturnsMutableCopy
public List<IMenuItemPage> getAllDefaultMenuItems()

Description copied from interface: IMenuOperations

Get the default menu item objects in the correct order.

Specified by:

getAllDefaultMenuItems in interface IMenuOperations

Returns:

The list of all default menu items, in the order as specified by IMenuOperations.setDefaultMenuItemIDs(List). Never null but may be empty.

getMenuObjectOfID

@Nullable
public IMenuObject getMenuObjectOfID(@Nullable
                                     String sID)

Description copied from interface: IMenuOperations

Get the menu object with the specified ID

Specified by:

getMenuObjectOfID in interface IMenuOperations

Parameters:

sID - The ID to be resolved. May be null.

Returns:

null if the menu item could not be resolved

iterateAllMenuObjects

public void iterateAllMenuObjects(@Nonnull
                         com.helger.commons.callback.INonThrowingRunnableWithParameter<IMenuObject> aCallback)

Description copied from interface: IMenuOperations

Iterate all menu objects and invoke the supplied callback.

Specified by:

iterateAllMenuObjects in interface IMenuOperations

Parameters:

aCallback - The callback to be supplied for each menu object. May not be null.

replaceMenuItem

@Nullable
public IMenuItemPage replaceMenuItem(@Nonnull
                                     IPage aNewPage)

Description copied from interface: IMenuOperations

Replace an eventually existing menu item with the new one. The ID of the passed page is used to determine the ID of the menu item to be replaced. The new menu item will be a MenuItemPage object.

Specified by:

replaceMenuItem in interface IMenuOperations

Parameters:

aNewPage - The page to be used instead of the existing menu item

Returns:

The create menu item or null if no such menu item exists.

getRootItemOfItemWithID

@Nullable
public com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject> getRootItemOfItemWithID(@Nullable
                                                                                                        String sMenuItemID)

Specified by:

getRootItemOfItemWithID in interface IMenuTree

getRootItemDataOfItemWithID

@Nullable
public IMenuObject getRootItemDataOfItemWithID(@Nullable
                                               String sMenuItemID)

Specified by:

getRootItemDataOfItemWithID in interface IMenuTree

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID<String,IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID<String,IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>

toString

public String toString()

Overrides:

toString in class com.helger.commons.tree.withid.unique.BasicTreeWithGlobalUniqueID<String,IMenuObject,com.helger.commons.tree.withid.DefaultTreeItemWithID<String,IMenuObject>>