|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.components.Component
com.ibm.hats.transform.components.PatternComponent
com.ibm.hats.transform.components.InputFieldByTextPatternComponent
public class InputFieldByTextPatternComponent
This pattern match component consumes all unconsumed input fields in the consumable field list which contain the specified text at the specified relation to the input field.
The recognize() methods of this component return ComponentElement objects of type:
| Property | Description | Type | Default Value |
|---|---|---|---|
| text | String that much exist for the candidate input field to match (maybe include the wildcard * character). | String | (empty) |
| location | Specifies where the text must appear (relative to the candidate input field). Valid values: ABOVE, BELOW, LEFT, RIGHT | enum | LEFT |
| caseSensitive | Specifies whether the candidate input field's candidate text must match the specified text exactly. | boolean | false |
PatternMatchComponentElement,
PatternComponent| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static Properties |
defaults
Properties object of default class settings |
static String |
LOCATION_ABOVE
|
static String |
LOCATION_BELOW
|
static String |
LOCATION_LEFT
|
static String |
LOCATION_RIGHT
|
static char |
MULTI_CHAR_WILDCARD
Multi-letter substitution wildcard character |
static String |
PROPERTY_CASE_SENSITIVE
Case sensitivity setting |
static String |
PROPERTY_ENFORCE_IMMEDIACY
|
static String |
PROPERTY_IMMEDIATELY_NEXT_TO
Immediately next to setting |
static String |
PROPERTY_LOCATION
Text location (relative to input field) |
static String |
PROPERTY_TEXT
Required text setting |
static char |
SINGLE_CHAR_WILDCARD
Single letter substitution wildcard characters (currently not supported) |
| Fields inherited from class com.ibm.hats.transform.components.PatternComponent |
|---|
consumableFieldList |
| Fields inherited from class com.ibm.hats.transform.components.Component |
|---|
contextAttributes, flag, hostScreen |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
CLASSNAME |
| Constructor Summary | |
|---|---|
InputFieldByTextPatternComponent(HsrScreen hostScreen)
Constructs a new InputFieldByTextPatternComponent pattern component. |
|
InputFieldByTextPatternComponent(HsrScreen hostScreen,
ConsumableFieldList consumableFieldList)
Constructs a new InputFieldByTextPatternComponent pattern component. |
|
| Method Summary | |
|---|---|
protected PatternMatchComponentElement |
addFoundComponentElement(HsrScreenField field,
int fieldIndex,
ArrayList ceList)
|
protected ArrayList |
findAllInputFields(String text,
boolean isCaseSensitive,
int location,
com.ibm.hats.transform.components.BidiSettings bidiSettings,
boolean isImmediateNext2,
boolean enforceImmediacy)
|
protected void |
findComponentElementsAboveText(ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
|
protected void |
findComponentElementsBelowText(ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
|
protected void |
findComponentElementsLeftOfText(ScreenRegion textRegion,
ArrayList ceList)
|
protected void |
findComponentElementsRightOfText(ScreenRegion textRegion,
ArrayList ceList)
|
protected BlockScreenRegion |
findMatchingTextRegion(String text,
int location,
HsrScreenField field,
boolean isCaseSensitive,
com.ibm.hats.transform.components.BidiSettings bidiSettings,
boolean enforceImmediacy)
|
protected void |
findTheRestOfComponentElements(int location,
ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
|
protected void |
findTheRestOfComponentElements(int location,
ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList,
com.ibm.hats.transform.components.BidiSettings bidiSettings)
|
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
protected BlockScreenRegion |
getSearchRegion(int location,
HsrScreenField field)
|
protected boolean |
isArabicSession()
|
protected boolean |
isBidiSession()
|
protected int |
isMatch(String lookFor,
String lookIn,
com.ibm.hats.transform.components.BidiSettings bidiSettings)
|
protected boolean |
isRTLScreen()
|
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Returns an array of PatternMatchComponentElement objects, each representing a field in the consumable field list that was consumed. |
ComponentElement[] |
recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
Currently not supported. |
| Methods inherited from class com.ibm.hats.transform.components.PatternComponent |
|---|
getConsumableFieldList, newInstance, setConsumableFieldList |
| Methods inherited from class com.ibm.hats.transform.components.Component |
|---|
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getDefaultValues, getHostScreen, getPropertyPageCount, getTrailingSpaceCount, newInstance, recognize, setContextAttribute, setContextAttributes, setHostScreen |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
public static final String PROPERTY_TEXT
public static final String PROPERTY_LOCATION
public static final String PROPERTY_CASE_SENSITIVE
public static final String PROPERTY_IMMEDIATELY_NEXT_TO
public static final String PROPERTY_ENFORCE_IMMEDIACY
public static final String LOCATION_ABOVE
public static final String LOCATION_BELOW
public static final String LOCATION_LEFT
public static final String LOCATION_RIGHT
public static final char MULTI_CHAR_WILDCARD
public static final char SINGLE_CHAR_WILDCARD
public static final Properties defaults
| Constructor Detail |
|---|
public InputFieldByTextPatternComponent(HsrScreen hostScreen)
InputFieldByTextPatternComponent pattern component.
hostScreen -
public InputFieldByTextPatternComponent(HsrScreen hostScreen,
ConsumableFieldList consumableFieldList)
InputFieldByTextPatternComponent pattern component.
hostScreen - | Method Detail |
|---|
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
recognize in class Component
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
PatternMatchComponentElement objects, each representing a field in the consumable field list that was consumed.
recognize in class Componentregion - screen region to search insettings - (see table above)
protected ArrayList findAllInputFields(String text,
boolean isCaseSensitive,
int location,
com.ibm.hats.transform.components.BidiSettings bidiSettings,
boolean isImmediateNext2,
boolean enforceImmediacy)
protected BlockScreenRegion findMatchingTextRegion(String text,
int location,
HsrScreenField field,
boolean isCaseSensitive,
com.ibm.hats.transform.components.BidiSettings bidiSettings,
boolean enforceImmediacy)
protected BlockScreenRegion getSearchRegion(int location,
HsrScreenField field)
protected int isMatch(String lookFor,
String lookIn,
com.ibm.hats.transform.components.BidiSettings bidiSettings)
protected PatternMatchComponentElement addFoundComponentElement(HsrScreenField field,
int fieldIndex,
ArrayList ceList)
protected void findTheRestOfComponentElements(int location,
ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
protected void findTheRestOfComponentElements(int location,
ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList,
com.ibm.hats.transform.components.BidiSettings bidiSettings)
protected void findComponentElementsBelowText(ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
protected void findComponentElementsAboveText(ScreenRegion textRegion,
PatternMatchComponentElement initialElement,
ArrayList ceList)
protected void findComponentElementsLeftOfText(ScreenRegion textRegion,
ArrayList ceList)
protected void findComponentElementsRightOfText(ScreenRegion textRegion,
ArrayList ceList)
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class ComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertyprotected boolean isBidiSession()
protected boolean isArabicSession()
protected boolean isRTLScreen()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||