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

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.TabMenuController

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, ViewLayoutController, BreadcrumbSupport, HistorySupport, View, ReportExport

Direct Known Subclasses:

CatalogBrowserController, VersionsReqController, ViewCourseController

public class TabMenuController
extends LayoutController

A layout controller which provides tabs for the views added through the addTab method. If the user clicks on a tab the view is swapped.

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

protected KSDocumentHeader	header
protected com.google.gwt.user.client.ui.FlowPanel	layout
protected KSTabPanel	tabPanel

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

TabMenuController(String controllerId)

Method Summary

void	addContentWidget(com.google.gwt.user.client.ui.Widget w)
void	addTab(View view, String tabName)
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.
protected void	renderView(View view) Must be implemented by the subclass to render the view.
void	setBasicTitle(String titleText) Do not use in combination with setContentTitle
void	setContentInfo(String info)
void	setContentTitle(String title)
void	setContentWarning(String info)
void	showDefaultView(Callback<Boolean> onReadyCallback) Shows the default view.
void	showExport(boolean show)
void	showPrint(boolean show)
void	updateModel() This version of updateModel only updates from the currentView (since only one view is shown/accessed at a time).

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, 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, addStyleName, 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

showView

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

collectHistory, onHistoryEvent

Field Detail

tabPanel

protected KSTabPanel tabPanel

layout

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

header

protected KSDocumentHeader header

Constructor Detail

TabMenuController

public TabMenuController(String controllerId)

Method Detail

setBasicTitle

public void setBasicTitle(String titleText)

Do not use in combination with setContentTitle

setContentTitle

public void setContentTitle(String title)

addContentWidget

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

setContentInfo

public void setContentInfo(String info)

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

updateModel

public void updateModel()

This version of updateModel only updates from the currentView (since only one view is shown/accessed at a time). Call updateModelFromView to update from a specific view under this controller's scope.

Specified by:

updateModel in interface View

Specified by:

updateModel in class LayoutController

See Also:

View.updateModel()

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

showDefaultView

public void showDefaultView(Callback<Boolean> onReadyCallback)

Description copied from class: Controller

Shows the default view. Must be implemented by subclass, in order to define the default view.

Overrides:

showDefaultView in class LayoutController

addTab

public void addTab(View view,
                   String tabName)

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: