com.sap.ui.commons.client
Class DropdownBox

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.TextField
                  com.sap.ui.commons.client.ComboBox
                      com.sap.ui.commons.client.DropdownBox

All Implemented Interfaces:

ToolbarItem

public class DropdownBox
extends ComboBox

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: sap.ui.commons.DropdownBox)

Constructor Summary

protected

DropdownBox() constructs the class DropdownBox hidden due to JavaScriptObject restriction

Method Summary

DropdownBox	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.
static DropdownBox	create() creates a new instance of the class DropdownBox
static DropdownBox	create(String idOrConfig) creates a new instance of the class DropdownBox
static DropdownBox	create(String id, String config) creates a new instance of the class DropdownBox
DropdownBox	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	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.ComboBox

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

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

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

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

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DropdownBox

protected DropdownBox()

constructs the class DropdownBox
hidden due to JavaScriptObject restriction

Method Detail

create

public static DropdownBox create()

creates a new instance of the class DropdownBox

create

public static DropdownBox create(String idOrConfig)

creates a new instance of the class DropdownBox

Parameters:

id - id of the DropdownBox or configuration JSON string

create

public static DropdownBox create(String id,
                                 String config)

creates a new instance of the class DropdownBox

Parameters:

id - id of the DropdownBox

config - configuration JSON string

attachSearchHelpEvent

public final DropdownBox 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

Returns:

this to allow method chaining

detachSearchHelpEvent

public final DropdownBox 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

Returns:

this to allow method chaining

setSearchHelpEnabled

public final 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.