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 SubfileHeaderComponentElementV6

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.ComponentElementList
          extended by com.ibm.hats.transform.elements.FieldRowComponentElement
              extended by com.ibm.hats.transform.elements.SubfileHeaderComponentElementV6
All Implemented Interfaces:
Cloneable

public class SubfileHeaderComponentElementV6
extends FieldRowComponentElement

This class represents the subfile header row element


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElementList
elements
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
SubfileHeaderComponentElementV6()
          Constructs a new SubfileHeaderComponentElementV6 object.
SubfileHeaderComponentElementV6(int startPos, int startRow, int endRow, FieldRowComponentElement frce, ComponentElementList actionList)
          Constructs a new SubfileHeaderComponentElementV6 object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Peforms text replacement on each cell in the table.
 int getActionInputFieldLength()
          Returns subfile action input field length
 int getActionInputFieldStartCol()
          Returns subfile action input field start column
 int getEndRow()
          Returns end row number of subfile header
 FieldRowComponentElement getHeaderRowComponentElement()
          Returns subfile header row component element
 String getPreviewText()
          Returns the preview text for this component.
 int getStartPos()
          Returns start position of subfile header
 int getStartRow()
          Returns start row number of subfile header
 int setActionInputFieldLength(int actionInputFieldLength)
          Sets action input field length
 int setActionInputFieldStartCol(int actionInputFieldStartCol)
          Sets the action input field start column
 void setScreenId(int id)
           
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElementList
addElement, addElement, addElements, cloneList, computeConsumedRegion, doTextReplacement, getConsumedRegion, getElement, getElementCount, getElements, getIterator, getPreviewText, getPreviewText, removeElement, removeElement
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, 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

SubfileHeaderComponentElementV6

public SubfileHeaderComponentElementV6()
Constructs a new SubfileHeaderComponentElementV6 object.


SubfileHeaderComponentElementV6

public SubfileHeaderComponentElementV6(int startPos,
                                       int startRow,
                                       int endRow,
                                       FieldRowComponentElement frce,
                                       ComponentElementList actionList)
Constructs a new SubfileHeaderComponentElementV6 object.

Parameters:
startPos - start position of the subfile header row element
startRow - start row number of the subfile header
endRow - end row number of the subfile header
frce - field row component element of the subfile header row
actionList - action list of the subfile
Method Detail

getPreviewText

public String getPreviewText()
Returns the preview text for this component. In this implementation, the subfile header is returned.

Overrides:
getPreviewText in class FieldRowComponentElement
Returns:
A concatenation of the preview text of each component element in the list. Each element is separated with a \n (new line) character.
See Also:
ComponentElement.getPreviewText()

getStartPos

public int getStartPos()
Returns start position of subfile header

Returns:
int

getStartRow

public int getStartRow()
Returns start row number of subfile header

Returns:
int

getEndRow

public int getEndRow()
Returns end row number of subfile header

Returns:
int

getHeaderRowComponentElement

public FieldRowComponentElement getHeaderRowComponentElement()
Returns subfile header row component element

Returns:
FieldRowComponentElement

getActionInputFieldStartCol

public int getActionInputFieldStartCol()
Returns subfile action input field start column

Returns:
int

setActionInputFieldStartCol

public int setActionInputFieldStartCol(int actionInputFieldStartCol)
Sets the action input field start column

Parameters:
actionInputFieldStartCol -

getActionInputFieldLength

public int getActionInputFieldLength()
Returns subfile action input field length

Returns:
int

setActionInputFieldLength

public int setActionInputFieldLength(int actionInputFieldLength)
Sets action input field length

Parameters:
actionInputFieldLength -

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Peforms text replacement on each cell in the table.

Overrides:
doTextReplacement in class FieldRowComponentElement
Parameters:
pair - from/replace with pair
contextAttributes - context attributes

setScreenId

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

HATS 7.5.1 (201005110649)