ToolBarInputField

This UI element provides an InputField in a ToolBar. It enables the user to enter or display a single-line text in the toolbar.

Note

To enable the development of accessible applications, the label property is checked during the syntax check.

If no label has been set, and no descriptive text has been specified for the appropriate bound context element in the ABAP Dictionary, the tooltip property is checked.

Implementation Details

Runtime Class

CL_WD_TOOLBAR_INPUT_FIELD

Properties in View Designer

Name	Type	Initial Value	Bindable
id	STRING	(automatic)	No
activateAccessKey	WDY_BOOLEAN	false	No
alignment	WDUI_INPUT_FIELD_ALIGNMENT	auto	Yes
collapsible	WDY_BOOLEAN	false	Yes
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
displayAsText	WDY_BOOLEAN	false	Yes
enabled	WDY_BOOLEAN	true	Yes
explanation	Translatable text		No
imeMode	WDUI_IMEMODE	auto	Yes
inputHelp	WDUI_INPUTHELP	auto	Yes
inputPrompt	Translatable text		Yes
labelText	Translatable text		Yes
length	I	20	Yes
noHistory	WDY_BOOLEAN	00 (default):	No
passwordField	WDY_BOOLEAN	false	Yes
readOnly	WDY_BOOLEAN	false	Yes
state	WDUI_STATE	normal	Yes
styleClassName	STRING		Yes
suggestFilterMethod	WDUI_SUGGEST_FILTER_METHOD	00 (default):	Yes
suggestValues	WDY_BOOLEAN	00 (default):	Yes
suppressValueHelp	WDY_BOOLEAN	00 (default):	Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
value	Translatable text		Mandatory
visible	WDUI_VISIBILITY	visible	Yes
width	STRING		Yes

Events in View Designer

Name
onEnter
onValueSuggest

Note

Other properties that can be inherited are defined in the related higher-level classes. The related UI elements are:

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. But note that the spelling format and use of upper/lower case is different.

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
activateAccessKey	ACTIVATE_ACCESS_KEY	WDY_BOOLEAN
alignment	ALIGNMENT	WDUI_INPUT_FIELD_ALIGNMENT
alignment: auto	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-AUTO
alignment: beginOfLine	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-BEGIN_OF_LINE
alignment: center	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-CENTER
alignment: endOfLine	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-END_OF_LINE
alignment: forcedLeft	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-FORCED_LEFT
alignment: forcedRight	CL_WD_TOOLBAR_INPUT_FIELD=>E_ALIGNMENT-FORCED_RIGHT
collapsible	COLLAPSIBLE	WDY_BOOLEAN
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_TOOLBAR_INPUT_FIELD=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_TOOLBAR_INPUT_FIELD=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_TOOLBAR_INPUT_FIELD=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
displayAsText	DISPLAY_AS_TEXT	WDY_BOOLEAN
enabled	ENABLED	WDY_BOOLEAN
explanation	EXPLANATION	WDY_MD_TRANSLATABLE_TEXT
imeMode	IME_MODE	WDUI_IMEMODE
imeMode: active	CL_WD_TOOLBAR_INPUT_FIELD=>E_IME_MODE-ACTIVE
imeMode: auto	CL_WD_TOOLBAR_INPUT_FIELD=>E_IME_MODE-AUTO
imeMode: disabled	CL_WD_TOOLBAR_INPUT_FIELD=>E_IME_MODE-DISABLED
imeMode: inactive	CL_WD_TOOLBAR_INPUT_FIELD=>E_IME_MODE-INACTIVE
inputHelp	INPUT_HELP	WDUI_INPUTHELP
inputHelp: auto	CL_WD_TOOLBAR_INPUT_FIELD=>E_INPUT_HELP-AUTO
inputHelp: calculator	CL_WD_TOOLBAR_INPUT_FIELD=>E_INPUT_HELP-CALCULATOR
inputHelp: none	CL_WD_TOOLBAR_INPUT_FIELD=>E_INPUT_HELP-NONE
inputHelp: search	CL_WD_TOOLBAR_INPUT_FIELD=>E_INPUT_HELP-SEARCH
inputPrompt	INPUT_PROMPT	WDY_MD_TRANSLATABLE_TEXT
labelText	LABEL_TEXT	WDY_MD_TRANSLATABLE_TEXT
length	LENGTH	I
noHistory	NO_HISTORY	WDY_BOOLEAN
passwordField	PASSWORD_FIELD	WDY_BOOLEAN
readOnly	READ_ONLY	WDY_BOOLEAN
state	STATE	WDUI_STATE
state: normal	CL_WD_TOOLBAR_INPUT_FIELD=>E_STATE-NORMAL
state: required	CL_WD_TOOLBAR_INPUT_FIELD=>E_STATE-REQUIRED
styleClassName	STYLE_CLASS_NAME	STRING
suggestFilterMethod	SUGGEST_FILTER_METHOD	WDUI_SUGGEST_FILTER_METHOD
suggestFilterMethod: containsSearch	CL_WD_TOOLBAR_INPUT_FIELD=>E_SUGGEST_FILTER_METHOD-CONTAINS
suggestFilterMethod: prefixSearch	CL_WD_TOOLBAR_INPUT_FIELD=>E_SUGGEST_FILTER_METHOD-PREFIX
suggestValues	SUGGEST_VALUES	WDY_BOOLEAN
suppressValueHelp	SUPPRESS_VALUE_HELP	WDY_BOOLEAN
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection inherit	CL_WD_TOOLBAR_INPUT_FIELD=>E_TEXT_DIRECTION-INHERIT
textDirection ltr	CL_WD_TOOLBAR_INPUT_FIELD=>E_TEXT_DIRECTION-LTR
textDirection rtl	CL_WD_TOOLBAR_INPUT_FIELD=>E_TEXT_DIRECTION-RTL
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
value	VALUE	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_TOOLBAR_INPUT_FIELD=>E_VISIBLE-NONE
visible: visible	CL_WD_TOOLBAR_INPUT_FIELD=>E_VISIBLE-VISIBLE
width	WIDTH	STRING

Dynamic Programming of Events

View Designer Name	Runtime Name
onEnter	ON_ENTER
onValueSuggest	ON_VALUE_SUGGEST

Dynamic Programming of Aggregations

View Designer Name	Runtime Name	Cardinality
ON_CLIENT_ENTER	ON_CLIENT_ENTER	0..1

Example

You can find an example of this UI element in the system in the WDR_TEST_UI_ELEMENTS Web Dynpro application.