|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MenuTree
MenuTree
provides information about the portlet specific entries to the portal navigation.
The MenuProvider
interface may directly be exposed by a portlet and is used to query a portlet
specific MenuTree
.
The tree model MenuTree
provides methods to get information about the tree topology,
i.e.:
MenuTree
only describes the logical topology of the
menu. It does not necessarily need to be backed by an in-memory implementation but may also be
generated on-the-fly.MenuTree
needs to guarantee that the individual MenuNode
s that
logically represent the same item in the menu structure be represented by the same JAVA object.
A MenuTree
provides read-only operations to the topology only. Some implementations however
may support a dynamic modification of the menu. In such cases the implementor of the MenuTree
may implement special controller interfaces together with the MenuTree
interface. Currently
portlet menus define the following generic controller interfaces: MenuTreeInfoCtrl
,
MenuTreeInfoCopyCtrl
, MenuTreeTopologyCtrl
. Controller interfaces are optional interfaces.
This interface is designed to be implemented by clients. |
Method Summary | |
---|---|
java.util.Iterator |
getChildren(MenuNode menuNode)
Deprecated. Returns an iterator over all children of the specified menu node. |
MenuNode |
getRoot()
Deprecated. Returns the root node of this tree. |
boolean |
hasChildren(MenuNode menuNode)
Deprecated. Returns true if the specified menu node has children. |
Method Detail |
---|
MenuNode getRoot() throws MenuTreeException
MenuTreeException
- if operation failsboolean hasChildren(MenuNode menuNode)
menuNode
- menu node which can have children
java.util.Iterator getChildren(MenuNode menuNode) throws MenuTreeException
MenuNode
interface.
If the specific node does not have any children, the implementor of MenuTree
is
free to either retun null or an empty iterator. It is recommended to use the hasChildren(com.ibm.wps.portlet.menu.MenuNode)
method to evaluate the existence of children before calling this method.
menuNode
- menu node which can have children
MenuNode
s or null
MenuTreeException
- if operation fails or the menuNode
is not part of the current tree topology
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |