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

Class MenuSectionController

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

org.kuali.student.common.ui.client.mvc.Controller

org.kuali.student.common.ui.client.configurable.mvc.LayoutController

org.kuali.student.common.ui.client.configurable.mvc.layouts.MenuSectionController

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget, ContentNavLayoutController, DocumentLayoutController, ViewLayoutController, BreadcrumbSupport, HistorySupport, View, ReportExport

Direct Known Subclasses:

MenuEditableSectionController, ProgramController

public class MenuSectionController
extends LayoutController
implements ContentNavLayoutController

A layout controller which generates a menu for views that added to it through addMenuItem calls. The user can click on items in the menu to show the view.

Author:

Kuali Student Team

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gwt.user.client.ui.VerticalPanel	leftPanel
protected KSBlockMenuImpl	menu
protected Map<String,List<View>>	menuViewMap
protected com.google.gwt.user.client.ui.FlowPanel	rightPanel
protected List<KSMenuItemData>	topLevelMenuItems
protected Map<Enum<?>,KSMenuItemData>	viewMenuItemMap

Fields inherited from class org.kuali.student.common.ui.client.configurable.mvc.LayoutController

defaultView, name, startPopupView, startViewWindow, viewEnumMap, viewMap, viewType

Fields inherited from class org.kuali.student.common.ui.client.mvc.Controller

context, NO_OP_CALLBACK, parentController

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Fields inherited from interface org.kuali.student.common.ui.client.reporting.ReportExport

exportTemplateName

Constructor Summary

Constructors

Constructor and Description
MenuSectionController()

Method Summary

Methods

Modifier and Type	Method and Description
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	addContentWidget(com.google.gwt.user.client.ui.Widget w)
void	addInfoWidget(com.google.gwt.user.client.ui.Widget w)
void	addMenu(String title)
void	addMenuItem(String parentMenu, View view) Adds a view whose view name will appear as a link on the menu, the view will be shown when this item is clicked.
void	addSpecialMenuItem(View view, String description) This adds a special item that is a top level menu item to the menu, this will appear directly below other menus that are currently added to the menu.
void	addStartMenuItem(String parentMenu, View view) Adds a view whose view the menu at first.
void	addStyleName(String style)
void	addTopButtonForView(Enum<?> viewType, KSButton button)
List<ExportElement>	getExportElementsFromView() This method returns array of ExportElements which represent the elements on the view that must be exported
protected void	hideView(View view) Must be implemented by the subclass to hide the view.
void	removeMenuNavigation() Removes the navigation from the ui
protected void	renderView(View view) Must be implemented by the subclass to render the view.
void	revealMenuItems()
void	setContentInfo(String info)
void	setContentTitle(String title)
void	setContentWarning(String info)
void	setSideBarWidget(com.google.gwt.user.client.ui.Widget w)
void	showExport(boolean show)
void	showNextViewOnMenu()
void	showPrint(boolean show)
void	updateModel() This version of updateModel only traverses views that can be accessed through its menu.

Methods inherited from class org.kuali.student.common.ui.client.configurable.mvc.LayoutController

addStartViewPopup, addView, asWidget, beforeHide, beforeShow, beforeViewChange, checkForErrors, clear, clearAllWarnings, collectBreadcrumbNames, findParentLayout, getController, getDefaultView, getName, getStartPopup, getStartPopupView, getView, getViewEnum, getViewEnumValue, isExportButtonActive, isStartViewShowing, isValid, isValid, setController, setDefaultView, setName, setViewEnum, showDefaultView, showFirstView, showStartPopup, showWarnings, updateModelFromCurrentView, updateModelFromView

Methods inherited from class org.kuali.student.common.ui.client.mvc.Controller

addApplicationEventHandler, collectHistory, doReportExport, findController, fireApplicationEvent, fireNavigationEvent, getCurrentView, getCurrentViewEnum, getDefaultModelId, getExportDataModel, getExportTemplateName, getHistoryToken, getParentController, getView, getViewContext, onHistoryEvent, registerModel, requestModel, requestModel, requestModel, resetCurrentView, setCurrentViewEnum, setDefaultModelId, setParentController, setViewContext, showView, showView

Methods inherited from class com.google.gwt.user.client.ui.Composite

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addStartViewPopup, addView, setDefaultView, showView

Methods inherited from interface org.kuali.student.common.ui.client.mvc.history.HistorySupport

collectHistory, onHistoryEvent

Field Detail

menu

protected KSBlockMenuImpl menu

topLevelMenuItems

protected List<KSMenuItemData> topLevelMenuItems

menuViewMap

protected Map<String,List<View>> menuViewMap

viewMenuItemMap

protected Map<Enum<?>,KSMenuItemData> viewMenuItemMap

rightPanel

protected com.google.gwt.user.client.ui.FlowPanel rightPanel

leftPanel

protected com.google.gwt.user.client.ui.VerticalPanel leftPanel

Constructor Detail

MenuSectionController

public MenuSectionController()

Method Detail

removeMenuNavigation

public void removeMenuNavigation()

Description copied from interface: ContentNavLayoutController

Removes the navigation from the ui

Specified by:

removeMenuNavigation in interface ContentNavLayoutController

setContentTitle

public void setContentTitle(String title)

Specified by:

setContentTitle in interface DocumentLayoutController

addContentWidget

public void addContentWidget(com.google.gwt.user.client.ui.Widget w)

Specified by:

addContentWidget in interface DocumentLayoutController

addInfoWidget

public void addInfoWidget(com.google.gwt.user.client.ui.Widget w)

setSideBarWidget

public void setSideBarWidget(com.google.gwt.user.client.ui.Widget w)

setContentInfo

public void setContentInfo(String info)

Specified by:

setContentInfo in interface DocumentLayoutController

setContentWarning

public void setContentWarning(String info)

showPrint

public void showPrint(boolean show)

showExport

public void showExport(boolean show)

Specified by:

showExport in interface View

Overrides:

showExport in class LayoutController

addCommonButton

public void addCommonButton(String parentMenu,
                   KSButton button)

Description copied from interface: ContentNavLayoutController

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

Specified by:

addCommonButton in interface ContentNavLayoutController

See Also:

ContentNavLayoutController.addCommonButton(java.lang.String, org.kuali.student.common.ui.client.widgets.KSButton)

addCommonButton

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

Description copied from interface: ContentNavLayoutController

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

Specified by:

addCommonButton in interface ContentNavLayoutController

See Also:

ContentNavLayoutController.addCommonButton(java.lang.String, org.kuali.student.common.ui.client.widgets.KSButton, java.util.List)

showNextViewOnMenu

public void showNextViewOnMenu()

addButtonForView

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

Description copied from interface: ContentNavLayoutController

Adds a button specific to a particular view

Specified by:

addButtonForView in interface ContentNavLayoutController

addTopButtonForView

public void addTopButtonForView(Enum<?> viewType,
                       KSButton button)

hideView

protected void hideView(View view)

Description copied from class: Controller

Must be implemented by the subclass to hide the view.

Specified by:

hideView in class Controller

renderView

protected void renderView(View view)

Description copied from class: Controller

Must be implemented by the subclass to render the view.

Specified by:

renderView in class Controller

addMenu

public void addMenu(String title)

Specified by:

addMenu in interface ContentNavLayoutController

addStartMenuItem

public void addStartMenuItem(String parentMenu,
                    View view)

Adds a view whose view the menu at first. addMenuItem() should not be called before this method if it is intended for this to be the first view the user sees. revealMenuItems() must be called to show any items that were added after this call. IMPORTANT: the order in which you call this method, addMenuItem and addSpecialMenuItem affects the order in which they appear on the menu, but also the order in which they are shown when the showNextViewOnMenu is called. Care must be taken when calling these methods to insure a consistent/logical UI.

revealMenuItems

public void revealMenuItems()

addMenuItem

public void addMenuItem(String parentMenu,
               View view)

Adds a view whose view name will appear as a link on the menu, the view will be shown when this item is clicked. IMPORTANT: the order in which you call addMenuItem and addSpecialMenuItem affects the order in which they appear on the menu, but also the order in which they are shown when the showNextViewOnMenu is called. Care must be taken when calling these methods to insure a consistent/logical UI.

Specified by:

addMenuItem in interface ContentNavLayoutController

addSpecialMenuItem

public void addSpecialMenuItem(View view,
                      String description)

This adds a special item that is a top level menu item to the menu, this will appear directly below other menus that are currently added to the menu. This menu item has special styling to make it more apparent on the menu visually. IMPORTANT: the order in which you call addMenuItem and addSpecialMenuItem affects the order in which they appear on the menu, but also the order in which they are shown when the showNextViewOnMenu is called. Care must be taken when calling these methods to insure a consistent/logical UI.

Specified by:

addSpecialMenuItem in interface ContentNavLayoutController

updateModel

public void updateModel()

This version of updateModel only traverses views that can be accessed through its menu. Views that are part of this controller, but not part of the menu, can update their views through updateModelFromCurrentView and updateModelFromView methods.

Specified by:

updateModel in interface View

Specified by:

updateModel in class LayoutController

See Also:

View.updateModel()

getExportElementsFromView

public List<ExportElement> getExportElementsFromView()

Description copied from interface: ReportExport

This method returns array of ExportElements which represent the elements on the view that must be exported

Specified by:

getExportElementsFromView in interface ReportExport

Overrides:

getExportElementsFromView in class Controller

Returns:

addStyleName

public void addStyleName(String style)

Overrides:

addStyleName in class com.google.gwt.user.client.ui.UIObject