|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MenuNode
MenuNode
represents the elements of a menu topology. It can be used to get information on the title,
description, URL, etc for each node in a menu.
The tree model MenuTree
provides methods to get information about the tree topology,
i.e., which parent node has which child nodes, and return instances of MenuNode
.
The methods of MenuNode
allow to view node-specific information, i.e.,
MenuContext
.MenuContext
.
MenuTree
,
MenuProvider
This interface is designed to be implemented by clients. |
Field Summary | |
---|---|
static int |
SCOPE_GLOBAL
Deprecated. The portlet-dependent tree will not change until the portlet is either deleted from the page, or the corresponding portlet application is updated or re-installed. |
static int |
SCOPE_REQUEST
Deprecated. The menu tree of the portlet is user-specific and changes are reflected from request to request |
static int |
SCOPE_SESSION
Deprecated. The tree is user-specific and the tree will not change as long as the user is logged in. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Deprecated. Returns description of the menu tree node for the locale of the current request. |
java.lang.String |
getDescription(java.util.Locale locale)
Deprecated. Returns description of the menu tree node for a specific locale. |
java.lang.String |
getId()
Deprecated. Returns ID of the menu tree node. |
int |
getScope()
Deprecated. Returns scope of the menu tree node. |
java.lang.String |
getTitle()
Deprecated. Returns title of the menu tree node for the locale of the current request. |
java.lang.String |
getTitle(java.util.Locale locale)
Deprecated. Returns title of the menu tree node for a specific locale. |
java.lang.String |
getURL()
Deprecated. Returns URL of the menu tree node. |
Field Detail |
---|
static final int SCOPE_REQUEST
MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int)
,
getScope()
,
Constant Field Valuesstatic final int SCOPE_SESSION
MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int)
,
getScope()
,
Constant Field Valuesstatic final int SCOPE_GLOBAL
MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int)
,
getScope()
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getId()
MenuTreeTopologyCtrl.addNode(java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
,
MemoryMenuService.getMenuTree(java.lang.String, com.ibm.wps.portlet.menu.MenuContext)
java.lang.String getTitle()
null
.
MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
java.lang.String getTitle(java.util.Locale locale)
null
if the title has not been set.
locale
- locale
MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
java.lang.String getDescription()
null
.
MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
java.lang.String getDescription(java.util.Locale locale)
null
if the description has not been set.
locale
- locale
MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
java.lang.String getURL()
MenuTreeInfoCtrl.setAction(java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
,
MenuTreeInfoCtrl.addActionParameter(java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)
int getScope()
SCOPE_REQUEST
,
SCOPE_SESSION
, and SCOPE_GLOBAL
.MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |