Package com.hp.lft.sdk.web

Class EditFieldBaseDescription

java.lang.Object

com.hp.lft.sdk.internal.PropertiesDescriptionBase

com.hp.lft.sdk.PropertiesDescription

com.hp.lft.sdk.DescriptionBase

com.hp.lft.sdk.web.WebBaseDescription

com.hp.lft.sdk.web.WebElementDescription

com.hp.lft.sdk.web.FormFieldDescription

com.hp.lft.sdk.web.EditFieldBaseDescription

All Implemented Interfaces:

CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable

Direct Known Subclasses:

EditFieldDescription, FileFieldDescription

public abstract class EditFieldBaseDescription
extends FormFieldDescription

A base class description for all edit fields (Edit, Number and File).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EditFieldBaseDescription.Init<T extends EditFieldBaseDescription.Init<T>>	Helper class for derived Builder classes.

Nested classes/interfaces inherited from class com.hp.lft.sdk.web.WebElementDescription

WebElementDescription.Builder

Field Summary

Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EditFieldBaseDescription()
protected	EditFieldBaseDescription(EditFieldBaseDescription.Init<?> init)

Method Summary

Modifier and Type	Method	Description
Integer	getMaxCharsInLine()	Returns the number of characters that will be presented in each row.
StringProperty	getPlaceholder()	Returns the hint text that is displayed in the edit box until a value is entered into it.
StringProperty	getValue()	Returns the current text in the field.
Boolean	isEnabled()	Indicates whether the check box is enabled.
Boolean	isReadOnly()	Returns true if the object is read-only.
Boolean	isRequired()	Returns true if the field is mandatory.
void	setEnabled(Boolean isEnabled)	Sets whether the check box is enabled.
void	setMaxCharsInLine(Integer maxCharsInLine)	Sets the number of characters that will be presented in each row.
void	setPlaceholder(StringProperty placeholder)	Sets the hint text that is displayed in the edit box until a value is entered into it.
void	setPlaceholder(String placeholder)	Sets the hint text that is displayed in the edit box until a value is entered into it.
void	setReadOnly(Boolean readOnly)	Sets whether or not the control is read only.
void	setRequired(Boolean required)	Sets whether or not the field is mandatory in the form.
void	setValue(StringProperty value)	Sets the text in the field.
void	setValue(String value)	Sets the text in the field.

Methods inherited from class com.hp.lft.sdk.web.FormFieldDescription

getType, setType, setType

Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath

Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible

Methods inherited from class com.hp.lft.sdk.DescriptionBase

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

EditFieldBaseDescription

protected EditFieldBaseDescription(EditFieldBaseDescription.Init<?> init)

EditFieldBaseDescription

protected EditFieldBaseDescription()

Method Details

setValue

public void setValue(StringProperty value)

Sets the text in the field.

Parameters:

value - a StringProperty (or RegExpProperty) representing the text in the field.

setValue

public void setValue(String value)

Sets the text in the field.

Parameters:

value - the text in the field.

getValue

public StringProperty getValue()

Returns the current text in the field.

Returns:

the current text in the field.

setPlaceholder

public void setPlaceholder(StringProperty placeholder)

Sets the hint text that is displayed in the edit box until a value is entered into it.

Parameters:

placeholder - a StringProperty (or RegExpProperty) representing the hint text that is displayed in the edit box until a value is entered into it.

setPlaceholder

public void setPlaceholder(String placeholder)

Sets the hint text that is displayed in the edit box until a value is entered into it.

Parameters:

placeholder - the hint text that is displayed in the edit box until a value is entered into it.

getPlaceholder

public StringProperty getPlaceholder()

Returns the hint text that is displayed in the edit box until a value is entered into it.

Returns:

the hint text that is displayed in the edit box until a value is entered into it.

setReadOnly

public void setReadOnly(Boolean readOnly)

Sets whether or not the control is read only.

Parameters:

readOnly - whether or not the control is read only.

isReadOnly

public Boolean isReadOnly()

Returns true if the object is read-only.

Returns:

true if read-only.

setRequired

public void setRequired(Boolean required)

Sets whether or not the field is mandatory in the form.

Parameters:

required - whether or not the field is mandatory in the form.

isRequired

public Boolean isRequired()

Returns true if the field is mandatory.

Returns:

True if the field is mandatory.

setMaxCharsInLine

public void setMaxCharsInLine(Integer maxCharsInLine)

Sets the number of characters that will be presented in each row.

Parameters:

maxCharsInLine - the number of characters that will be presented in each row.

getMaxCharsInLine

public Integer getMaxCharsInLine()

Returns the number of characters that will be presented in each row.

Returns:

the number of characters that will be presented in each row.

setEnabled

public void setEnabled(Boolean isEnabled)

Sets whether the check box is enabled.

Parameters:

isEnabled - true if enabled.

isEnabled

public Boolean isEnabled()

Indicates whether the check box is enabled.

Returns:

true if enabled.