|
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.components.Component
com.ibm.hats.transform.components.FieldComponent
public class FieldComponent
The Field component is responsible for recognizing protected text and input fields. This component will recognize any selected host screen region and this component can be rendered using the Field widget.
There are no customizable settings for this component.
The recognize() methods of this component return an array of ComponentElement objects all of type:
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static String |
PROPERTY_ENABLE_CHARACTER_LEVEL_ATTRIBUTES
|
| Fields inherited from class com.ibm.hats.transform.components.Component |
|---|
contextAttributes, flag, hostScreen |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
CLASSNAME |
| Constructor Summary | |
|---|---|
FieldComponent(HsrScreen hostScreen)
Constructs a new FieldComponent object. |
|
| Method Summary | |
|---|---|
protected FieldComponentElement |
createEmptyFieldComponentElement(int startPos,
int length)
Returns an empty FieldComponentElement object. |
protected FieldComponentElement |
createPartialFieldComponentElement(FieldComponentElement fce,
int startIndex,
int length)
Creates a new partial FieldComponentElement object based on the specific component element. |
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
protected ComponentElementList |
getFieldElementsInRow(int row,
int startCol,
int endCol)
Returns a FieldRowComponentElement object which contains the set of fields recognized in the specified row. |
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
boolean |
isAllowed(ContextAttributes contextAttributes)
Gets whether or not this object should be visible in the studio given some context attributes. |
boolean |
isPropertyAllowed(String name,
ContextAttributes contextAttributes)
Gets whether or not the specified property should be visible in the component or widget settings. |
ComponentElement[] |
recognize(BlockScreenRegion region,
Properties settings)
Returns an array of FieldRowComponentElement objects, each representing an entire screen row of fields and field segments. |
ComponentElement[] |
recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
Not currently implemented. |
protected List |
splitAtIndices(FieldComponentElement fce,
int[] changeIndices)
Method that splits the specified FieldComponentElement object into separate parts. |
| Methods inherited from class com.ibm.hats.transform.components.Component |
|---|
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getDefaultValues, getHostScreen, getTrailingSpaceCount, newInstance, recognize, setContextAttribute, setContextAttributes, setHostScreen |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
public static final String PROPERTY_ENABLE_CHARACTER_LEVEL_ATTRIBUTES
| Constructor Detail |
|---|
public FieldComponent(HsrScreen hostScreen)
FieldComponent object.
hostScreen - | Method Detail |
|---|
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
FieldRowComponentElement objects, each representing an entire screen row of fields and field segments.
The length of the returned array is equal to the number of rows in the specified region. Each FieldRowComponentElement is a set of FieldComponentElement objects.
Gaps between actual host screen fields are indicated as a protected, hidden FieldComponentElement objects.
recognize in class Componentregion - rectangular region to search insettings - recognition settings (not applicable)
FieldRowComponentElement objects.
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
recognize in class Component
protected ComponentElementList getFieldElementsInRow(int row,
int startCol,
int endCol)
FieldRowComponentElement object which contains the set of fields recognized in the specified row.
row - The (1-based) row to look for fields in.startCol - The (1-based) column to begin looking for fields in.endCol - The (1-based) column to stop looking for fields in (must be greater than the start column).
FieldRowComponentElement object which contains the set of fields recognized in the specified row.
protected FieldComponentElement createEmptyFieldComponentElement(int startPos,
int length)
FieldComponentElement object. The field component element is marked as a hidden and protected, with a value of length number of spaces.
startPos - linear (1-based) starting position of the field represented by the component element objectlength - length of the field represented by the component element object
FieldComponentElement object.
protected List splitAtIndices(FieldComponentElement fce,
int[] changeIndices)
fce - The FieldComponentElement.changeIndices - An array of change indices.
protected FieldComponentElement createPartialFieldComponentElement(FieldComponentElement fce,
int startIndex,
int length)
fce - The FieldComponentElement.startIndex - The 0-based relative index (to the start of the specific FieldComponentElement object).length - The length of the new component element object.
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class ComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertypublic int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Componentpublic boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependent
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentname - property name
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||