|
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.SubfileComponentV6
public class SubfileComponentV6
The Subfile component is responsible for recognizing 5250 subfiles in a specified region of a host screen.
A recognized subfile can be rendered by the following widgets:
recognize() methods of this component return ComponentElement objects of type:
| Property | Description | Type | Default Value |
|---|---|---|---|
| subfilePass1UseDefault | If true, use the default recognition algorithm for matching the subfile. If false, use customized settings to recognize the subfile. | boolean | true |
| Action Recognition | |||
| subfileActionStartRow | First row to look for the subfile action | int | 3 |
| subfileActionStartCol | First column to look for the subfile action | int | 1 |
| subfileActionEndRow | Last row to look for the subfile action | int | 12 |
| subfileActionEndCol | Last column to look for the subfile action | int | 80 |
| subfileValueBeforeLeadingToken | This value specifies the string before leading token. The default value is " ". | String | " " |
| subfileLeadingTokenType | This value is the type of token this host application uses for the host command. In the example where "1=Edit", the '1' token is the host command, and its type is a digit. In the example where "A=Edit", the 'A' token is the host command, and its type is a letter. The allowable values are DIGIT, LETTER, EITHER | enum | EITHER |
| subfileTokensForDelimiter | This value is the token used in the subfile action to delimit the host command from the description of the host command. In the example where "1=Edit", '1' is the host command, the "=" token is the delimiter, and "Edit" is the description of the host command. The allowable value is one or more strings concatenated by the pipe token, "|". Example: "=| = |-| - |:". | String | = |
| subfileMustCheckColor | This value is used in conjunction with previous setting to designate that the subfile action's host command must be of a specific type and the subfile action must be a specific color. For example, the subfile action must be a digit, and must be blue. The allowable values are "true" or "false". | boolean | false |
| subfileMustBeColors | See description for the previous setting. | enum | BLUE |
| subfileActionHighIntensity | This value specifies whether the subfile action uses the high intensity field attribute. The allowable values are "true", "false" and "EITHER". | String | EITHER |
| subfileEmptyActions | Recognize subfile even if it does not have any actions. The subfile header, data, and marker are still recognized and rendered. | boolean | false |
| subfileConsumeAboveActionRows | Check this box if you want rows on the screen that contain text immediately above and adjacent to the actions, which meet the recognition criteria (color and/or intensity), consumed but not displayed by the subfile widget. | boolean | false |
| Header Recognition | |||
| subfileHeaderStartRow | First row to look for the subfile header | int | 3 |
| subfileHeaderStartCol | First column to look for the subfile header | int | 1 |
| subfileHeaderEndRow | Last row to look for the subfile header | int | 16 |
| subfileHeaderEndCol | Last column to look for the subfile header | int | 80 |
| subfileHeaderByToken | This value specifies whether the subfile header could be recognized based on strings. The allowable values are "true" or "false". | boolean | false |
| subfileTokensForHeader | Strings that can be used to identify subfile headers; use "\n" to define multi-row headers. The allowable values should be concatenated with the pipe character, "|" More specific headers should be listed first. For example, if "Option", "Opt.", and "Opt" are all possible headers, they should be ordered so that the most specific header is listed first, "Option|Opt.|Opt" The default is "true". Example: "Description\nof Record|Option|Opt.|?". | String | Opt |
| subfileCheckColorForHeaderToken | This value is used in conjunction with the "Text" setting to designate that the subfile headers must have a specific string and must be a specific color. For example, the subfile header must contain the word "Opt." and it must be blue. The allowable values are "true" or "false". | boolean | false |
| subfileColorsForHeaderToken | Specifies the color of the subfile header. | enum | BLUE |
| subfileHeaderByHighIntensity | This specifies whether or not the Subfile Header could be recognized by text at the top of a table of data, which uses the high intensity field attribute. The allowable values are "true" or "false". | boolean | true |
| subfileHeaderByColor | This specifies if the subfile header could be recognized by text of a specific color at the top of a table of data. The allowable values are "true" or "false". | boolean | false |
| subfileColorsForHeader | Specifies the color of the subfile header. | enum | BLUE |
| Data Recognition | |||
| subfileDataStartRow | First row to look for the subfile data | int | 4 |
| subfileDataStartCol | First column to look for the subfile data | int | 1 |
| subfileDataEndRow | Last row to look for the subfile data | int | 22 |
| subfileDataEndCol | Last column to look for the subfile data | int | 80 |
| tableComponentClassName | This specifies if the subfile is recognized/rendered by using visual hint, field information or render the drop-down lists for detected actions, and render each record line-by-line. The values can be "com.ibm.hats.transform.components.VisualTableComponent", "com.ibm.hats.transform.components.FieldTableComponent" and "none". | String | none |
| subfileOverrideActionFieldStartCol | Override the starting column of the action input field to prevent from other input fields from being rendered incorrectly as drop-down lists. | boolean | false |
| subfileActionFieldStartCol | Specify the starting column for the location of the overridden input field. For subfiles with multiple columns (having multiple action input fields in the same row), specify the multiple starting columns separated by a comma (,), such as 4,35. For subfiles with starting columns that are not consistent, specify the starting columns separated by a vertical bar (|), such as 1|2|3. Only one of the delimiters (comma or vertical bar) can be used at a time. The use of the delimiters is mutually exclusive. | int | 1 |
| subfileOverrideActionFieldLength | Override the length of the action input field to prevent from other input fields from being rendered incorrectly as drop-down lists. | boolean | false |
| subfileActionFieldLength | Specify the length of the overridden input field. For subfiles with field lengths that are not consistent, specify the field lengths separated by a vertical bar (|), such as 1|2|3. | int | 1 |
| subfileColumnBreaks | The comma-separated or ranged set of logical columns to specify the column breaks from selected screen region to customize a table column definition. Example values: "10,20,30....", "20,30-35", "30-35" | String | " " |
| subfileColumnDelimiter | The string of characters which must exist in every row of the selected region for the host screen column to be marked as a table column. If consecutive columns are each marked as a delimiting column, only the last column is actually rendered as the delimiting column of the generated table. | String | " " |
| subfileEmptyData | Recognize subfile even if it does not have any data. If any subfile actions are detected, they are still rendered as drop-down lists. | boolean | false |
| Marker Recognition | |||
| subfileMarkerStartRow | First row to look in for the end marker | int | 13 |
| subfileMarkerStartCol | First column to look in for the end marker. | int | 41 |
| subfileMarkerEndRow | Last row to look in for the end marker | int | 24 |
| subfileMarkerEndCol | Last column to look in for the end marker. | int | 80 |
| subfileMarkerByToken | If true, the end marker of the subfile should be recognized by the specified string. | boolean | true |
| subfileTokensForMoreMarker | Strings that can be used to identify the subfile end marker. Multiple values are allowed. Example: "More...|Bottom|End|+". | String | More...|Bottom|+ |
| subfileMarkerByHighIntensity | If true, the end marker of the subfile could be recognized by a high intensity field below the data table. | boolean | true |
| subfileNoVisibleTextRequiredForHighIntensity | If true, the end marker of the subfile could be recognized by a high intensity field with empty string below the data table. | boolean | false |
| subfileMarkerByEmptyLine | Last column to look in for a high intensity field. | boolean | false |
| Fields inherited from class com.ibm.hats.transform.components.Component |
|---|
contextAttributes, flag, hostScreen |
| Constructor Summary | |
|---|---|
SubfileComponentV6(HsrScreen hostScreen)
Constructor for SubfileComponentV6. |
|
| Method Summary | |
|---|---|
String |
getCustomCompositeName()
|
int |
getRecognitionState()
Returns the recognition state of subfile component. |
List[] |
getRecognizedRegions()
Returns the recognition regions of subfile component. |
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Method to recognize components in the specified BlockScreenRegion using the specified settings. |
ComponentElement[] |
recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
Currently not implemented. |
protected static FieldRowComponentElement |
splitData(FieldRowComponentElement frce,
int[] breaks,
int numOfColumns,
HsrScreen hs,
ContextAttributes contextAttributes)
Method that use the column breaks to split FieldRowComponentElement object into separate parts. |
| Methods inherited from class com.ibm.hats.transform.components.Component |
|---|
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getCustomProperties, 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 |
| Methods inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
getCustomComposite, getCustomProperties, getDefaultValues, getPropertyPageCount |
| Field Detail |
|---|
public static final String CLASSNAME
public static final String CLASS_NAME
public static final String PROPERTY_SUBFILE_ACTION_START_ROW
public static final String PROPERTY_SUBFILE_ACTION_START_COL
public static final String PROPERTY_SUBFILE_ACTION_END_ROW
public static final String PROPERTY_SUBFILE_ACTION_END_COL
public static final String PROPERTY_SUBFILE_VALUE_BEFORE_LEADING_TOKEN
public static final String PROPERTY_SUBFILE_LEADING_TOKEN_TYPE
public static final String PROPERTY_SUBFILE_MAX_LEADING_TOKEN_LENGTH
public static final String PROPERTY_SUBFILE_TOKENS_FOR_DELIMITER
public static final String PROPERTY_SUBFILE_END_DELIMITER
public static final String PROPERTY_SUBFILE_MUST_CHECK_COLOR
public static final String PROPERTY_SUBFILE_MUST_BE_COLORS
public static final String PROPERTY_SUBFILE_ACTION_BY_HIGH_INTENSITY
public static final String PROPERTY_SUBFILE_EMPTY_ACTIONS
public static final String PROPERTY_SUBFILE_ACTION_RTL_Component_RECOGNITION
public static final String PROPERTY_SUBFILE_CONSUME_ABOVE_ACTION_ROWS
public static final String PROPERTY_SUBFILE_HEADER_START_ROW
public static final String PROPERTY_SUBFILE_HEADER_START_COL
public static final String PROPERTY_SUBFILE_HEADER_END_ROW
public static final String PROPERTY_SUBFILE_HEADER_END_COL
public static final String PROPERTY_SUBFILE_HEADER_BY_TOKEN
public static final String PROPERTY_SUBFILE_TOKENS_FOR_HEADER
public static final String PROPERTY_SUBFILE_CHECK_COLOR_FOR_HEADER_TOKEN
public static final String PROPERTY_SUBFILE_COLORS_FOR_HEADER_TOKEN
public static final String PROPERTY_SUBFILE_HEADER_BY_HIGH_INTENSITY
public static final String PROPERTY_SUBFILE_HEADER_BY_COLOR
public static final String PROPERTY_SUBFILE_COLORS_FOR_HEADER
public static final String PROPERTY_SUBFILE_HEADER_RTL_Component_RECOGNITION
public static final String PROPERTY_SUBFILE_DATA_START_ROW
public static final String PROPERTY_SUBFILE_DATA_START_COL
public static final String PROPERTY_SUBFILE_DATA_END_ROW
public static final String PROPERTY_SUBFILE_DATA_END_COL
public static final String PROPERTY_SUBFILE_RECOGNITION_OPTION
public static final String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_START_COL
public static final String PROPERTY_SUBFILE_ACTION_FIELD_START_COL
public static final String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_LENGTH
public static final String PROPERTY_SUBFILE_ACTION_FIELD_LENGTH
public static final String PROPERTY_SUBFILE_COLUMN_DELIMITER
public static final String PROPERTY_SUBFILE_COLUMN_BREAKS
public static final String PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT
public static final String PROPERTY_SUBFILE_EMPTY_DATA
public static final String PROPERTY_SUBFILE_DATA_TABLE_USE_TABLE_CE
public static final String PROPERTY_SUBFILE_MARKER_START_ROW
public static final String PROPERTY_SUBFILE_MARKER_START_COL
public static final String PROPERTY_SUBFILE_MARKER_END_ROW
public static final String PROPERTY_SUBFILE_MARKER_END_COL
public static final String PROPERTY_SUBFILE_MARKER_BY_TOKEN
public static final String PROPERTY_SUBFILE_TOKENS_FOR_MORE_MARKER
public static final String PROPERTY_SUBFILE_MARKER_BY_HIGH_INTENSITY
public static final String PROPERTY_SUBFILE_NO_VISIBLE_TEXT_REQUIRED_FOR_HIGH_INTENSITY
public static final String PROPERTY_SUBFILE_MARKER_BY_EMPTY_LINE
public static String TABLE_COMPONENT_CLASS_NAME_VISUAL
public static String TABLE_COMPONENT_CLASS_NAME_FIELD
public static String TABLE_COMPONENT_CLASS_NAME_TABLE
public static String TABLE_COMPONENT_CLASS_NAME_NONE
public static int SUBFILE_RECOGNITION_STATE_NONE
public static int SUBFILE_RECOGNITION_STATE_ACTION
public static int SUBFILE_RECOGNITION_STATE_HEADER
public static int SUBFILE_RECOGNITION_STATE_DATA
public static int SUBFILE_RECOGNITION_STATE_MARKER
public static int SUBFILE_RECOGNITION_STATE_SUCCESS
public static int[] recognitionOrder
public boolean isRcpProject
public static Properties defaults
| Constructor Detail |
|---|
public SubfileComponentV6(HsrScreen hostScreen)
hostScreen - | Method Detail |
|---|
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
ComponentBlockScreenRegion using the specified settings.This method must be implemented if the base class is subclassed.
recognize in class Componentregion - BlockScreenRegion to search insettings - recognition settings
Component.recognize(BlockScreenRegion, Properties)
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
ComponentThis method must be implemented if the base class is subclassed.
recognize in class ComponentComponent.recognize(LinearScreenRegion, Properties)public int getRecognitionState()
public List[] getRecognizedRegions()
public String getCustomCompositeName()
getCustomCompositeName in interface com.ibm.hats.common.ICustomPropertySupplier2
protected static FieldRowComponentElement splitData(FieldRowComponentElement frce,
int[] breaks,
int numOfColumns,
HsrScreen hs,
ContextAttributes contextAttributes)
frce - The FieldRowComponentElement.breaks - An array of column breaks.numOfColumns - Number of columns on the host screen.hs - The host screen object used by this component.contextAttributes - Context attributes
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||