Package com.hp.lft.sdk.te
Class FieldDescription
java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.DescriptionBase
com.hp.lft.sdk.te.FieldDescription
- All Implemented Interfaces:
CloneableObject,Description,com.hp.lft.sdk.internal.DescriptionWithVri,Cloneable
The description of a terminal emulator field that fully supports HLLAPI.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThis class can be used to construct an instance of the FieldDescription class using the builder pattern.protected static classFieldDescription.Init<T extends FieldDescription.Init<T>>Helper class for FieldDescription.Builder. -
Field Summary
Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
properties -
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a new FieldDescription.protectedFieldDescription(FieldDescription.Init<?> init) Initializes a new instance of the FieldDescription class using the Builder pattern. -
Method Summary
Modifier and TypeMethodDescriptionSets the attached text attribute for TeField.getId()Returns the id value of the field.Returns the field length in characters.Returns the 'start row' and 'start column' attributes for TeField.getText()Sets the content of TeField.Indicates whether the TeField is numeric.Indicates whether the TeField is protected.Indicates whether the TeField is visible.voidsetAttachedText(StringProperty attachedText) Sets the attached text attribute for TeField.voidsetAttachedText(String attachedText) Sets the attached text attribute for TeField.voidSets the id value of the field.voidSets the field length in characters.voidsetNumeric(Boolean numeric) Sets the numeric attribute for TeField.voidsetProtected(Boolean isProtected) Sets the protected attribute for TeField.voidsetStartPosition(Position position) Sets the'start row' and 'start column' attributes for TeField.voidsetStartPosition(PositionProperty position) Sets the 'start row' and 'start column' attributes for TeField.voidsetStartPosition(Integer row, Integer column) Sets the 'start row' and 'start column' attributes for TeField.voidsetText(StringProperty text) Sets the content of TeField.voidSets the content of TeField.voidsetVisible(Boolean visible) Sets the Visible attribute for TeField.Methods inherited from class com.hp.lft.sdk.DescriptionBase
cloneTo, getIndex, getIndexType, getObjectProperties, getVRI, setIndex, setIndexType, setObjectProperties, setVRI, setVRIMethods inherited from class com.hp.lft.sdk.PropertiesDescription
cloneMethods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase
getValueAs, getValueAsStringProperty, insertValueMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.hp.lft.sdk.CloneableObject
clone
-
Constructor Details
-
FieldDescription
public FieldDescription()Constructs a new FieldDescription. -
FieldDescription
Initializes a new instance of the FieldDescription class using the Builder pattern.- Parameters:
init- the Builder pattern.
-
-
Method Details
-
setStartPosition
Sets the 'start row' and 'start column' attributes for TeField.- Parameters:
position- the 'start row' and 'start column' attributes for TeField.
-
setStartPosition
Sets the'start row' and 'start column' attributes for TeField.- Parameters:
position- the 'start row' and 'start column' attributes for TeField.
-
setStartPosition
Sets the 'start row' and 'start column' attributes for TeField.- Parameters:
row- in pixels.column- in pixels.
-
getStartPosition
Returns the 'start row' and 'start column' attributes for TeField.- Returns:
- the 'start row' and 'start column' attributes for TeField.
-
setId
Sets the id value of the field.- Parameters:
id- the id value of the field
-
getId
Returns the id value of the field.- Returns:
- the id value of the field.
-
setLength
Sets the field length in characters.- Parameters:
length- the field length in characters.
-
getLength
Returns the field length in characters.- Returns:
- the field length in characters.
-
setAttachedText
Sets the attached text attribute for TeField.- Parameters:
attachedText- a StringProperty(or RegExpProperty) representing the attached text attribute for TeField.
-
setAttachedText
Sets the attached text attribute for TeField.- Parameters:
attachedText- the attached text attribute for TeField.
-
getAttachedText
Sets the attached text attribute for TeField.- Returns:
- the attached text attribute for TeField.
-
setText
Sets the content of TeField.- Parameters:
text- a StringProperty(or RegExpProperty) representing the content of TeField.
-
setText
Sets the content of TeField.- Parameters:
text- the content of TeField.
-
getText
Sets the content of TeField.- Returns:
- the content of TeField.
-
setVisible
Sets the Visible attribute for TeField.- Parameters:
visible- true if visible.
-
isVisible
Indicates whether the TeField is visible.- Returns:
- true if visible.
-
setNumeric
Sets the numeric attribute for TeField.- Parameters:
numeric- true if numeric.
-
isNumeric
Indicates whether the TeField is numeric.- Returns:
- true if numeric.
-
setProtected
Sets the protected attribute for TeField.- Parameters:
isProtected- true if protected.
-
isProtected
Indicates whether the TeField is protected.- Returns:
- true if protected.
-