TextEdit

Use

UI element TextEdit makes it possible to enter and display multi-line text. The text in this UI element uses a uniform font, font size, and font style.

The UI element is displayed with borders and the frame size is specified by the properties col and row. If the number of rows exceeds the value of the row property, a vertical scroll bar is displayed.

If the value of the wrapping property is off, the scroll bar is only displayed if the text row length exceeds the value of the col property.

Example of a TextEdit with Label

Cursor Position in TextEdit

Applications can set the cursor position and the text selection within a TextEdit UI element.

The application can set the position of the text cursor within the TextEdit.
The application can define the position of the selection within the TextEdit (see example).
Both the text cursor and the selection are visible within the TextEdit.

You can find a test example in the system in the WDR_TEST_FOCUS_INFO component.

Example of Selection in TextEdit

Note

Observe the restrictions listed in Note 1389931 Information published on SAP site .

You can find more information about the implementation in the interface documentation for IF_WD_FOCUS_INFO.

Implementation Details

Runtime Class

CL_WD_TEXT_EDIT

Name	Type	Initial Value	Bindable
id	STRING	(automatic)	No
activateAccessKey	WDY_BOOLEAN	false	No
adjustRowsToText	WDY_BOOLEAN	false	Yes
cols	I	40	Yes
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
design	WDUI_TEXT_EDIT_DESIGN	standard	Yes
displayAsText	WDY_BOOLEAN	false	Yes
enabled	WDY_BOOLEAN	true	Yes
explanation	Translatable text		No
height	STRING		Yes
imeMode	WDUI_IMEMODE	auto	Yes
readOnly	WDY_BOOLEAN	false	Yes
rows	I	5	Yes
state	WDUI_STATE	normal	Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
value	STRING_TABLE		Mandatory
visible	WDUI_VISIBILITY	visible	Yes
width	STRING		Yes
wrapping	WDUI_TEXT_WRAPPING	soft	Yes

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

Accessibility

To enable the development of accessible applications the property label 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 property tooltip is checked.

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.

View Designer Name	Runtime Name	Type
activateAccessKey	ACTIVATE_ACCESS_KEY	WDY_BOOLEAN
adjustRowsToText	ADJUST_ROWS_TO_TEXT	WDY_BOOLEAN
cols	COLS	I
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_TEXT_EDIT=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_TEXT_EDIT=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_TEXT_EDIT=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
design	DESIGN	WDUI_TEXT_EDIT_DESIGN
design: monospace	CL_WD_TEXT_EDIT=>E_DESIGN-MONOSPACE
design: standard	CL_WD_TEXT_EDIT=>E_DESIGN-STANDARD
displayAsText	DISPLAY_AS_TEXT	WDY_BOOLEAN
enabled	ENABLED	WDY_BOOLEAN
explanation	EXPLANATION	WDY_MD_TRANSLATABLE_TEX T
height	HEIGHT	STRING
imeMode	IME_MODE	WDUI_IMEMODE
imeMode: active	CL_WD_TEXT_EDIT=>E_IME_MODE-ACTIVE
imeMode: auto	CL_WD_TEXT_EDIT=>E_IME_MODE-AUTO
imeMode: disabled	CL_WD_TEXT_EDIT=>E_IME_MODE-DISABLED
imeMode: inactive	CL_WD_TEXT_EDIT=>E_IME_MODE-INACTIVE
readOnly	READ_ONLY	WDY_BOOLEAN
rows	ROWS	I
state	STATE	WDUI_STATE
state: normal	CL_WD_TEXT_EDIT=>E_STATE-NORMAL
state: required	CL_WD_TEXT_EDIT=>E_STATE-REQUIRED
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection: inherit	CL_WD_TEXT_EDIT=>E_TEXT_DIRECTION-INHERIT
textDirection: ltr	CL_WD_TEXT_EDIT=>E_TEXT_DIRECTION-LTR
textDirection: rtl	CL_WD_TEXT_EDIT=>E_TEXT_DIRECTION-RTL
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
value	VALUE	STRING_TABLE
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_TEXT_EDIT=>E_VISIBLE-NONE
visible: visible	CL_WD_TEXT_EDIT=>E_VISIBLE-VISIBLE
width	WIDTH	STRING
wrapping	WRAPPING	WDUI_TEXT_WRAPPING
wrapping: hard	CL_WD_TEXT_EDIT=>E_WRAPPING-HARD
wrapping: off	CL_WD_TEXT_EDIT=>E_WRAPPING-OFF
wrapping: soft	CL_WD_TEXT_EDIT=>E_WRAPPING-SOFT

Example

You can find an example of this UI element in the system in component, WDR_TEST_UI_ELEMENTS.