org.kuali.student.common.ui.client.configurable.mvc.layouts
Interface ContentNavLayoutController

All Superinterfaces:

DocumentLayoutController, ViewLayoutController

All Known Subinterfaces:

WorkflowEnhancedNavController

All Known Implementing Classes:

CoreController, CoreEditController, CoreViewController, CourseAdminController, CourseAdminRetireController, CourseAdminWithoutVersionController, CourseProposalController, CredentialController, CredentialEditController, CredentialViewController, MajorController, MajorEditController, MajorProposalController, MajorViewController, MenuEditableSectionController, MenuSectionController, ProgramController, VariationController, VariationEditController, VariationViewController

public interface ContentNavLayoutController
extends DocumentLayoutController

Interface for LayoutControllers which have navigation with menus.

Author:

Kuali Student Team

Method Summary

void	addButtonForView(Enum<?> viewType, KSButton button) Adds a button specific to a particular view
void	addCommonButton(String parentMenu, KSButton button) Adds a button which will appear on every view underneath the scope of the parent menu item
void	addCommonButton(String parentMenu, KSButton button, List<Enum<?>> excludedViews) Adds a button which will appear on every view underneath the scope of the of the parent menu item EXCEPT not in the views specified in excludedViews
void	addMenu(String title)
void	addMenuItem(String parentMenu, View view)
void	addSpecialMenuItem(View view, String description) Adds a menu item with a special style
void	removeMenuNavigation() Removes the navigation from the ui

Methods inherited from interface org.kuali.student.common.ui.client.configurable.mvc.layouts.DocumentLayoutController

addContentWidget, setContentInfo, setContentTitle

Methods inherited from interface org.kuali.student.common.ui.client.configurable.mvc.layouts.ViewLayoutController

addStartViewPopup, addView, setDefaultView, showView

Method Detail

removeMenuNavigation

void removeMenuNavigation()

Removes the navigation from the ui

addMenu

void addMenu(String title)

addMenuItem

void addMenuItem(String parentMenu,
                 View view)

addButtonForView

void addButtonForView(Enum<?> viewType,
                      KSButton button)

Adds a button specific to a particular view

Parameters:

viewType -

button -

addCommonButton

void addCommonButton(String parentMenu,
                     KSButton button)

Adds a button which will appear on every view underneath the scope of the parent menu item

Parameters:

parentMenu -

button -

addCommonButton

void addCommonButton(String parentMenu,
                     KSButton button,
                     List<Enum<?>> excludedViews)

Adds a button which will appear on every view underneath the scope of the of the parent menu item EXCEPT not in the views specified in excludedViews

Parameters:

parentMenu -

button -

excludedViews -

addSpecialMenuItem

void addSpecialMenuItem(View view,
                        String description)

Adds a menu item with a special style

Parameters:

view -

description -