HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.components
Class SubfileComponentV6

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.SubfileComponentV6
All Implemented Interfaces:
ICustomPropertySupplier, com.ibm.hats.common.ICustomPropertySupplier2

public class SubfileComponentV6
extends Component
implements com.ibm.hats.common.ICustomPropertySupplier2

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:

The recognize() methods of this component return ComponentElement objects of type: The following settings can be configured for this component:

PropertyDescriptionTypeDefault Value
subfilePass1UseDefaultIf true, use the default recognition algorithm for matching the subfile. If false, use customized settings to recognize the subfile.booleantrue
Action Recognition
subfileActionStartRowFirst row to look for the subfile actionint3
subfileActionStartColFirst column to look for the subfile actionint1
subfileActionEndRowLast row to look for the subfile actionint12
subfileActionEndColLast column to look for the subfile actionint80
subfileValueBeforeLeadingTokenThis value specifies the string before leading token. The default value is " ".String" "
subfileLeadingTokenTypeThis 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, EITHERenumEITHER
subfileTokensForDelimiterThis 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=
subfileMustCheckColorThis 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".booleanfalse
subfileMustBeColorsSee description for the previous setting.enumBLUE
subfileActionHighIntensityThis value specifies whether the subfile action uses the high intensity field attribute. The allowable values are "true", "false" and "EITHER".String EITHER
subfileEmptyActionsRecognize subfile even if it does not have any actions. The subfile header, data, and marker are still recognized and rendered.booleanfalse
subfileConsumeAboveActionRowsCheck 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.booleanfalse
Header Recognition
subfileHeaderStartRowFirst row to look for the subfile headerint3
subfileHeaderStartColFirst column to look for the subfile headerint1
subfileHeaderEndRowLast row to look for the subfile headerint16
subfileHeaderEndColLast column to look for the subfile headerint80
subfileHeaderByTokenThis value specifies whether the subfile header could be recognized based on strings. The allowable values are "true" or "false". booleanfalse
subfileTokensForHeaderStrings 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.|?". StringOpt
subfileCheckColorForHeaderTokenThis 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". booleanfalse
subfileColorsForHeaderTokenSpecifies the color of the subfile header.enumBLUE
subfileHeaderByHighIntensityThis 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". booleantrue
subfileHeaderByColorThis 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". booleanfalse
subfileColorsForHeaderSpecifies the color of the subfile header. enumBLUE
Data Recognition
subfileDataStartRowFirst row to look for the subfile dataint4
subfileDataStartColFirst column to look for the subfile dataint1
subfileDataEndRowLast row to look for the subfile dataint22
subfileDataEndColLast column to look for the subfile dataint80
tableComponentClassNameThis 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".Stringnone
subfileOverrideActionFieldStartColOverride the starting column of the action input field to prevent from other input fields from being rendered incorrectly as drop-down lists.booleanfalse
subfileActionFieldStartColSpecify 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.int1
subfileOverrideActionFieldLengthOverride the length of the action input field to prevent from other input fields from being rendered incorrectly as drop-down lists.booleanfalse
subfileActionFieldLengthSpecify 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.int1
subfileColumnBreaksThe 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" "
subfileColumnDelimiterThe 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" "
subfileEmptyDataRecognize subfile even if it does not have any data. If any subfile actions are detected, they are still rendered as drop-down lists.booleanfalse
Marker Recognition
subfileMarkerStartRowFirst row to look in for the end markerint13
subfileMarkerStartColFirst column to look in for the end marker.int41
subfileMarkerEndRowLast row to look in for the end marker int24
subfileMarkerEndColLast column to look in for the end marker. int80
subfileMarkerByTokenIf true, the end marker of the subfile should be recognized by the specified string.booleantrue
subfileTokensForMoreMarkerStrings that can be used to identify the subfile end marker. Multiple values are allowed. Example: "More...|Bottom|End|+". StringMore...|Bottom|+
subfileMarkerByHighIntensityIf true, the end marker of the subfile could be recognized by a high intensity field below the data table. booleantrue
subfileNoVisibleTextRequiredForHighIntensityIf true, the end marker of the subfile could be recognized by a high intensity field with empty string below the data table. booleanfalse
subfileMarkerByEmptyLineLast column to look in for a high intensity field.booleanfalse


Field Summary
static String CLASS_NAME
           
static String CLASSNAME
           
static Properties defaults
           
 boolean isRcpProject
           
static String PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT
           
static String PROPERTY_SUBFILE_ACTION_BY_HIGH_INTENSITY
           
static String PROPERTY_SUBFILE_ACTION_END_COL
           
static String PROPERTY_SUBFILE_ACTION_END_ROW
           
static String PROPERTY_SUBFILE_ACTION_FIELD_LENGTH
           
static String PROPERTY_SUBFILE_ACTION_FIELD_START_COL
           
static String PROPERTY_SUBFILE_ACTION_RTL_Component_RECOGNITION
           
static String PROPERTY_SUBFILE_ACTION_START_COL
           
static String PROPERTY_SUBFILE_ACTION_START_ROW
           
static String PROPERTY_SUBFILE_CHECK_COLOR_FOR_HEADER_TOKEN
           
static String PROPERTY_SUBFILE_COLORS_FOR_HEADER
           
static String PROPERTY_SUBFILE_COLORS_FOR_HEADER_TOKEN
           
static String PROPERTY_SUBFILE_COLUMN_BREAKS
           
static String PROPERTY_SUBFILE_COLUMN_DELIMITER
           
static String PROPERTY_SUBFILE_CONSUME_ABOVE_ACTION_ROWS
           
static String PROPERTY_SUBFILE_DATA_END_COL
           
static String PROPERTY_SUBFILE_DATA_END_ROW
           
static String PROPERTY_SUBFILE_DATA_START_COL
           
static String PROPERTY_SUBFILE_DATA_START_ROW
           
static String PROPERTY_SUBFILE_DATA_TABLE_USE_TABLE_CE
           
static String PROPERTY_SUBFILE_EMPTY_ACTIONS
           
static String PROPERTY_SUBFILE_EMPTY_DATA
           
static String PROPERTY_SUBFILE_END_DELIMITER
           
static String PROPERTY_SUBFILE_HEADER_BY_COLOR
           
static String PROPERTY_SUBFILE_HEADER_BY_HIGH_INTENSITY
           
static String PROPERTY_SUBFILE_HEADER_BY_TOKEN
           
static String PROPERTY_SUBFILE_HEADER_END_COL
           
static String PROPERTY_SUBFILE_HEADER_END_ROW
           
static String PROPERTY_SUBFILE_HEADER_RTL_Component_RECOGNITION
           
static String PROPERTY_SUBFILE_HEADER_START_COL
           
static String PROPERTY_SUBFILE_HEADER_START_ROW
           
static String PROPERTY_SUBFILE_LEADING_TOKEN_TYPE
           
static String PROPERTY_SUBFILE_MARKER_BY_EMPTY_LINE
           
static String PROPERTY_SUBFILE_MARKER_BY_HIGH_INTENSITY
           
static String PROPERTY_SUBFILE_MARKER_BY_TOKEN
           
static String PROPERTY_SUBFILE_MARKER_END_COL
           
static String PROPERTY_SUBFILE_MARKER_END_ROW
           
static String PROPERTY_SUBFILE_MARKER_START_COL
           
static String PROPERTY_SUBFILE_MARKER_START_ROW
           
static String PROPERTY_SUBFILE_MAX_LEADING_TOKEN_LENGTH
           
static String PROPERTY_SUBFILE_MUST_BE_COLORS
           
static String PROPERTY_SUBFILE_MUST_CHECK_COLOR
           
static String PROPERTY_SUBFILE_NO_VISIBLE_TEXT_REQUIRED_FOR_HIGH_INTENSITY
           
static String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_LENGTH
           
static String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_START_COL
           
static String PROPERTY_SUBFILE_RECOGNITION_OPTION
           
static String PROPERTY_SUBFILE_TOKENS_FOR_DELIMITER
           
static String PROPERTY_SUBFILE_TOKENS_FOR_HEADER
           
static String PROPERTY_SUBFILE_TOKENS_FOR_MORE_MARKER
           
static String PROPERTY_SUBFILE_VALUE_BEFORE_LEADING_TOKEN
           
static int[] recognitionOrder
           
static int SUBFILE_RECOGNITION_STATE_ACTION
           
static int SUBFILE_RECOGNITION_STATE_DATA
           
static int SUBFILE_RECOGNITION_STATE_HEADER
           
static int SUBFILE_RECOGNITION_STATE_MARKER
           
static int SUBFILE_RECOGNITION_STATE_NONE
           
static int SUBFILE_RECOGNITION_STATE_SUCCESS
           
static String TABLE_COMPONENT_CLASS_NAME_FIELD
           
static String TABLE_COMPONENT_CLASS_NAME_NONE
           
static String TABLE_COMPONENT_CLASS_NAME_TABLE
           
static String TABLE_COMPONENT_CLASS_NAME_VISUAL
           
 
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

CLASSNAME

public static final String CLASSNAME
See Also:
Constant Field Values

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_START_ROW

public static final String PROPERTY_SUBFILE_ACTION_START_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_START_COL

public static final String PROPERTY_SUBFILE_ACTION_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_END_ROW

public static final String PROPERTY_SUBFILE_ACTION_END_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_END_COL

public static final String PROPERTY_SUBFILE_ACTION_END_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_VALUE_BEFORE_LEADING_TOKEN

public static final String PROPERTY_SUBFILE_VALUE_BEFORE_LEADING_TOKEN
See Also:
Constant Field Values

PROPERTY_SUBFILE_LEADING_TOKEN_TYPE

public static final String PROPERTY_SUBFILE_LEADING_TOKEN_TYPE
See Also:
Constant Field Values

PROPERTY_SUBFILE_MAX_LEADING_TOKEN_LENGTH

public static final String PROPERTY_SUBFILE_MAX_LEADING_TOKEN_LENGTH
See Also:
Constant Field Values

PROPERTY_SUBFILE_TOKENS_FOR_DELIMITER

public static final String PROPERTY_SUBFILE_TOKENS_FOR_DELIMITER
See Also:
Constant Field Values

PROPERTY_SUBFILE_END_DELIMITER

public static final String PROPERTY_SUBFILE_END_DELIMITER
See Also:
Constant Field Values

PROPERTY_SUBFILE_MUST_CHECK_COLOR

public static final String PROPERTY_SUBFILE_MUST_CHECK_COLOR
See Also:
Constant Field Values

PROPERTY_SUBFILE_MUST_BE_COLORS

public static final String PROPERTY_SUBFILE_MUST_BE_COLORS
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_BY_HIGH_INTENSITY

public static final String PROPERTY_SUBFILE_ACTION_BY_HIGH_INTENSITY
See Also:
Constant Field Values

PROPERTY_SUBFILE_EMPTY_ACTIONS

public static final String PROPERTY_SUBFILE_EMPTY_ACTIONS
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_RTL_Component_RECOGNITION

public static final String PROPERTY_SUBFILE_ACTION_RTL_Component_RECOGNITION
See Also:
Constant Field Values

PROPERTY_SUBFILE_CONSUME_ABOVE_ACTION_ROWS

public static final String PROPERTY_SUBFILE_CONSUME_ABOVE_ACTION_ROWS
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_START_ROW

public static final String PROPERTY_SUBFILE_HEADER_START_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_START_COL

public static final String PROPERTY_SUBFILE_HEADER_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_END_ROW

public static final String PROPERTY_SUBFILE_HEADER_END_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_END_COL

public static final String PROPERTY_SUBFILE_HEADER_END_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_BY_TOKEN

public static final String PROPERTY_SUBFILE_HEADER_BY_TOKEN
See Also:
Constant Field Values

PROPERTY_SUBFILE_TOKENS_FOR_HEADER

public static final String PROPERTY_SUBFILE_TOKENS_FOR_HEADER
See Also:
Constant Field Values

PROPERTY_SUBFILE_CHECK_COLOR_FOR_HEADER_TOKEN

public static final String PROPERTY_SUBFILE_CHECK_COLOR_FOR_HEADER_TOKEN
See Also:
Constant Field Values

PROPERTY_SUBFILE_COLORS_FOR_HEADER_TOKEN

public static final String PROPERTY_SUBFILE_COLORS_FOR_HEADER_TOKEN
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_BY_HIGH_INTENSITY

public static final String PROPERTY_SUBFILE_HEADER_BY_HIGH_INTENSITY
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_BY_COLOR

public static final String PROPERTY_SUBFILE_HEADER_BY_COLOR
See Also:
Constant Field Values

PROPERTY_SUBFILE_COLORS_FOR_HEADER

public static final String PROPERTY_SUBFILE_COLORS_FOR_HEADER
See Also:
Constant Field Values

PROPERTY_SUBFILE_HEADER_RTL_Component_RECOGNITION

public static final String PROPERTY_SUBFILE_HEADER_RTL_Component_RECOGNITION
See Also:
Constant Field Values

PROPERTY_SUBFILE_DATA_START_ROW

public static final String PROPERTY_SUBFILE_DATA_START_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_DATA_START_COL

public static final String PROPERTY_SUBFILE_DATA_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_DATA_END_ROW

public static final String PROPERTY_SUBFILE_DATA_END_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_DATA_END_COL

public static final String PROPERTY_SUBFILE_DATA_END_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_RECOGNITION_OPTION

public static final String PROPERTY_SUBFILE_RECOGNITION_OPTION
See Also:
Constant Field Values

PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_START_COL

public static final String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_FIELD_START_COL

public static final String PROPERTY_SUBFILE_ACTION_FIELD_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_LENGTH

public static final String PROPERTY_SUBFILE_OVERRIDE_ACTION_FIELD_LENGTH
See Also:
Constant Field Values

PROPERTY_SUBFILE_ACTION_FIELD_LENGTH

public static final String PROPERTY_SUBFILE_ACTION_FIELD_LENGTH
See Also:
Constant Field Values

PROPERTY_SUBFILE_COLUMN_DELIMITER

public static final String PROPERTY_SUBFILE_COLUMN_DELIMITER
See Also:
Constant Field Values

PROPERTY_SUBFILE_COLUMN_BREAKS

public static final String PROPERTY_SUBFILE_COLUMN_BREAKS
See Also:
Constant Field Values

PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT

public static final String PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT
See Also:
Constant Field Values

PROPERTY_SUBFILE_EMPTY_DATA

public static final String PROPERTY_SUBFILE_EMPTY_DATA
See Also:
Constant Field Values

PROPERTY_SUBFILE_DATA_TABLE_USE_TABLE_CE

public static final String PROPERTY_SUBFILE_DATA_TABLE_USE_TABLE_CE
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_START_ROW

public static final String PROPERTY_SUBFILE_MARKER_START_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_START_COL

public static final String PROPERTY_SUBFILE_MARKER_START_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_END_ROW

public static final String PROPERTY_SUBFILE_MARKER_END_ROW
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_END_COL

public static final String PROPERTY_SUBFILE_MARKER_END_COL
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_BY_TOKEN

public static final String PROPERTY_SUBFILE_MARKER_BY_TOKEN
See Also:
Constant Field Values

PROPERTY_SUBFILE_TOKENS_FOR_MORE_MARKER

public static final String PROPERTY_SUBFILE_TOKENS_FOR_MORE_MARKER
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_BY_HIGH_INTENSITY

public static final String PROPERTY_SUBFILE_MARKER_BY_HIGH_INTENSITY
See Also:
Constant Field Values

PROPERTY_SUBFILE_NO_VISIBLE_TEXT_REQUIRED_FOR_HIGH_INTENSITY

public static final String PROPERTY_SUBFILE_NO_VISIBLE_TEXT_REQUIRED_FOR_HIGH_INTENSITY
See Also:
Constant Field Values

PROPERTY_SUBFILE_MARKER_BY_EMPTY_LINE

public static final String PROPERTY_SUBFILE_MARKER_BY_EMPTY_LINE
See Also:
Constant Field Values

TABLE_COMPONENT_CLASS_NAME_VISUAL

public static String TABLE_COMPONENT_CLASS_NAME_VISUAL

TABLE_COMPONENT_CLASS_NAME_FIELD

public static String TABLE_COMPONENT_CLASS_NAME_FIELD

TABLE_COMPONENT_CLASS_NAME_TABLE

public static String TABLE_COMPONENT_CLASS_NAME_TABLE

TABLE_COMPONENT_CLASS_NAME_NONE

public static String TABLE_COMPONENT_CLASS_NAME_NONE

SUBFILE_RECOGNITION_STATE_NONE

public static int SUBFILE_RECOGNITION_STATE_NONE

SUBFILE_RECOGNITION_STATE_ACTION

public static int SUBFILE_RECOGNITION_STATE_ACTION

SUBFILE_RECOGNITION_STATE_HEADER

public static int SUBFILE_RECOGNITION_STATE_HEADER

SUBFILE_RECOGNITION_STATE_DATA

public static int SUBFILE_RECOGNITION_STATE_DATA

SUBFILE_RECOGNITION_STATE_MARKER

public static int SUBFILE_RECOGNITION_STATE_MARKER

SUBFILE_RECOGNITION_STATE_SUCCESS

public static int SUBFILE_RECOGNITION_STATE_SUCCESS

recognitionOrder

public static int[] recognitionOrder

isRcpProject

public boolean isRcpProject

defaults

public static Properties defaults
Constructor Detail

SubfileComponentV6

public SubfileComponentV6(HsrScreen hostScreen)
Constructor for SubfileComponentV6.

Parameters:
hostScreen -
Method Detail

recognize

public ComponentElement[] recognize(BlockScreenRegion region,
                                    Properties settings)
Description copied from class: Component
Method to recognize components in the specified BlockScreenRegion using the specified settings.

This method must be implemented if the base class is subclassed.

Specified by:
recognize in class Component
Parameters:
region - BlockScreenRegion to search in
settings - recognition settings
Returns:
an array of ComponentElement objects.
See Also:
Component.recognize(BlockScreenRegion, Properties)

recognize

public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
                                    Properties settings)
Description copied from class: Component
Currently not implemented.

This method must be implemented if the base class is subclassed.

Specified by:
recognize in class Component
See Also:
Component.recognize(LinearScreenRegion, Properties)

getRecognitionState

public int getRecognitionState()
Returns the recognition state of subfile component.

Returns:
SUBFILE_RECOGNITION_STATE_NONE or SUBFILE_RECOGNITION_STATE_ACTION or SUBFILE_RECOGNITION_STATE_HEADER or SUBFILE_RECOGNITION_STATE_DATA or SUBFILE_RECOGNITION_STATE_MARKER or SUBFILE_RECOGNITION_STATE_SUCCESS

getRecognizedRegions

public List[] getRecognizedRegions()
Returns the recognition regions of subfile component.

Returns:
an array of List objects

getCustomCompositeName

public String getCustomCompositeName()
Specified by:
getCustomCompositeName in interface com.ibm.hats.common.ICustomPropertySupplier2

splitData

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.

Parameters:
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
Returns:
A FieldRowComponentElement object that splited by column breaks.

HATS 7.5.1 (201005110649)