Package com.hp.lft.sdk.uiapro

Interface TextPattern

public interface TextPattern

The methods and properties used to interact with text.

Method Summary

Modifier and Type	Method	Description
void	clearSelection()	Deselect all / any selected text from the object
String	getSelection()
SupportedTextSelection	getSupportedTextSelection()
String	getText()
String	getVisibleText()
void	scrollIntoView(int numberOfUnits)	Scrolls into view.
void	scrollIntoView(int numberOfUnits, TextUnit unitType)	Scrolls into view.
void	scrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction)	Scrolls into view.
void	scrollIntoView(int numberOfUnits, TextUnit unitType, Direction direction, Alignment alignment)	Scrolls into view.
void	select(int start)	Selects the specified text in the object.
void	select(int start, int length)	Selects the specified text in the object.
void	selectAll()	Selects all the object's text.

Method Details

getText

String getText()
        throws GeneralLeanFtException

Returns:

The object's text.

Throws:

GeneralLeanFtException - if error occurs during execution.

getVisibleText

String getVisibleText()
               throws GeneralLeanFtException

Returns:

The object's visible text.

Throws:

GeneralLeanFtException - if error occurs during execution.

getSelection

String getSelection()
             throws GeneralLeanFtException

Returns:

The object's selected text, or an empty string if no text is selected.

Throws:

GeneralLeanFtException - if error occurs during execution.

getSupportedTextSelection

SupportedTextSelection getSupportedTextSelection()
                                          throws GeneralLeanFtException

Returns:

The type of text selection that is supported by the control.

Throws:

GeneralLeanFtException - if error occurs during execution.

clearSelection

void clearSelection()
             throws GeneralLeanFtException

Deselect all / any selected text from the object

Throws:

GeneralLeanFtException - if error occurs during execution.

scrollIntoView

void scrollIntoView(int numberOfUnits)
             throws GeneralLeanFtException

Scrolls into view.

Parameters:

numberOfUnits - 0-based index

Throws:

GeneralLeanFtException - if error occurs during execution.

scrollIntoView

void scrollIntoView(int numberOfUnits,
 TextUnit unitType)
             throws GeneralLeanFtException

Scrolls into view.

Parameters:

numberOfUnits - 0-based index

unitType - The unit type

Throws:

GeneralLeanFtException - if error occurs during execution.

scrollIntoView

void scrollIntoView(int numberOfUnits,
 TextUnit unitType,
 Direction direction)
             throws GeneralLeanFtException

Scrolls into view.

Parameters:

numberOfUnits - 0-based index

unitType - The unit type

direction - The direction of scrolling

Throws:

GeneralLeanFtException - if error occurs during execution.

scrollIntoView

void scrollIntoView(int numberOfUnits,
 TextUnit unitType,
 Direction direction,
 Alignment alignment)
             throws GeneralLeanFtException

Scrolls into view.

Parameters:

numberOfUnits - 0-based index

unitType - The unit type

direction - The direction of scrolling

alignment - The alignment

Throws:

GeneralLeanFtException - if error occurs during execution.

select

void select(int start)
     throws GeneralLeanFtException

Selects the specified text in the object.

Parameters:

start - The 0 based index position of the selection begin

Throws:

GeneralLeanFtException - if error occurs during execution.

select

void select(int start,
 int length)
     throws GeneralLeanFtException

Selects the specified text in the object.

Parameters:

start - The 0 based index position of the selection begin

length - The number of characters to be selected. If not specified all remaining text will be selected

Throws:

GeneralLeanFtException - if error occurs during execution.

selectAll

void selectAll()
        throws GeneralLeanFtException

Selects all the object's text.

Throws:

GeneralLeanFtException - if error occurs during execution.