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

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

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

Direct Known Subclasses:

OrgProposalController

public class TabbedSectionLayout
extends LayoutController
implements ConfigurableLayout

Nested Class Summary

private class

TabbedSectionLayout.TabLayout

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

private KSTitleContainerImpl	container
(package private) Enum<?>	defaultView
private boolean	loaded
private Map<String,KSMenuItemData>	menuHierarchyMap
private Map<String,String>	sectionNameTabMap
private Map<String,TabbedSectionLayout.TabLayout>	tabLayoutMap
private KSTabPanel	tabPanel
private boolean	updateableSection
private Map<String,Enum<?>>	viewEnums

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

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

TabbedSectionLayout(String controllerId)

TabbedSectionLayout(String controllerId, KSTitleContainerImpl container)

Method Summary

void	addButton(String tabKey, KSButton button)
void	addSection(String[] hierarchy, SectionView section)
void	addStartSection(SectionView section)
void	addToolbar(com.google.gwt.user.client.ui.Widget toolbar)
void	clear() Can be called to reset a view to a cleared state.
com.google.gwt.user.client.ui.HorizontalPanel	getButtonPanel(String tabKey)
KSTitleContainerImpl	getContainer()
KSButton	getNextButton(String tabKey)
SectionView	getStartSection()
<V extends Enum<?>> void	getView(V viewType, Callback<View> callback) Returns the view associated with the specified enum value.
Enum<?>	getViewEnumValue(String enumValue)
protected void	hideView(View view) Must be implemented by the subclass to hide the view.
private void	init()
boolean	isUpdateableSection()
boolean	isValid(List<ValidationResultInfo> validationResults, boolean checkCurrentSectionOnly) Check to see if current/all section(s) is valid (ie.
private boolean	isValid(List<ValidationResultInfo> validationResults, Section section)
protected void	renderView(View view) Must be implemented by the subclass to render the view.
void	setContainer(KSTitleContainerImpl container)
void	setUpdateableSection(boolean isUpdateable)
void	showDefaultView(Callback<Boolean> onReadyCallback) Shows the default view.
void	showStartSection(Callback<Boolean> onReadyCallback)
void	updateModel() Updates the model with information from this view.

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

addStartViewPopup, addView, asWidget, beforeHide, beforeShow, beforeViewChange, checkForErrors, clearAllWarnings, collectBreadcrumbNames, findParentLayout, getController, getDefaultView, getName, getStartPopup, getStartPopupView, getViewEnum, isExportButtonActive, isStartViewShowing, isValid, setController, setDefaultView, setName, setViewEnum, showExport, 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, getExportElementsFromView, 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

menuHierarchyMap

private final Map<String,KSMenuItemData> menuHierarchyMap

tabLayoutMap

private Map<String,TabbedSectionLayout.TabLayout> tabLayoutMap

sectionNameTabMap

private Map<String,String> sectionNameTabMap

loaded

private boolean loaded

viewEnums

private final Map<String,Enum<?>> viewEnums

defaultView

Enum<?> defaultView

tabPanel

private KSTabPanel tabPanel

container

private KSTitleContainerImpl container

updateableSection

private boolean updateableSection

Constructor Detail

TabbedSectionLayout

public TabbedSectionLayout(String controllerId)

TabbedSectionLayout

public TabbedSectionLayout(String controllerId,
                           KSTitleContainerImpl container)

Method Detail

init

private void init()

getContainer

public KSTitleContainerImpl getContainer()

setContainer

public void setContainer(KSTitleContainerImpl container)

getView

public <V extends Enum<?>> void getView(V viewType,
                                        Callback<View> callback)

Description copied from class: Controller

Returns the view associated with the specified enum value. See showView(V viewType) above for a full description

Overrides:

getView in class LayoutController

getViewEnumValue

public Enum<?> getViewEnumValue(String enumValue)

Overrides:

getViewEnumValue in class LayoutController

isUpdateableSection

public boolean isUpdateableSection()

setUpdateableSection

public void setUpdateableSection(boolean isUpdateable)

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

addSection

public void addSection(String[] hierarchy,
                       SectionView section)

Specified by:

addSection in interface ConfigurableLayout

addToolbar

public void addToolbar(com.google.gwt.user.client.ui.Widget toolbar)

showStartSection

public void showStartSection(Callback<Boolean> onReadyCallback)

getStartSection

public SectionView getStartSection()

addStartSection

public void addStartSection(SectionView section)

Specified by:

addStartSection in interface ConfigurableLayout

addButton

public void addButton(String tabKey,
                      KSButton button)

getButtonPanel

public com.google.gwt.user.client.ui.HorizontalPanel getButtonPanel(String tabKey)

getNextButton

public KSButton getNextButton(String tabKey)

clear

public void clear()

Description copied from interface: View

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

Specified by:

clear in interface View

Overrides:

clear in class LayoutController

updateModel

public void updateModel()

Description copied from interface: View

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

Specified by:

updateModel in interface View

Specified by:

updateModel in class LayoutController

See Also:

View.updateModel()

isValid

public boolean isValid(List<ValidationResultInfo> validationResults,
                       boolean checkCurrentSectionOnly)

Check to see if current/all section(s) is valid (ie. does not contain any errors)

Specified by:

isValid in interface ConfigurableLayout

Overrides:

isValid in class LayoutController

Parameters:

validationResults - List of validation results for the layouts model.

checkCurrentSectionOnly - true if errors should be checked on current section only, false if all sections should be checked

Returns:

true if the specified sections (all or current) has any validation errors

isValid

private boolean isValid(List<ValidationResultInfo> validationResults,
                        Section section)