com.helger.photon.basic.app.menu

Interface IMenuOperations

All Known Subinterfaces:

IMenuTree

All Known Implementing Classes:

MenuTree

public interface IMenuOperations

Contains all the menu-specific menu operations. This is not meant to be publically used. The IMenuTree should be used instead.

Author:

philip

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
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
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.

Method Detail

createRootSeparator

@Nonnull
IMenuSeparator createRootSeparator()

Append a new menu item separator at root level

Returns:

The created menu item separator object. Never null.

createSeparator

@Nonnull
IMenuSeparator createSeparator(@Nonnull
                                     String sParentID)

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

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createSeparator

@Nonnull
IMenuSeparator createSeparator(@Nonnull
                                     IMenuItem aParent)

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

Parameters:

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

Returns:

The created menu item separator object. Never null.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createRootItem

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

Append a new menu item at root level.

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
IMenuItemPage createRootItem(@Nonnull
                                   IPage aPage)

Append a new menu item at root level.

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
IMenuItemPage createItem(@Nonnull
                               String sParentID,
                               @Nonnull
                               String sItemID,
                               @Nonnull
                               IPage aPage)

Append a new menu item below the specified parent.

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createItem

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

Append a new menu item below the specified parent.

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createItem

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

Append a new menu item below the specified parent.

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createRootItem

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

Append a new menu item at root level.

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
IMenuItemExternal createItem(@Nonnull
                                   IMenuItem aParent,
                                   @Nonnull
                                   String sItemID,
                                   @Nonnull
                                   com.helger.commons.url.ISimpleURL aURL,
                                   @Nonnull
                                   com.helger.commons.name.IHasDisplayText aName)

Append a new menu item below the specified parent.

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

createItem

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

Append a new menu item below the specified parent.

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.

Throws:

IllegalArgumentException - If the passed parent menu item could not be resolved

setDefaultMenuItemID

void setDefaultMenuItemID(@Nullable
                        String sDefaultMenuItemID)

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.

Parameters:

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

setDefaultMenuItemIDs

void setDefaultMenuItemIDs(@Nullable
                         String... aDefaultMenuItemIDs)

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

Parameters:

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

setDefaultMenuItemIDs

void setDefaultMenuItemIDs(@Nullable
                         List<String> aDefaultMenuItemIDs)

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

Parameters:

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

getDefaultMenuItemID

@Nullable
String getDefaultMenuItemID()

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

Returns:

The default menu item ID. May be null.

getAllDefaultMenuItemIDs

@Nonnull
@ReturnsMutableCopy
List<String> getAllDefaultMenuItemIDs()

Returns:

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

getDefaultMenuItem

@Nullable
IMenuItemPage getDefaultMenuItem()

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

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
List<IMenuItemPage> getAllDefaultMenuItems()

Get the default menu item objects in the correct order.

Returns:

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

getMenuObjectOfID

@Nullable
IMenuObject getMenuObjectOfID(@Nullable
                                     String sID)

Get the menu object with the specified ID

Parameters:

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

Returns:

null if the menu item could not be resolved

iterateAllMenuObjects

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

Iterate all menu objects and invoke the supplied callback.

Parameters:

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

replaceMenuItem

@Nullable
IMenuItemPage replaceMenuItem(@Nonnull
                                     IPage aNewPage)

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.

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.