View Javadoc

1   package org.kuali.student.common.ui.client.configurable.mvc.layouts;
2   
3   import java.util.List;
4   
5   import org.kuali.student.common.ui.client.mvc.View;
6   import org.kuali.student.common.ui.client.widgets.KSButton;
7   
8   /**
9    * Interface for LayoutControllers which have navigation with menus.
10   * 
11   * @author Kuali Student Team
12   *
13   */
14  public interface ContentNavLayoutController extends DocumentLayoutController{
15  	/**
16  	 * Removes the navigation from the ui
17  	 */
18  	public void removeMenuNavigation();
19  	public void addMenu(String title);
20  	public void addMenuItem(String parentMenu, final View view);
21  	/**
22  	 * Adds a button specific to a particular view
23  	 * @param viewType
24  	 * @param button
25  	 */
26  	public void addButtonForView(Enum<?> viewType, KSButton button);
27  	/**
28  	 * Adds a button which will appear on every view underneath the scope of the
29  	 * parent menu item
30  	 * @param parentMenu
31  	 * @param button
32  	 */
33  	public void addCommonButton(String parentMenu, KSButton button);
34  	/**
35  	 * Adds a button which will appear on every view underneath the scope of the of the parent
36  	 * menu item EXCEPT not in the views specified in excludedViews
37  	 * @param parentMenu
38  	 * @param button
39  	 * @param excludedViews
40  	 */
41  	public void addCommonButton(String parentMenu, KSButton button, List<Enum<?>> excludedViews);
42  	/**
43  	 * Adds a menu item with a special style
44  	 * @param view
45  	 * @param description
46  	 */
47  	public void addSpecialMenuItem(final View view, String description);
48  }