org.kuali.student.common.ui.client.widgets
Class KSDropDown

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.list.KSSelectItemWidgetAbstract
                  org.kuali.student.common.ui.client.widgets.KSDropDown

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasName, HasWidgetReadyCallback, HasSelectionChangeHandlers

Direct Known Subclasses:

CluSetEditorWidget.CluSetEditOptionDropdown, CourseConfigurer.PersonList, OrgPersonRelationTypePicker, OrgPositionTypePicker, OrgRelationTypePicker, OrgTypePicker

public class KSDropDown
extends KSSelectItemWidgetAbstract

KSDropDown wraps gwt Listbox in a KSSelectItemWidgetAbstract. This provides the same basic functionality as a listbox, but allows it to be interchangable with other select item widget implementations.

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

(package private) KSSelectItemWidgetAbstract

dropDown

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

DEBUG_ID_PREFIX

Constructor Summary

KSDropDown()
This constructs a KSDropDown that wraps an impl

Method Summary

com.google.gwt.event.shared.HandlerRegistration	addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addSelectionChangeHandler(SelectionChangeHandler selectionHandler) Used to had a selection change handler.
void	addWidgetReadyCallback(Callback<com.google.gwt.user.client.ui.Widget> callback) This method can be used to register a callback to be executed when a widget has been initialized.
void	clear() This method clears the current selection
void	deSelectItem(String id) Remove selection for item represented by id.
ListItems	getListItems()
String	getName()
String	getSelectedItem() Id of selected item.
List<String>	getSelectedItems() List of items that have been selected.
boolean	isBlankFirstItem()
boolean	isEnabled()
boolean	isInitialized() This method can be used to query if a widget has been initialized.
void	onLoad()
void	redraw()
void	selectItem(String id) Select an item whose text equals the name passed in.
void	setBlankFirstItem(boolean blankFirstItem) Use when the first item in list should be blank.
void	setEnabled(boolean b)
void	setInitialized(boolean initialized) This method sets an initialized state of the widget
void	setListItems(ListItems listItems)
void	setName(String name)

Methods inherited from class org.kuali.student.common.ui.client.widgets.list.KSSelectItemWidgetAbstract

fireChangeEvent, isMultipleSelect, setColumnSize, setMultipleSelect

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

addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, 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, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

dropDown

KSSelectItemWidgetAbstract dropDown

Constructor Detail

KSDropDown

public KSDropDown()

This constructs a KSDropDown that wraps an impl

Method Detail

selectItem

public void selectItem(String id)

Select an item whose text equals the name passed in.

Specified by:

selectItem in class KSSelectItemWidgetAbstract

Parameters:

id - of the item to be selected.

deSelectItem

public void deSelectItem(String id)

Description copied from class: KSSelectItemWidgetAbstract

Remove selection for item represented by id.

Specified by:

deSelectItem in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.deSelectItem(java.lang.String)

getSelectedItems

public List<String> getSelectedItems()

Description copied from class: KSSelectItemWidgetAbstract

List of items that have been selected.

Specified by:

getSelectedItems in class KSSelectItemWidgetAbstract

Returns:

See Also:

KSSelectItemWidgetAbstract.getSelectedItems()

getSelectedItem

public String getSelectedItem()

Description copied from class: KSSelectItemWidgetAbstract

Id of selected item. If multiple items are selected, this will return the first selected item.

Overrides:

getSelectedItem in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.getSelectedItem()

onLoad

public void onLoad()

Specified by:

onLoad in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.onLoad()

setListItems

public void setListItems(ListItems listItems)

Overrides:

setListItems in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.setListItems(org.kuali.student.common.ui.client.widgets.list.ListItems)

addSelectionChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionChangeHandler(SelectionChangeHandler selectionHandler)

Description copied from class: KSSelectItemWidgetAbstract

Used to had a selection change handler.

Specified by:

addSelectionChangeHandler in interface HasSelectionChangeHandlers

Overrides:

addSelectionChangeHandler in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.addSelectionChangeHandler(org.kuali.student.common.ui.client.widgets.list.SelectionChangeHandler)

getListItems

public ListItems getListItems()

Overrides:

getListItems in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.getListItems()

getName

public String getName()

Specified by:

getName in interface com.google.gwt.user.client.ui.HasName

Overrides:

getName in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.getName()

setName

public void setName(String name)

Specified by:

setName in interface com.google.gwt.user.client.ui.HasName

Overrides:

setName in class KSSelectItemWidgetAbstract

See Also:

KSSelectItemWidgetAbstract.setName(java.lang.String)

setEnabled

public void setEnabled(boolean b)

Specified by:

setEnabled in class KSSelectItemWidgetAbstract

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in class KSSelectItemWidgetAbstract

isBlankFirstItem

public boolean isBlankFirstItem()

setBlankFirstItem

public void setBlankFirstItem(boolean blankFirstItem)

Use when the first item in list should be blank. If set, it must be called before call to setListItems()

Parameters:

blankFirstItem -

redraw

public void redraw()

Specified by:

redraw in class KSSelectItemWidgetAbstract

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

addBlurHandler

public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)

addWidgetReadyCallback

public void addWidgetReadyCallback(Callback<com.google.gwt.user.client.ui.Widget> callback)

Description copied from interface: HasWidgetReadyCallback

This method can be used to register a callback to be executed when a widget has been initialized. The callback should be unregistered by the implementing widget after execution.

Specified by:

addWidgetReadyCallback in interface HasWidgetReadyCallback

Overrides:

addWidgetReadyCallback in class KSSelectItemWidgetAbstract

isInitialized

public boolean isInitialized()

Description copied from interface: HasWidgetReadyCallback

This method can be used to query if a widget has been initialized.

Specified by:

isInitialized in interface HasWidgetReadyCallback

Overrides:

isInitialized in class KSSelectItemWidgetAbstract

Returns:

setInitialized

public void setInitialized(boolean initialized)

Description copied from interface: HasWidgetReadyCallback

This method sets an initialized state of the widget

Specified by:

setInitialized in interface HasWidgetReadyCallback

Overrides:

setInitialized in class KSSelectItemWidgetAbstract

clear

public void clear()

Description copied from class: KSSelectItemWidgetAbstract

This method clears the current selection

Specified by:

clear in class KSSelectItemWidgetAbstract