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 SubfileDataComponentElementV6

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.SubfileDataComponentElementV6
All Implemented Interfaces:
Cloneable

public class SubfileDataComponentElementV6
extends FieldRowComponentElement

This class represents the subfile data 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
SubfileDataComponentElementV6(int startPos, int startRow, int endRow, FieldRowComponentElement frce)
          Constructs a new SubfileDataComponentElementV6 object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Performs text replacement on this list item (text replacement is performed on the item, description, and full caption).
 HashSet getActionInputFieldIndex()
          Returns the set for subfile action input field index
 String getActionInputFieldLength()
          Returns subfile action input field length
 String getActionInputFieldStartCol()
          Returns subfile action input field start column
 FieldRowComponentElement getDataRowComponentElement()
          Returns subfile data row component element
 int getEndRow()
          Returns end row number of subfile data
 boolean getOverrideActionInputFieldLength()
          Returns the option to override action input field length
 boolean getOverrideActionInputFieldStartCol()
          Returns the option to override action input field start column
 String getPreviewText()
          Returns the preview text for this component.
 int getStartPos()
          Returns start position of subfile data
 int getStartRow()
          Returns start row number of subfile data
 HashSet setActionInputFieldIndex(HashSet actionInputFieldIndex)
          Sets subfile action input field index
 void setActionInputFieldLength(String actionInputFieldLength)
          Sets action input field length
 void setActionInputFieldStartCol(String actionInputFieldStartCol)
          Sets the action input field start column
 boolean setOverrideActionInputFieldLength(boolean overrideActionInputFieldLength)
          Sets the option to override action input field length
 boolean setOverrideActionInputFieldStartCol(boolean overrideActionInputFieldStartCol)
          Sets the option to override 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

SubfileDataComponentElementV6

public SubfileDataComponentElementV6(int startPos,
                                     int startRow,
                                     int endRow,
                                     FieldRowComponentElement frce)
Constructs a new SubfileDataComponentElementV6 object.

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

getDataRowComponentElement

public FieldRowComponentElement getDataRowComponentElement()
Returns subfile data row component element

Returns:
FieldRowComponentElement

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Performs text replacement on this list item (text replacement is performed on the item, description, and full caption).

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

getPreviewText

public String getPreviewText()
Returns the preview text for this component. In this implementation, the subfile data 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()

getOverrideActionInputFieldStartCol

public boolean getOverrideActionInputFieldStartCol()
Returns the option to override action input field start column

Returns:
boolean

setOverrideActionInputFieldStartCol

public boolean setOverrideActionInputFieldStartCol(boolean overrideActionInputFieldStartCol)
Sets the option to override action input field start column

Parameters:
overrideActionInputFieldStartCol -

getOverrideActionInputFieldLength

public boolean getOverrideActionInputFieldLength()
Returns the option to override action input field length

Returns:
boolean

setOverrideActionInputFieldLength

public boolean setOverrideActionInputFieldLength(boolean overrideActionInputFieldLength)
Sets the option to override action input field length

Parameters:
overrideActionInputFieldLength -

getActionInputFieldStartCol

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

Returns:
int

setActionInputFieldStartCol

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

Parameters:
actionInputFieldStartCol -

getActionInputFieldLength

public String getActionInputFieldLength()
Returns subfile action input field length

Returns:
int

setActionInputFieldLength

public void setActionInputFieldLength(String actionInputFieldLength)
Sets action input field length

Parameters:
actionInputFieldLength -

getActionInputFieldIndex

public HashSet getActionInputFieldIndex()
Returns the set for subfile action input field index

Returns:
HashSet

setActionInputFieldIndex

public HashSet setActionInputFieldIndex(HashSet actionInputFieldIndex)
Sets subfile action input field index

Returns:
HashSet

getStartPos

public int getStartPos()
Returns start position of subfile data

Returns:
int

getStartRow

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

Returns:
int

getEndRow

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

Returns:
int

setScreenId

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

HATS 7.5.1 (201005110649)