Package com.hp.lft.sdk.sap.gui
Class EditFieldDescription
java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.DescriptionBase
com.hp.lft.sdk.sap.gui.ElementDescription
com.hp.lft.sdk.sap.gui.EditFieldDescription
- All Implemented Interfaces:
CloneableObject
,Description
,com.hp.lft.sdk.internal.DescriptionWithVri
,Cloneable
Description of a SAP GUI for Windows edit box.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This class can be used to construct an instance of the EditFieldDescription class using the builder pattern.protected static class
EditFieldDescription.Init<T extends EditFieldDescription.Init<T>>
Helper class for EditFieldDescription.Builder. -
Field Summary
Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
properties
-
Constructor Summary
ConstructorsModifierConstructorDescriptionInitializes a new instance of the EditFieldDescription class.protected
Initializes a new instance of the EditFieldDescription class using the Builder pattern. -
Method Summary
Modifier and TypeMethodDescriptionReturns the static text attached to the edit field.Returns the name of the icon used in the edit box.Returns the maximum number of characters that can be entered in the edit box.getText()
Returns the text string value of the object.Indicates whether the object can accept user input.Indicates whether whether the edit box is highlighted.Returns the whether the edit box is a numerical field.Returns the whether the edit box is required.void
setAttachedText
(StringProperty attachedText) Sets the static text attached to the edit field.void
setAttachedText
(String attachedText) Sets the static text attached to the edit field.void
setEnabled
(Boolean isEnabled) Sets whether the object can accept user input.void
setHighlighted
(Boolean isHighlighted) Sets whether whether the edit box is highlighted.void
setIconName
(StringProperty iconName) Sets the name of the icon used in the edit box.void
setIconName
(String iconName) Sets the name of the icon used in the edit box.void
setMaxLength
(Integer maxLength) Sets the maximum number of characters that can be entered in the edit box.void
setNumerical
(Boolean isNumerical) Sets whether whether the edit box is a numerical field.void
setRequired
(Boolean isRequired) Sets the whether the edit box is required.void
setText
(StringProperty text) Sets the text string value of the object.void
Sets the text string value of the object.Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription
getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType
Methods inherited from class com.hp.lft.sdk.DescriptionBase
cloneTo, getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, setVRI, setVRI
Methods inherited from class com.hp.lft.sdk.PropertiesDescription
clone
Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
getValueAs, getValueAsStringProperty, insertValue
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.hp.lft.sdk.CloneableObject
clone
-
Constructor Details
-
EditFieldDescription
public EditFieldDescription()Initializes a new instance of the EditFieldDescription class. -
EditFieldDescription
Initializes a new instance of the EditFieldDescription class using the Builder pattern.- Parameters:
init
- the Builder pattern.
-
-
Method Details
-
setAttachedText
Sets the static text attached to the edit field.- Parameters:
attachedText
- aStringProperty
orRegExpProperty
.
-
setAttachedText
Sets the static text attached to the edit field.- Parameters:
attachedText
- the static text.
-
getAttachedText
Returns the static text attached to the edit field.- Returns:
- the static text.
-
setEnabled
Sets whether the object can accept user input.- Parameters:
isEnabled
- true to set as enabled.
-
isEnabled
Indicates whether the object can accept user input.- Returns:
- true if enabled.
-
setHighlighted
Sets whether whether the edit box is highlighted.- Parameters:
isHighlighted
- true to set as highlighted.
-
isHighlighted
Indicates whether whether the edit box is highlighted.- Returns:
- true if highlighted.
-
setIconName
Sets the name of the icon used in the edit box.- Parameters:
iconName
- aStringProperty
orRegExpProperty
.
-
setIconName
Sets the name of the icon used in the edit box.- Parameters:
iconName
- the name of the icon.
-
getIconName
Returns the name of the icon used in the edit box.- Returns:
- the name of the icon.
-
setMaxLength
Sets the maximum number of characters that can be entered in the edit box.- Parameters:
maxLength
- the maximum number of characters.
-
getMaxLength
Returns the maximum number of characters that can be entered in the edit box.- Returns:
- the maximum number of characters.
-
setNumerical
Sets whether whether the edit box is a numerical field.- Parameters:
isNumerical
- true to set as numerical field
-
isNumerical
Returns the whether the edit box is a numerical field.- Returns:
- true if numerical field
-
setRequired
Sets the whether the edit box is required.- Parameters:
isRequired
- true to set as required.
-
isRequired
Returns the whether the edit box is required.- Returns:
- true if required.
-
setText
Sets the text string value of the object.- Parameters:
text
- aStringProperty
orRegExpProperty
.
-
setText
Sets the text string value of the object.- Parameters:
text
- the text.
-
getText
Returns the text string value of the object.- Returns:
- a StringProperty representing the text string value of the object.
-