Web Dynpro TextEdit API - IWDTextEdit 
Definition
The TextEdit UI element allows the entry and display of a multiline 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 be displayed if the text row length exceeds the value of the col property.
The following graphic shows the TextEdit UI element in the SAP standard design:
Description of the UI Element Properties
-
cols
Specifies the width of the TextEdit UI element as quantity of characters. -
width
Specifies the width of the UI element and can be specified in CSS units like em, ex, pixels, or percentage. This property value overwrites the value of the row property. -
readOnly
Specifies whether or not the UI element can only be used for the display or also for the input of text. -
rows
Specifies the height of the TextEdit UI element as quantity of characters. -
state
Describes the state of the TextEdit UI element. The state property can be filled with the following values and is represented by the enumeration type WDState.
normal |
Describes the default state of the UI element. |
required |
Specifies whether the entered value is required. |
-
value
Describes the text to be displayed. The text can be edited. -
wrapping
Specifies whether or not the text can be wrapped. The wrapping property can be filled with the following values and is represented by the enumeration type WDTextWrapping.
hard |
Wraps the text if the value specified by the col property is reached. A carriage control is inserted for each wrapping. A horizontal scroll bar is not displayed for this value. |
off |
The text is not wrapped. If the text row length exceeds the width specified by the col property, a horizontal scroll bar is displayed. |
soft |
Wraps the text if the value specified by the col attribute is reached. A carriage control is not inserted for the wrapping, and a horizontal scroll bar is not displayed for this value. |
·
width
Determines the width of the UI element that you can specify in CSS sizes, such
as em, ex, pixels or percentage values. This property value overwrites the
value of the row property.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
Cols |
IWDTextEdit |
int |
40 |
bindable |
No |
Height |
IWDTextEdit |
String (CSS size) |
|
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
readOnly |
IWDTextEdit |
boolean |
false |
bindable |
No |
Rows |
IWDTextEdit |
int |
5 |
bindable |
No |
State |
IWDTextEdit |
WDState |
Normal |
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
Value |
IWDTextEdit |
String |
|
bindable_mandatory |
No |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
Width |
IWDTextEdit |
String (CSS size) |
|
bindable |
No |
wrapping |
IWDTextEdit |
WDTextWrapping |
soft |
bindable |
No |
Mobile Characteristics
The UI element TextEdit supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro).
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
BlackBerry wireless handheld |
enabled |
ignored |
ignored |
readOnly |
ignored |
ignored |
State |
ignored |
ignored |
tooltip |
ignored |
ignored |
Width |
ignored |
ignored |
wrapping |
ignored |
ignored |
Height |
ignored |
ignored |
The readOnly property is to be used carefully, as the value true is, in contrast to a desktop PC, not considered in the visual display of the user interface element. The user of the mobile Web Dynpro application cannot know that for the value true, the TextEdit user interface element is read-only.
Methods in the Web Dynpro IWDTextEdit API
Method Name |
Parameter |
Return Value |
Short Description |
bindCols |
(String path) |
|
Binds the cols property to the context node specified by a path. |
bindHeight |
(String path) |
|
Binds the value of the height property to the context element specified by the path. |
bindingOfCols |
|
String |
Returns the path of the context element to which the cols property is bound. Returns NULL if no binding exists. |
bindingOfHeight |
|
String |
Returns the path of the context element to which the height property is bound. Returns NULL if no binding exists. |
bindingOfReadOnly |
|
String |
Returns the path of the context element to which the readOnly property is bound. Returns NULL if no binding exists. |
bindingOfRows |
|
String |
Returns the path of the context element to which the rows property is bound. Returns NULL if no binding exists. |
bindingOfState |
|
String |
Returns the path of the context element to which the state property is bound. Returns NULL if no binding exists. |
bindingOfValue |
|
String |
Returns the path of the context element to which the value property is bound. Returns NULL if no binding exists. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindingOfWrapping |
|
String |
Returns the path of the context element to which the wrapping property is bound. Returns NULL if no binding exists. |
bindReadOnly |
(String path) |
|
Binds the readOnly property to the context node specified by a path. |
bindRows |
(String path) |
|
Binds the rows property to the context node specified by a path. |
bindState |
(String path) |
|
Binds the state property to the context node specified by a path. |
bindValue |
(String path) |
|
Binds the value property to the context node specified by a path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
bindWrapping |
(String path) |
|
Binds the wrapping property to the context node specified by a path. |
getCols |
|
int |
Returns the value of the cols property. |
getHeight |
|
String |
Returns the value of the height property. |
getReadOnly |
|
boolean |
Returns the value of the readOnly property. |
getRows |
|
int |
Returns the value of the rows property. |
getState |
|
WDState |
Returns the value of the state property. |
getValue |
|
String |
Returns the value of the value property. |
getWidth |
|
String |
Returns the value of the width property. |
getWrapping |
|
WDTextWrapping |
Returns the value of the wrapping property. |
setCols |
(int cols) |
|
Sets the value of the cols property. |
setHeight |
(String height) |
|
Sets the value of the height property. |
setReadOnly |
(boolean readOnly) |
|
Sets the value of the readOnly property. |
setRows |
(int rows) |
|
Sets the value of the rows property. |
setState |
(WDState state) |
|
Sets the value of the state property. |
setValue |
(String value) |
|
Sets the value of the value property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
setWrapping |
(WDTextWrapping wrapping) |
|
Sets the value of the wrapping property. |
Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.