org.kuali.student.common.ui.client.mvc
Interface View

All Superinterfaces:

BreadcrumbSupport, HistorySupport

All Known Subinterfaces:

ToolView

All Known Implementing Classes:

AcknowledgeView, ApplicationController, BasicLayout, BasicLayoutWithContentHeader, BrowseProgramController, BrowseProgramView, CatalogBrowserController, CategoryManagementView, CluSetEditorWidget, CluSetsManagementController, ClusetView, CollaboratorSectionView, CoreController, CoreEditController, CoreViewController, CourseAdminController, CourseAdminWithoutVersionController, CourseProposalController, CourseRequirementsManageView, CourseRequirementsSummaryView, CourseRequirementsViewController, CredentialController, CredentialEditController, CredentialViewController, CurriculumHomeController, CurriculumHomeView, DecisionPanel, DelayedToolView, DelegatingViewComposite, DependencyAnalysisController, DependencyAnalysisView, DocumentTool, HomeController, HomeView, LayoutController, MajorController, MajorEditController, MajorViewController, MenuEditableSectionController, MenuSectionController, OrgProposalController, ProgramController, ProgramDocumentTool, ProgramRequirementsManageView, ProgramRequirementsSummaryView, ProgramRequirementsViewController, ProgramSelectVersionsView, ProgramVersionsController, SectionView, SelectVersionsView, ShowVersionView, TabbedSectionLayout, TabMenuController, VariationController, VariationEditController, VariationViewController, VersionsController, VersionsReqController, VerticalSectionView, ViewComposite, ViewCourseController, ViewCourseParentController

public interface View
extends HistorySupport, BreadcrumbSupport

Interface defining the operations necessary to implement a view.

Author:

Kuali Student Team

Method Summary

com.google.gwt.user.client.ui.Widget	asWidget() Get the attachable widget which represents this view
boolean	beforeHide() Called by the controller before the view is hidden to allow the view to perform cleanup or request confirmation from the user, etc.
void	beforeShow(Callback<Boolean> onReadyCallback) Called by controller before the view is displayed to allow lazy initialization or any other preparatory work to be done.
void	clear() Can be called to reset a view to a cleared state.
Controller	getController() Returns the controller associated with the view
String	getName() Returns the view's name
Enum<?>	getViewEnum()
boolean	isExportButtonActive() This method needs to be implemented only on views that want the export button to display.
void	showExport(boolean show)
void	updateModel() Updates the model with information from this view.

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

collectHistory, onHistoryEvent

Methods inherited from interface org.kuali.student.common.ui.client.mvc.breadcrumb.BreadcrumbSupport

collectBreadcrumbNames

Method Detail

beforeShow

void beforeShow(Callback<Boolean> onReadyCallback)

Called by controller before the view is displayed to allow lazy initialization or any other preparatory work to be done. Executes the callback with true if when the view is ready to be shown.

beforeHide

boolean beforeHide()

Called by the controller before the view is hidden to allow the view to perform cleanup or request confirmation from the user, etc. Can cancel the action by returning false.

Returns:

true if the view can be hidden, or false to cancel the action.

getController

Controller getController()

Returns the controller associated with the view

Returns:

getName

String getName()

Returns the view's name

Returns:

getViewEnum

Enum<?> getViewEnum()

clear

void clear()

Can be called to reset a view to a cleared state.

updateModel

void updateModel()

Updates the model with information from this view. If this view does not need to update the model leave this method empty.

asWidget

com.google.gwt.user.client.ui.Widget asWidget()

Get the attachable widget which represents this view

Returns:

See Also:

SectionView

isExportButtonActive

boolean isExportButtonActive()

This method needs to be implemented only on views that want the export button to display. The default implementation is not to display the export button

Returns:

showExport

void showExport(boolean show)