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 TableCellComponentElement

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

public class TableCellComponentElement
extends ComponentElement

This class represents a cell in a table.

See Also:
TableComponentElement

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
TableCellComponentElement(FieldComponentElement[] fields)
          Constructs a new TableCellComponentElement object from the specified array of FieldComponentElement objects.
TableCellComponentElement(String text, int startPos, int length, boolean isProtected, boolean isHidden)
          Constructs a new TableCellComponentElement object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Performs text replacement on this table cell.
 int getColSpan()
          Deprecated.  
 FieldComponentElement[] getFields()
          Returns the set of fields used to construct this table cell.
 int getLength()
          Returns the length of the cell
 String getPreviewText()
          Returns some form of descriptive text about the component element.
 int getSpan()
          Deprecated.  
 int getStartPos()
          Returns the linear, 1-based start position of the cell.
 String getText()
          Returns the value of the cell.
 boolean isHidden()
          Returns true if the cell is hidden.
 boolean isProtected()
          Returns true if the field is protected.
 void setColSpan(int cols)
          Deprecated.  
 void setIsHidden(boolean b)
          Sets the hidden attribute of the cell.
 void setIsProtected(boolean isProtected)
          Sets whether the cell is protected or not protected (i.e.
 void setLength(int length)
          Sets the length of the cell.
 void setScreenId(int id)
           
 void setSpan(int cols)
          Deprecated.  
 void setStartPos(int startPos)
          Sets the start position of the cell.
 void setText(String text)
          Sets the text of the cell.
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, 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

TableCellComponentElement

public TableCellComponentElement(String text,
                                 int startPos,
                                 int length,
                                 boolean isProtected,
                                 boolean isHidden)
Constructs a new TableCellComponentElement object.

Parameters:
text - text value of the cell
startPos - linear, 1-based start position of the table cell
length - length of the cell
isProtected - specifies whether the cell is protected or not (unprotected implies it being an input field)
isHidden - specifies whether the cell is hidden or not

TableCellComponentElement

public TableCellComponentElement(FieldComponentElement[] fields)
Constructs a new TableCellComponentElement object from the specified array of FieldComponentElement objects.

Parameters:
fields -
Method Detail

getPreviewText

public String getPreviewText()
Description copied from class: ComponentElement
Returns some form of descriptive text about the component element.

Specified by:
getPreviewText in class ComponentElement
See Also:
ComponentElement.getPreviewText()

isProtected

public boolean isProtected()
Returns true if the field is protected.

Returns:
boolean

getLength

public int getLength()
Returns the length of the cell

Returns:
int

getStartPos

public int getStartPos()
Returns the linear, 1-based start position of the cell.

Returns:
int

getText

public String getText()
Returns the value of the cell.

Returns:
String

setIsProtected

public void setIsProtected(boolean isProtected)
Sets whether the cell is protected or not protected (i.e. input)

Parameters:
isProtected - The isProtected to set

setLength

public void setLength(int length)
Sets the length of the cell.

Parameters:
length - The length to set

setStartPos

public void setStartPos(int startPos)
Sets the start position of the cell.

Parameters:
startPos - The startPos to set

setText

public void setText(String text)
Sets the text of the cell.

Parameters:
text - The text to set

isHidden

public boolean isHidden()
Returns true if the cell is hidden.

Returns:
Returns true if the cell is hidden, false otherwise.

setIsHidden

public void setIsHidden(boolean b)
Sets the hidden attribute of the cell.

Parameters:
b -

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Performs text replacement on this table cell.

Specified by:
doTextReplacement in class ComponentElement
Parameters:
pair - TextReplacementPair to base replacement on
contextAttributes - context attributes

getFields

public FieldComponentElement[] getFields()
Returns the set of fields used to construct this table cell.

Returns:
The set of fields used to construct this table cell.

getSpan

public int getSpan()
Deprecated. 


getColSpan

public int getColSpan()
Deprecated. 


setSpan

public void setSpan(int cols)
Deprecated. 

Parameters:
cols -

setColSpan

public void setColSpan(int cols)
Deprecated. 

Parameters:
cols -

setScreenId

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

HATS 7.5.1 (201005110649)