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.elements
Class SubfileComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.TableComponentElement
          extended by com.ibm.hats.transform.elements.SubfileComponentElement
All Implemented Interfaces:
Cloneable

public class SubfileComponentElement
extends TableComponentElement

This class represents a subfile.

See Also:
SubfileComponent

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.TableComponentElement
RECOGNIZED_INDEX
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
SubfileComponentElement(TableCellComponentElement[][] cells, com.ibm.hats.transform.elements.SubfileActionComponentElement[] actions)
          Constructs a new SubfileComponentElement object.
 
Method Summary
 int[] getActionFieldStartCols()
          Returns the action field start columns
 com.ibm.hats.transform.elements.SubfileActionComponentElement[] getActions()
          Returns the array of valid subfile actions.
 String getEndMarkerCaption()
          Returns the caption of the end marker.
 int getHeaderRows()
          Returns the count of the header rows.
 boolean[] getInputFieldPosArray()
          Returns the input field position
 int getMaximumActionLength()
          Returns the maximum action length.
 int[] getNumberOfRowsPerRecord()
          Returns the number of the rows per record.
 int getRowColumns()
          Returns the row columns.
 String getTableComponent()
          Returns the table component name.
 boolean isApplyHATSv4Algorithm()
          Deprecated.  
 boolean isEndMarkerNeedRendered()
          Returns true if the need to render the end marker.
 void setActionFieldStartCols(int[] cols)
          Sets the action field start columns
 void setActions(com.ibm.hats.transform.elements.SubfileActionComponentElement[] actions)
          Sets the array of valid actions for this component.
 void setApplyHATSv4Algorithm(boolean applyHATSv4Algorithm)
          Deprecated.  
 void setEndMarkerCaption(String caption)
          Sets the caption of the end marker.
 void setEndMarkerNeedRendered(boolean isNeeded)
          Sets whether the end marker part need rendered
 void setHeaderRows(int count)
          Sets the count of the header rows.
 void setInputFieldPosArray(boolean[] cols)
          Sets the input field position
 void setNumberOfRowsPerRecord(int[] no)
          Sets the number of the rows per record.
 void setRowColumns(int cols)
          Sets the row columns.
 void setScreenId(int id)
           
 void setTableComponent(String componentName)
          Sets the componentName.
 
Methods inherited from class com.ibm.hats.transform.elements.TableComponentElement
addCellsToCols, addCellsToRows, addCols, addRows, clone, doTextReplacement, emptyCols, getCell, getCellRow, getCells, getColumnCount, getComponentSettings, getConsumedRegion, getConsumedTableRegion, getHeader, getPreviewText, getRowCount, isBlankForLocationColumn, prependEmptyColumn, recalculateTotalRegion, removeCols, removeEmptyCols, removeHeader, setCells, setComponentSettings, setConsumedRegion, setHeader
 
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

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

SubfileComponentElement

public SubfileComponentElement(TableCellComponentElement[][] cells,
                               com.ibm.hats.transform.elements.SubfileActionComponentElement[] actions)
Constructs a new SubfileComponentElement object.

Parameters:
cells -
actions -
Method Detail

getActions

public com.ibm.hats.transform.elements.SubfileActionComponentElement[] getActions()
Returns the array of valid subfile actions.

Returns:
SubfileActionComponentElement[]
See Also:
SubfileActionComponentElement

setActions

public void setActions(com.ibm.hats.transform.elements.SubfileActionComponentElement[] actions)
Sets the array of valid actions for this component.

Parameters:
actions - The actions to set.

isApplyHATSv4Algorithm

public boolean isApplyHATSv4Algorithm()
Deprecated. 

Returns the applyHATSv4Algorithm.

Returns:
Returns the applyHATSv4Algorithm.

setApplyHATSv4Algorithm

public void setApplyHATSv4Algorithm(boolean applyHATSv4Algorithm)
Deprecated. 

Sets the applyHATSv4Algorithm.

Parameters:
applyHATSv4Algorithm - The applyHATSv4Algorithm to set

isEndMarkerNeedRendered

public boolean isEndMarkerNeedRendered()
Returns true if the need to render the end marker.

Returns:
boolean

setEndMarkerNeedRendered

public void setEndMarkerNeedRendered(boolean isNeeded)
Sets whether the end marker part need rendered

Parameters:
isNeeded - The isNeeded to set

getEndMarkerCaption

public String getEndMarkerCaption()
Returns the caption of the end marker.

Returns:
String

setEndMarkerCaption

public void setEndMarkerCaption(String caption)
Sets the caption of the end marker.

Parameters:
caption - The caption to set

getMaximumActionLength

public int getMaximumActionLength()
Returns the maximum action length.

Returns:
int

setTableComponent

public void setTableComponent(String componentName)
Sets the componentName.

Parameters:
componentName - The componentName to set

getTableComponent

public String getTableComponent()
Returns the table component name.

Returns:
String

setHeaderRows

public void setHeaderRows(int count)
Sets the count of the header rows.

Parameters:
count - The count to set

getHeaderRows

public int getHeaderRows()
Returns the count of the header rows.

Returns:
int

setNumberOfRowsPerRecord

public void setNumberOfRowsPerRecord(int[] no)
Sets the number of the rows per record.

Parameters:
no - an array of int to set

getNumberOfRowsPerRecord

public int[] getNumberOfRowsPerRecord()
Returns the number of the rows per record.

Returns:
an array of int

setRowColumns

public void setRowColumns(int cols)
Sets the row columns.

Parameters:
cols - the row columns to set

getRowColumns

public int getRowColumns()
Returns the row columns.

Returns:
int

setActionFieldStartCols

public void setActionFieldStartCols(int[] cols)
Sets the action field start columns

Parameters:
cols - an array of int to set

getActionFieldStartCols

public int[] getActionFieldStartCols()
Returns the action field start columns

Returns:
an array of int

setInputFieldPosArray

public void setInputFieldPosArray(boolean[] cols)
Sets the input field position

Parameters:
cols - an array of boolean to set

getInputFieldPosArray

public boolean[] getInputFieldPosArray()
Returns the input field position

Returns:
an array of boolean

setScreenId

public void setScreenId(int id)
Overrides:
setScreenId in class TableComponentElement

HATS 7.5.1 (201005110649)