|
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.InputComponent
com.ibm.hats.transform.components.InputWithHintsComponent
public class InputWithHintsComponent
The Input with Hints component is for recognizing input fields (non-protected fields) that have hints (a set of valid values) to the right of the input field on the host screen.
A recognized command line can be rendered by the following widgets:
recognize() methods of this component return ComponentElement objects of type:
| Property | Description | Type | Default Value |
|---|---|---|---|
| clipInputFields | If true, only the part of the input field inside of the selected region is recognized and rendered. If false, if any part of an input field is inside the selected region, the entire input field is recognized and rendered. This setting is useful if you need to break a large host screen input field into multiple, smaller Web page input fields. | boolean | true |
| extractCaptions | If true, a caption for the recognized input field is extracted (see the description above for more information on this algorithm). This extracted caption can be used by the widget. | boolean | true |
| clipCaptions | If true, only the caption text in the selected region is rendered. If false, the end no such clipping occurs. | boolean | false |
| stripCaptions | If true, the end of the caption is stripped after (and including) the first occurrence of any value specified in the ?Strip after? setting. This setting is useful for cleaning up extracted captions. | boolean | true |
| stripAfterDelimiters | The string (or set of strings) that is used to strip the extracted caption. For example, if the extracted caption is ?Command ==>? and the value for this setting is ?=?, everything after (and including) the first ?=? is stripped off. | String | :|-|. |
| stripReplaceWith | The string that must immediately follow the description. | String | : |
| trimCaptions | If true, white space (spaces, tabs, etc) is removed from both ends of the extracted (and stripped) caption. | boolean | true |
| hintsStart | The string of characters which identifies where the set of hints starts. Multiple values can be specified for this setting; separate with the "|" (pipe character). | String | "(|[|{|<| " |
| hintsEnd | The string of characters which identifies where the set of hint ends. Multiple values can be specified for this setting; separate with the "|" (pipe character). | String | ")|]|}|>| " |
| hintsSeparator | The string of characters which separates each hint in the hint set. Multiple values can be specified for this setting; separate with the "|" (pipe character). | String | ",|or" |
| hintsLeadingTokenType | Specifies what each hint is. For example, if the hint set was "A=Apple,O=Orange,G=Grape", you would set this value to "Letter" (or "Letter or Digit") because "A", "O", and "G" are all letters. You would set the delimiter to "=". Valid values: LETTER, DIGIT, EITHER | enum | EITHER |
| hintsMaxLeadingTokenLength | Specifies the maximum length of the leading token. | int | 4 |
| hintsDelimiter | The string of characters which separates the leading token from the hint description. This setting only applies when the leading token type is not "None". | String | "=|-" |
| minimumReqHints | The minimum number of hints that must be found for this input field to be recognized by this component. This setting is useful for avoiding errant recognition. | int | 1 |
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static Properties |
defaults
|
static String |
LEADINGTOKEN_NONE
|
static String |
PROPERTY_HINTS_DELIMITER
|
static String |
PROPERTY_HINTS_END
|
static String |
PROPERTY_HINTS_LEADING_TOKEN_TYPE
|
static String |
PROPERTY_HINTS_MAX_LEADING_TOKEN_LENGTH
|
static String |
PROPERTY_HINTS_SEPARATOR
|
static String |
PROPERTY_HINTS_START
|
static String |
PROPERTY_MINIMUM_REQ_HINTS
|
protected boolean |
rtlScreen
|
| Fields inherited from class com.ibm.hats.transform.components.InputComponent |
|---|
BIDIInputFieldwithHints, PROPERTY_CLIP_CAPTIONS, PROPERTY_CLIP_INPUT_FIELDS, PROPERTY_EXTRACT_CAPTIONS, PROPERTY_STRIP_AFTER_DELIMITERS, PROPERTY_STRIP_CAPTIONS, PROPERTY_STRIP_REPLACE_WITH, PROPERTY_TRIM_CAPTIONS, reverseComponent |
| 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 | |
|---|---|
InputWithHintsComponent(HsrScreen hostScreen)
|
|
| Method Summary | |
|---|---|
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
Properties |
getDefaultValues(int iPageNumber)
Returns this object's default property values. |
ComponentElementList |
getHints(int inputFieldStart,
int inputFieldLength,
BlockScreenRegion ropedRegion,
String hintsStart,
String hintsEnd,
String hintsSeparators,
String hintsLeadingTokenType,
String hintsMaxLeadingTokenLength,
String hintsDelimiters)
Returns a list of ListItemComponentElement objects, each representing a recognized hint. |
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Returns an array of InputComponentElement objects, each representing an input field which has hints associated with it. |
| Methods inherited from class com.ibm.hats.transform.components.InputComponent |
|---|
getFieldCaption, isAllowed, isPropertyAllowed, recognize |
| Methods inherited from class com.ibm.hats.transform.components.Component |
|---|
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getHostScreen, 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_HINTS_START
public static final String PROPERTY_HINTS_END
public static final String PROPERTY_HINTS_SEPARATOR
public static final String PROPERTY_HINTS_LEADING_TOKEN_TYPE
public static final String PROPERTY_HINTS_MAX_LEADING_TOKEN_LENGTH
public static final String PROPERTY_HINTS_DELIMITER
public static final String PROPERTY_MINIMUM_REQ_HINTS
public static final String LEADINGTOKEN_NONE
protected boolean rtlScreen
public static Properties defaults
| Constructor Detail |
|---|
public InputWithHintsComponent(HsrScreen hostScreen)
| Method Detail |
|---|
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
InputComponentElement objects, each representing an input field which has hints associated with it.
recognize in class InputComponentregion - rectangular region to search insettings - recognition settings (see the table above)
InputComponentElement objects.Component.recognize(BlockScreenRegion, Properties)
public ComponentElementList getHints(int inputFieldStart,
int inputFieldLength,
BlockScreenRegion ropedRegion,
String hintsStart,
String hintsEnd,
String hintsSeparators,
String hintsLeadingTokenType,
String hintsMaxLeadingTokenLength,
String hintsDelimiters)
ListItemComponentElement objects, each representing a recognized hint.
inputFieldStart - The linear, 1-based start position of the input field.inputFieldLength - The length (size) of the input field.ropedRegion - The region selected for the componenthintsStart - (see settings table above)hintsEnd - (see settings table above)hintsSeparators - (see settings table above)hintsLeadingTokenType - (see settings table above)hintsMaxLeadingTokenLength - (see settings table above)hintsDelimiters -
ListItemComponentElement objects, each representing a recognized hint.public int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class InputComponent
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class InputComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertypublic Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class InputComponentiPageNumber - page for which to retrieve default properties
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||