|
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.CommandLineComponent
public class CommandLineComponent
The Command Line component is responsible for recognizing input fields which have a specific string of characters (the token) preceding the input field.
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 |
|---|---|---|---|
| token | The string of characters which must precede the input field. | String | ==> |
| extractCaptions | If true, a caption for the recognized input field is extracted (see the description for com.ibm.hats.transform.components.InputComponent for more information). This extracted caption can be used by the widget. | boolean | true |
| trimCaptions | If true, white space (spaces, tabs, etc) is removed from both ends of the extracted (and stripped) caption. | boolean | true |
| 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 |
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static Properties |
defaults
|
protected boolean |
isrtlcomponent
|
protected boolean |
isrtldisplay
|
protected boolean |
isrtltext
|
static String |
PROPERTY_TOKEN
|
| 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 | |
|---|---|
CommandLineComponent(HsrScreen hostScreen)
Constructs a new component object. |
|
| 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. |
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Returns an array of InputComponentElement objects representing each command line found in the specified region using the specified settings. |
void |
swapBuffer(char[] buffer)
|
| 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_TOKEN
public static Properties defaults
protected boolean isrtldisplay
protected boolean isrtltext
protected boolean isrtlcomponent
| Constructor Detail |
|---|
public CommandLineComponent(HsrScreen hostScreen)
hostScreen - Screen to search for command lines in.| Method Detail |
|---|
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
InputComponentElement objects representing each command line found in the specified region using the specified settings.
recognize in class InputComponentregion - Rectangular region to search insettings - Recognition settings (see the table above)
InputComponentElement objects.Component.recognize(BlockScreenRegion, Properties)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
public void swapBuffer(char[] buffer)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||