|
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.elements.ComponentElement
com.ibm.hats.transform.elements.TableComponentElement
public class TableComponentElement
This class represents a table.
FieldTableComponent,
VisualTableComponent| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static String |
RECOGNIZED_INDEX
|
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
TableComponentElement(TableCellComponentElement[][] cells)
Constructs a new TableComponentElement object. |
|
TableComponentElement(TableCellComponentElement[][] cells,
String columnDelimiter)
Constructs a new TableComponentElement object. |
|
| Method Summary | |
|---|---|
static TableCellComponentElement[][] |
addCellsToCols(TableCellComponentElement[][] a_cells,
TableCellComponentElement[][] b_cells)
|
static TableCellComponentElement[][] |
addCellsToRows(TableCellComponentElement[][] a_cells,
TableCellComponentElement[][] b_cells)
|
void |
addCols(TableCellComponentElement[][] cells)
|
void |
addRows(TableCellComponentElement[][] cells)
|
Object |
clone()
Create a copy of this TableComponentElement. |
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Peforms text replacement on each cell in the table. |
com.ibm.hats.common.NumberedSet |
emptyCols()
Returns the set of empty columns (1-based) in the table. |
TableCellComponentElement |
getCell(int row,
int column)
Returns the TableCellComponentElement at the specified row and column (1-based). |
TableCellComponentElement[] |
getCellRow(int row)
Returns an array of all TableCellComponentElement objects in the specified row. |
TableCellComponentElement[][] |
getCells()
Returns the double array of cells. |
int |
getColumnCount()
Returns the number of columns represented in the table. |
Properties |
getComponentSettings()
Returns the component settings for this element. |
ScreenRegion |
getConsumedRegion()
Returns the screen region (block, linear) consumed by this component element. |
ScreenRegion |
getConsumedTableRegion()
|
TableComponentElement |
getHeader()
Returns the header table component element. |
String |
getPreviewText()
Returns some form of descriptive text about the component element. |
int |
getRowCount()
Returns the number of rows represented in the table. |
boolean |
isBlankForLocationColumn(int col)
|
void |
prependEmptyColumn()
This method adds at most one empty column to the beginning of the table |
protected void |
recalculateTotalRegion()
|
void |
removeCols(com.ibm.hats.common.NumberedSet cols)
Removes the set of columns specified in the cols parameter. |
void |
removeEmptyCols()
Method to remove empty columns in the table. |
void |
removeHeader()
|
void |
setCells(TableCellComponentElement[][] cells)
Sets the double array of cells. |
void |
setComponentSettings(Properties settings)
set the component settings for this element |
void |
setConsumedRegion(ScreenRegion region)
Set the screen region (block, linear) consumed by this component element. |
void |
setHeader(TableComponentElement header)
|
void |
setScreenId(int id)
|
| Methods inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, type, type |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
public static final String RECOGNIZED_INDEX
| Constructor Detail |
|---|
public TableComponentElement(TableCellComponentElement[][] cells,
String columnDelimiter)
TableComponentElement object.
cells - columnDelimiter - public TableComponentElement(TableCellComponentElement[][] cells)
TableComponentElement object.
cells - | Method Detail |
|---|
public int getRowCount()
public int getColumnCount()
public TableCellComponentElement getCell(int row,
int column)
TableCellComponentElement at the specified row and column (1-based).
row - 1-based row number of the cell to getcolumn - 1-based column number of the cell to get
public TableCellComponentElement[] getCellRow(int row)
TableCellComponentElement objects in the specified row.
row - 1-based row number to get
public String getPreviewText()
ComponentElement
getPreviewText in class ComponentElementpublic TableCellComponentElement[][] getCells()
public void setCells(TableCellComponentElement[][] cells)
cells - The cells to set
public static TableCellComponentElement[][] addCellsToRows(TableCellComponentElement[][] a_cells,
TableCellComponentElement[][] b_cells)
public static TableCellComponentElement[][] addCellsToCols(TableCellComponentElement[][] a_cells,
TableCellComponentElement[][] b_cells)
public Object clone()
clone in class ComponentElementpublic void prependEmptyColumn()
public void addRows(TableCellComponentElement[][] cells)
public void addCols(TableCellComponentElement[][] cells)
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class ComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic TableComponentElement getHeader()
public ScreenRegion getConsumedRegion()
getConsumedRegion in class ComponentElementpublic ScreenRegion getConsumedTableRegion()
public void setConsumedRegion(ScreenRegion region)
setConsumedRegion in class ComponentElementprotected void recalculateTotalRegion()
public void setHeader(TableComponentElement header)
public void removeHeader()
public void removeEmptyCols()
public com.ibm.hats.common.NumberedSet emptyCols()
public boolean isBlankForLocationColumn(int col)
public void removeCols(com.ibm.hats.common.NumberedSet cols)
cols parameter.
cols - public void setScreenId(int id)
setScreenId in class ComponentElementpublic Properties getComponentSettings()
public void setComponentSettings(Properties settings)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||