1 /*
2 * $Id: IMenuCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3 *
4 */
5 package org.rcfaces.core.component.capability;
6
7 import org.rcfaces.core.component.IMenuComponent;
8 import org.rcfaces.core.component.iterator.IMenuIterator;
9
10 /**
11 * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
12 * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
13 */
14 public interface IMenuCapability {
15
16 /**
17 * Returns the top-most menu associated to the component.
18 *
19 * @return top-most menu component
20 */
21 IMenuComponent getMenu();
22
23 /**
24 * Returns the menu identified by its id from the menus associated to the
25 * component.
26 *
27 * @param menuId
28 * Id for a particular menu
29 * @return menu component
30 */
31 IMenuComponent getMenu(String menuId);
32
33 /**
34 * Returns a list of all the menus associated to the component.
35 *
36 * @return Menu iterator
37 */
38 IMenuIterator listMenus();
39 }