de.uplanet.lucy.server.auxiliaries
Class Menu

java.lang.Object
  extended by de.uplanet.lucy.server.auxiliaries.Menu

@VelocityCallable(value="singleton")
public final class Menu
extends java.lang.Object

Version:
$Revision: 70513 $

Constructor Summary
Menu()
           
 
Method Summary
 boolean alwaysCheckForNewMenu()
           
static IRtMenuFilter getAcceptingMenuFilter()
           
 IMenuItem getMenu()
          Get the menu.
 IMenuItem getMenu(IRtMenuFilter p_filter)
          Get the menu.
 java.lang.String getMenuCookie()
           
 java.util.Comparator<IMenuItem> getMenuTitleComparator(java.lang.String p_strLang)
           
static IRtMenuFilter getNamePatternMenuFilter(java.lang.String p_strLang, java.lang.String p_strPattern, boolean p_bAcceptPattern)
           
 java.util.Set<java.lang.String> getOpenNewWindowMenuItemAppGuids(java.lang.String p_strId)
          Get the application GUIDs of all applications or links of the given submenu that have the open-new-window-flag set.
 IMenuItem getSubmenu(java.lang.String p_strId)
          Get the submenu with the specified unique identifier.
 IMenuItem getSubmenu(java.lang.String p_strId, IRtMenuFilter p_filter)
          Get the submenu with the specified unique identifier.
 TopLevelGroupMenuItem getTopLevelGroupMenuFromChild(java.lang.String p_strId)
           
 boolean isMenuCookieValid(java.lang.String p_strCookie)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Menu

public Menu()
Method Detail

alwaysCheckForNewMenu

public boolean alwaysCheckForNewMenu()

isMenuCookieValid

public boolean isMenuCookieValid(java.lang.String p_strCookie)

getMenuCookie

public java.lang.String getMenuCookie()

getMenu

public IMenuItem getMenu()
Get the menu.

Returns:
The menu.

getMenu

public IMenuItem getMenu(IRtMenuFilter p_filter)
Get the menu.

Parameters:
p_filter - A menu filter to be applied to the menu tree.
Returns:
The filtered menu.

getSubmenu

public IMenuItem getSubmenu(java.lang.String p_strId)
Get the submenu with the specified unique identifier.

Parameters:
p_strId - The unique identifier of the submenu.
Returns:
The submenu.

getSubmenu

public IMenuItem getSubmenu(java.lang.String p_strId,
                            IRtMenuFilter p_filter)
Get the submenu with the specified unique identifier.

Parameters:
p_strId - The unique identifier of the submenu.
p_filter - A menu filter to be applied to the menu tree.
Returns:
The submenu.

getTopLevelGroupMenuFromChild

public TopLevelGroupMenuItem getTopLevelGroupMenuFromChild(java.lang.String p_strId)

getOpenNewWindowMenuItemAppGuids

public java.util.Set<java.lang.String> getOpenNewWindowMenuItemAppGuids(java.lang.String p_strId)
Get the application GUIDs of all applications or links of the given submenu that have the open-new-window-flag set.

Parameters:
p_strId - The unique identifier of the submenu.
Returns:
A possibly empty set of application GUIDs.

getMenuTitleComparator

public java.util.Comparator<IMenuItem> getMenuTitleComparator(java.lang.String p_strLang)

getAcceptingMenuFilter

@Customization(value="feature request #4470")
public static IRtMenuFilter getAcceptingMenuFilter()
Returns:
A menu filter that accepts all menu items.

getNamePatternMenuFilter

@Customization(value="feature request #4470")
public static IRtMenuFilter getNamePatternMenuFilter(java.lang.String p_strLang,
                                                                   java.lang.String p_strPattern,
                                                                   boolean p_bAcceptPattern)
Parameters:
p_strLang - The language to be used.
p_strPattern - A name pattern.
p_bAcceptPattern - true if menu items that match the given pattern should be accepted, or false if they should be rejected by this filter.
Returns:
A menu filter that accepts menu items that match the given criteria.


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.