|
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.AbstractTableComponent
com.ibm.hats.transform.components.TableComponent
public class TableComponent
The Table component is responsible for fixed column table in a specified region of a host screen.
A recognized table can be rendered by the following widgets:
recognize() methods of this component return ComponentElement objects of type:
| Property | Description | Type | Default Value |
|---|---|---|---|
| columnBreaks | 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 | (one space) |
| includeEmptyRows | If true, empty rows (rows without any visible text or input fields) will be included in the rendered table or graph. | boolean | true |
| excludeRows | The comma-separated or ranged set of rows to exclude from the recognized table. This setting is useful for hiding specific rows of data on a table or graph. The rows represented by this value are based on the recognized table, not on the actual host screen. Example values: "1,2,3....", "1,2-4", "3-5". | String | (empty) |
| excludeCols | The comma-separated or ranged set of logical columns to exclude from the recognized table. The columns represented by this value are based on the recognized table, not on the actual host screen. Example values: "1,2,3....", "1,2-4", "3-5". | String | (empty) |
| numberOfTitleRows | Specify the number of rows to be used as the table title. | int | 0 |
| startRow | First row to look for the table data | int | 4 |
| startCol | First column to look for the table data | int | 1 |
| endRow | First row to look for the table data | int | 22 |
| endCol | First column to look for the table data | int | 80 |
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static String |
PROPERTY_COLUMN_BREAKS
|
static String |
PROPERTY_COLUMN_BREAKS_DEFAULT
|
static String |
PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT
|
static String |
PROPERTY_NUMBER_OF_TITLE_ROWS
|
static String |
PROPERTY_NUMBER_OF_TITLE_ROWS_DEFAULT
|
static String |
PROPERTY_SELECT_REGION_END_COL
|
static int |
PROPERTY_SELECT_REGION_END_COL_DEFAULT
|
static String |
PROPERTY_SELECT_REGION_END_ROW
|
static int |
PROPERTY_SELECT_REGION_END_ROW_DEFAULT
|
static String |
PROPERTY_SELECT_REGION_START_COL
|
static int |
PROPERTY_SELECT_REGION_START_COL_DEFAULT
|
static String |
PROPERTY_SELECT_REGION_START_ROW
|
static int |
PROPERTY_SELECT_REGION_START_ROW_DEFAULT
|
| Fields inherited from class com.ibm.hats.transform.components.Component |
|---|
contextAttributes, flag, hostScreen |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier2 |
|---|
CLASSNAME |
| Constructor Summary | |
|---|---|
TableComponent(HsrScreen hostScreen)
Constructor for TableComponent. |
|
| Method Summary | |
|---|---|
boolean |
evalCharIsBreak(int row,
int col,
HsrScreen hs,
Properties settings)
|
String |
getCustomCompositeName()
|
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
Properties |
getDefaultValues(int arg0)
Returns this object's default property values. |
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
static boolean |
isValidColumnBreak(HsrScreen hs,
ScreenRegion bsr,
int col)
Check the column break position is valid value of region. |
ComponentElement[] |
recognize(BlockScreenRegion bsr,
Properties settings)
Method to recognize components in the specified BlockScreenRegion using the specified settings. |
ComponentElement[] |
recognize(com.ibm.hats.transform.regions.LinearScreenRegion arg0,
Properties arg1)
Currently not implemented. |
static com.ibm.hats.common.NumberedSet |
removeInvaildBreaks(com.ibm.hats.common.NumberedSet breaks,
HsrScreen hs,
ScreenRegion bsr)
Check and remove the invalid column break position from a break set. |
| 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 |
| Methods inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
getCustomComposite |
| Field Detail |
|---|
public static final String CLASS_NAME
public static final String PROPERTY_COLUMN_BREAKS
public static final String PROPERTY_NUMBER_OF_TITLE_ROWS
public static final String PROPERTY_COLUMN_VISUAL_TABLE_DEFAULT
public static final String PROPERTY_SELECT_REGION_START_ROW
public static final String PROPERTY_SELECT_REGION_START_COL
public static final String PROPERTY_SELECT_REGION_END_ROW
public static final String PROPERTY_SELECT_REGION_END_COL
public static final String PROPERTY_COLUMN_BREAKS_DEFAULT
public static final String PROPERTY_NUMBER_OF_TITLE_ROWS_DEFAULT
public static final int PROPERTY_SELECT_REGION_START_ROW_DEFAULT
public static final int PROPERTY_SELECT_REGION_START_COL_DEFAULT
public static final int PROPERTY_SELECT_REGION_END_ROW_DEFAULT
public static final int PROPERTY_SELECT_REGION_END_COL_DEFAULT
| Constructor Detail |
|---|
public TableComponent(HsrScreen hostScreen)
hostScreen - | Method Detail |
|---|
public boolean evalCharIsBreak(int row,
int col,
HsrScreen hs,
Properties settings)
evalCharIsBreak in class AbstractTableComponent
public ComponentElement[] recognize(BlockScreenRegion bsr,
Properties settings)
ComponentBlockScreenRegion using the specified settings.This method must be implemented if the base class is subclassed.
recognize in class Componentbsr - BlockScreenRegion to search insettings - recognition settings
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion arg0,
Properties arg1)
ComponentThis method must be implemented if the base class is subclassed.
recognize in class AbstractTableComponentComponent.recognize(LinearScreenRegion, Properties)
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class AbstractTableComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertypublic Properties getDefaultValues(int arg0)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class Componentarg0 - page for which to retrieve default properties
public int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Componentpublic String getCustomCompositeName()
getCustomCompositeName in interface com.ibm.hats.common.ICustomPropertySupplier2
public static boolean isValidColumnBreak(HsrScreen hs,
ScreenRegion bsr,
int col)
hs - The host screen object.bsr - The region of the screen to retrieve.col - The column position for valid break check.
public static com.ibm.hats.common.NumberedSet removeInvaildBreaks(com.ibm.hats.common.NumberedSet breaks,
HsrScreen hs,
ScreenRegion bsr)
breaks - Original break set.hs - The host screen object.bsr - The region of the screen to retrieve.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||