com.sap.ui.commons.client
Class DropdownBoxWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.TextFieldWidget
                  com.sap.ui.commons.client.ComboBoxWidget
                      com.sap.ui.commons.client.DropdownBoxWidget

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

public class DropdownBoxWidget
extends ComboBoxWidget

The class DropdownBox is the GWT wrapper for the Phoenix control: sap.ui.commons.DropdownBox.

The control provides a field that allows end users to an entry out of a list of pre-defined items. The choosable items can be provided in the form of complete list boxes or single list items. Binding (see DataBinding) is also supported for list items.

• Properties
• Aggregations
• Associations
• Events
  • searchHelp Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.

For further parameters see {@link com.sap.ui.commons.client.ComboBox

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: )

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

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

DEBUG_ID_PREFIX

Constructor Summary

	DropdownBoxWidget() constructs the class DropdownBoxWidget
protected	DropdownBoxWidget(DropdownBox control) constructs the class DropdownBoxWidget
	DropdownBoxWidget(String id) constructs the class DropdownBoxWidget

Method Summary

void	attachSearchHelpEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.
void	detachSearchHelpEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.
DropdownBox	getControl() returns the reference to the Phoenix Control
DropdownBox	setSearchHelpEnabled(boolean enabled, String text, String additionalText, String icon) Configure whether the DropdownBox should provide a search help item and (if given) overwrite default settings for texts.

Methods inherited from class com.sap.ui.commons.client.ComboBoxWidget

addItem, bindItems, destroyItems, getItems, getListBox, getMaxPopupItems, indexOfItem, insertItem, isDisplaySecondaryValues, removeAllItems, removeItem, setDisplaySecondaryValues, setListBox, setListBox, setMaxPopupItems, unbindItems

Methods inherited from class com.sap.ui.commons.client.TextFieldWidget

attachChangeEvent, bindValue, bindValue, detachChangeEvent, focus, getAccessibleDescription, getAccessibleName, getAccessibleRole, getDesign, getHelpId, getImeMode, getMaxLength, getTextAlign, getTextDirection, getValue, getValueState, getWidth, isEditable, isEnabled, isRequired, isVisible, setAccessibleDescription, setAccessibleName, setAccessibleRole, setDesign, setEditable, setEnabled, setHelpId, setImeMode, setMaxLength, setRequired, setTextAlign, setTextDirection, setValue, setValueState, setVisible, setWidth, unbindValue

Methods inherited from class com.sap.ui.core.client.ControlWidget

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

DropdownBoxWidget

public DropdownBoxWidget()

constructs the class DropdownBoxWidget

DropdownBoxWidget

public DropdownBoxWidget(String id)

constructs the class DropdownBoxWidget

Parameters:

id - id of the DropdownBoxWidget

DropdownBoxWidget

protected DropdownBoxWidget(DropdownBox control)

constructs the class DropdownBoxWidget

Parameters:

control - reference to an existing DropdownBox

Method Detail

getControl

public DropdownBox getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class ComboBoxWidget

Returns:

reference to the Phoenix Control

attachSearchHelpEvent

public void attachSearchHelpEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.

Event Parameters:

{sap.ui.core/string} value The current value of the DropdownBox.

Parameters:

listener - reference to the EventListener

detachSearchHelpEvent

public void detachSearchHelpEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and F4 key is pressed.

Parameters:

listener - reference to the EventListener

setSearchHelpEnabled

public DropdownBox setSearchHelpEnabled(boolean enabled,
                                        String text,
                                        String additionalText,
                                        String icon)

Configure whether the DropdownBox should provide a search help item and (if given) overwrite default settings for texts.

Parameters:

enabled - Whether the DropdownBox's search help should be enabled.

text - (optional) The text to use for the search help entry.

additionalText - (optional) The additional Text to use for the search help entry.

icon - (optional) The src of the icon to use for the search help entry.