|
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.VisualTableComponent
public class VisualTableComponent
The Visual Table component is responsible for recognizing tables. The Visual Table component is different from the Field Table component in that it does not require that the underlying host screen fields line up vertically. It simply looks for columns in the selected region which contain the column delimiter for each row in the selection. Rule of thumb: If a region looks (to the eye) like a table, the Visual Table component should be able to recognize it.
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 |
|---|---|---|---|
| columnDelimiter | 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 | (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) |
| minRows | The minimum number of rows the specified region must contain for the region to be recognized as a table. Note: The number of recognized rows is evaluated before the specified rows are excluded (see "Rows to exclude"). | int | 1 |
| minColumns | The minimum number of logical columns (not host screen columns) the specified region must contain for the region to be recognized as a table. Note: The number of recognized columns is evaluated before the specified columns are excluded (see "Columns to exclude"). | int | 1 |
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static String |
PROPERTY_COLUMN_DELIMITER
|
static String |
PROPERTY_VALIDATE_CHARACTER_TYPE
|
| 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 | |
|---|---|
VisualTableComponent(HsrScreen hostScreen)
Constructor for VisualTableComponent. |
|
| Method Summary | |
|---|---|
boolean |
evalCharIsBreak(int row,
int col,
HsrScreen hs,
Properties settings)
|
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. |
boolean |
handleCleaningOfSet(com.ibm.hats.common.NumberedSet ns,
int d,
int start,
int end,
int min)
|
int[] |
modifyDepthTree(com.ibm.hats.common.NumberedSet ns,
int[] depth,
int shallowest,
int deepest,
int mincolbreaks,
HsrScreen hs)
|
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Method to recognize components in the specified BlockScreenRegion using the specified settings. |
void |
refactorBreaks(com.ibm.hats.common.NumberedSet colbreaks,
BlockScreenRegion search,
HsrScreen hs)
|
StringBuffer |
testTable(HsrScreen hs,
BlockScreenRegion bsr,
Properties settings,
boolean defaultrender,
ContextAttributes context)
Deprecated. Internal use only. |
| Methods inherited from class com.ibm.hats.transform.components.AbstractTableComponent |
|---|
assignSpreadsheetProperties, createEmptyFieldComponentElement, createHeaderRegions, createTableCell, createTableHeader, evalFirstRegionIsBetterTable, evalFirstRegionIsBetterTable, findTables, findTables, handleRemovalFromSet, previouslyRecognized, printIntArray, printNumberedSetTable, printNumberedSetTable, printNumberedSetTable, printNumberedSetTable, protectedandspace, recognize, removeEmptyBottomRowsFromRegion, testTable, track |
| 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_COLUMN_DELIMITER
public static final String PROPERTY_VALIDATE_CHARACTER_TYPE
| Constructor Detail |
|---|
public VisualTableComponent(HsrScreen hostScreen)
hostScreen - | Method Detail |
|---|
public boolean evalCharIsBreak(int row,
int col,
HsrScreen hs,
Properties settings)
evalCharIsBreak in class AbstractTableComponent
public boolean handleCleaningOfSet(com.ibm.hats.common.NumberedSet ns,
int d,
int start,
int end,
int min)
handleCleaningOfSet in class AbstractTableComponent
public int[] modifyDepthTree(com.ibm.hats.common.NumberedSet ns,
int[] depth,
int shallowest,
int deepest,
int mincolbreaks,
HsrScreen hs)
modifyDepthTree in class AbstractTableComponent
public StringBuffer testTable(HsrScreen hs,
BlockScreenRegion bsr,
Properties settings,
boolean defaultrender,
ContextAttributes context)
testTable in class AbstractTableComponent
public void refactorBreaks(com.ibm.hats.common.NumberedSet colbreaks,
BlockScreenRegion search,
HsrScreen hs)
refactorBreaks in class AbstractTableComponent
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 int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Component
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 iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class ComponentiPageNumber - 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 | ||||||||