org.kuali.student.common.ui.client.widgets.menus

Class KSMenu

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.widgets.menus.KSMenu

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

Direct Known Subclasses:

KSBasicMenuAbstract

public abstract class KSMenu
extends com.google.gwt.user.client.ui.Composite

KSMenu is the abstract class which is used to describe widgets which are menu based in ks-commons.

Author:

Kuali Student Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KSMenu.MenuImageLocation

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 List<KSMenuItemData>	items

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
KSMenu()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	clearSelected() Deselects the current selected menu item
List<KSMenuItemData>	getItems() Gets the list of KSMenuItemData used in this menu.
protected abstract void	populateMenu()
abstract boolean	selectMenuItem(String[] hierarchy)
void	setItems(List<KSMenuItemData> items) Sets the list of KSMenuItemData to be used in this menu and populates it.

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

Field Detail

items

protected List<KSMenuItemData> items

Constructor Detail

KSMenu

public KSMenu()

Method Detail

setItems

public void setItems(List<KSMenuItemData> items)

Sets the list of KSMenuItemData to be used in this menu and populates it.

Parameters:

items - list of KSMenuItemData to be used and populated into the menu

getItems

public List<KSMenuItemData> getItems()

Gets the list of KSMenuItemData used in this menu.

Returns:

the list of KSMenuItemData used to in this Menu.

populateMenu

protected abstract void populateMenu()

selectMenuItem

public abstract boolean selectMenuItem(String[] hierarchy)

clearSelected

public abstract void clearSelected()

Deselects the current selected menu item