Entering content frame

Object documentation Web Dynpro AbstractInputField API - IWDAbstractInputField Locate the document in its SAP Library structure

Definition

The AbstractInputField class which implements the IWDAbstractInputField interface, is the abstract base class of input fields. The input field can be used to edit or display a single-line text. If you only want to display the text, set the property readOnly to true. You cannot only edit the value of the type String but also the value of a simple data type using an input field. The conversion of the string representation into the data type – known as parsing – and the conversion of the data type into the string presentation – known as formating – are automatically executed.

Description of the UI Element Properties

·        length
Determines the maximum number of characters to be displayed in the input field.

·        passwordField
Boolean value that controls the display of entered characters on screen. If the value is true, the entered characters on screen are echoed with an asterisk (*). This attribute is usually used for password input fields.

·        readOnly
Specifies whether the input field can be edited or only read. If the value is true, the displayed text can only be read.

·        state
Describes the status of the UI element. The data type of this property corresponds to the enumeration type WDState. You can use the following values in the application:

normal

Describes the default state of the UI element.

required

Specifies whether the entered value is required.

·        value
Specifies the character string displayed in the input field area. This property must be bound to a context attribute (see Structure linkData Binding Within Web Dynpro).

Overview of Inherited and Additional Properties

Name

Interface

Type

Initial Value

Bindable

Value Required

enabled

IWDUIElement

boolean

true

bindable

No

length

IWDAbstractInputField

int

20

bindable

No

passwordField

IWDAbstractInputField

boolean

false

bindable

No

readOnly

IWDAbstractInputField

boolean

false

bindable

No

state

IWDAbstractInputField

WDState

normal

bindable

No

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

No

value

IWDAbstractInputField

String

 

bindable_mandatory

No

visible

IWDUIElement

WDVisibility

visible

bindable

No

Events

·        onEnter
This property can assign the action that is executed when the user confirms the entry.

Subordinate Interfaces

IWDInputField

Data Binding

·        You must use the value property to bind the data to an input field by assigning the path of the corresponding context attribute to this property.

Methods in the Web Dynpro IWDAbstractInputField API

Method Name

Parameter

Return Value

Short Description

bindingOfLength

 

String

Returns the path of the context element to which the length property is bound. Returns NULL if no binding exists.

bindingOfPasswordField

 

String

Returns the path of the context element to which the passwordField 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.

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.

bindLength

(String path)

 

Binds the length property to the context node specified by a path.

bindPasswordField

(String path)

 

Binds the passwordField property to the context node specified by a path.

bindReadOnly

(String path)

 

Binds the readOnly 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.

getLength

 

int

Returns the value of the length property.

getOnEnter

 

IWDAction

Returns the action that is executed when the onEnter event is triggered.

getPasswordField

 

boolean

Returns the value of the passwordField property.

getReadOnly

 

boolean

Returns the value of the readOnly property.

getState

 

WDState

Returns the value of the state property.

getValue

 

String

Returns the value of the value property.

mappingOfOnEnter

 

IWDParameterMapping

Returns the parameter mapping for the onEnter action.

setLength

(int)

 

Sets the value of the length property.

setOnEnter

(IWDAction action)

 

Sets the action that is executed when the onEnter event is triggered.

setPasswordField

(boolean value)

 

Sets the value of the passwordField property.

setReadOnly

(boolean value)

 

Sets the value of the readOnly property.

setState

(WDState value)

 

Sets the value of the state property.

setValue

(String value)

 

Sets the value of the value property.

Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.

Note

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.

  

  

 

Leaving content frame