new Edit(propsopt) → {Edit}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props | Object |
<optional> | Initializes a Label test object using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- Edit
Methods
absoluteLocation(locationopt) → {Point|Description}
The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
location | Point |
<optional> | When provided, this method acts as a setter and sets the absoluteLocation value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Point | Description
attachedText(attachedTextopt) → {string|Description}
The static text attached to the edit field.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
attachedText | string |
<optional> | When provided, this method acts as a setter and sets the attachedText value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attachedText value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
iconName(iconNameopt) → {string|Description}
The name of the icon used in the edit box.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
iconName | string |
<optional> | When provided, this method acts as a setter and sets the iconName value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored iconName value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
id(idopt) → {string|Description}
The element's unique identifier in text format.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id | string |
<optional> | When provided, this method acts as a setter and sets the id value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored id value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
isEnabled(isEnabledopt) → {boolean|Description}
Indicates whether the edit field can accept user input.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isEnabled | boolean |
<optional> | When provided, this method acts as a setter and sets the isEnabled value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
isHighlighted(isHighlightedopt) → {boolean|Description}
Indicates whether the edit field is highlighted.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isHighlighted | boolean |
<optional> | When provided, this method acts as a setter and sets the isHighlighted value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isHighlighted value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
isNumerical(isNumericalopt) → {boolean|Description}
Indicates whether the edit box is a numeric field.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isNumerical | boolean |
<optional> | When provided, this method acts as a setter and sets the isNumerical value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isNumerical value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
isRequired(isRequiredopt) → {boolean|Description}
Indicates whether the edit box is required.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isRequired | boolean |
<optional> | When provided, this method acts as a setter and sets the isRequired value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isRequired value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- boolean | Description
location(locationopt) → {Point|Description}
The object's coordinates relative to the parent's location in pixels.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
location | Point |
<optional> | When provided, this method acts as a setter and sets the location value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Point | Description
maxLength(maxLengthopt) → {number|Description}
The maximum number of characters that can be entered in the edit box.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
maxLength | number |
<optional> | When provided, this method acts as a setter and sets the maxLength value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxLength value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- number | Description
name(nameopt) → {string|Description}
The name of the element.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name | string |
<optional> | When provided, this method acts as a setter and sets the name value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
size(sizeopt) → {Size|Description}
The object's size in pixels.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
size | Size |
<optional> | When provided, this method acts as a setter and sets the size value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Size | Description
text(textopt) → {string|Description}
The text in the edit field.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
text | string |
<optional> | When provided, this method acts as a setter and sets the text value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
type(typeopt) → {SAPGUI.ComponentType|Description}
The numeric identification of the GUI component type.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
type | SAPGUI.ComponentType |
<optional> | When provided, this method acts as a setter and sets the type value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- SAPGUI.ComponentType | Description
