|
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.EnptuiSelectionFieldComponent
public class EnptuiSelectionFieldComponent
The EnptuiSelectionField component is responsible for recognizing, obviously, ENPTUI Selection Fields.
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 Properties |
defaults
|
static int |
ENPTUI_SELECTION_TYPE_MENUBAR
|
static int |
ENPTUI_SELECTION_TYPE_MULTICHOICEFIELD
|
static int |
ENPTUI_SELECTION_TYPE_MULTICHOICEINPULLDOWN
|
static int |
ENPTUI_SELECTION_TYPE_MULTICHOICELIST
|
static int |
ENPTUI_SELECTION_TYPE_PUSHBUTTON
|
static int |
ENPTUI_SELECTION_TYPE_PUSHBUTTONINPULLDOWN
|
static int |
ENPTUI_SELECTION_TYPE_SINGLECHOICEFIELD
|
static int |
ENPTUI_SELECTION_TYPE_SINGLECHOICEINPULLDOWN
|
static int |
ENPTUI_SELECTION_TYPE_SINGLECHOICELIST
|
static String |
MATCH_AUTOENTER_EITHER
|
static String |
MATCH_AUTOENTER_FALSE
|
static String |
MATCH_AUTOENTER_TRUE
|
static String |
PROPERTY_MATCH_AUTOENTER
|
static String |
PROPERTY_MATCH_MENUBAR
|
static String |
PROPERTY_MATCH_MLTCHCFLD
|
static String |
PROPERTY_MATCH_PSHBUTTON
|
static String |
PROPERTY_MATCH_SNGCHCFLD
|
| Fields inherited from class com.ibm.hats.transform.components.Component |
|---|
contextAttributes, flag, hostScreen |
| Fields inherited from interface com.ibm.hats.common.IContextDependent |
|---|
COPYRIGHT |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
CLASSNAME |
| Constructor Summary | |
|---|---|
EnptuiSelectionFieldComponent(HsrScreen hostScreen)
Constructs a new FieldComponent object. |
|
| Method Summary | |
|---|---|
protected void |
addToElementList(ComponentElement element)
|
int |
convertPosToCol(int pos)
|
int |
convertPosToRow(int pos)
|
protected void |
debugInputVector(Vector v)
|
int |
fieldLookup(int spot)
returns which field is at the given location. |
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
Properties |
getDefaultValues(int iPageNumber)
Returns this object's default property values. |
static String |
getInputFieldAttributeDetails(ECLInputFieldAttribute fld)
|
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
protected String |
getSelectionFieldTypeString(int seltype)
|
protected void |
handleChoiceSelection(ECLInputFieldAttribute fld,
BlockScreenRegion region,
boolean isMultiSelect)
|
boolean |
isAllowed(ContextAttributes contextAttributes)
Gets whether or not this object should be visible in the studio given some context attributes. |
static boolean |
isMultiSelectFieldType(ECLInputFieldAttribute fld)
|
static boolean |
isMultiSelectFieldType(int selectionFieldType)
|
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 void |
useENPTUIFields(Vector v,
BlockScreenRegion region)
|
| Methods inherited from class com.ibm.hats.transform.components.Component |
|---|
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, 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 int ENPTUI_SELECTION_TYPE_MENUBAR
public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICEFIELD
public static final int ENPTUI_SELECTION_TYPE_MULTICHOICEFIELD
public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICELIST
public static final int ENPTUI_SELECTION_TYPE_MULTICHOICELIST
public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICEINPULLDOWN
public static final int ENPTUI_SELECTION_TYPE_MULTICHOICEINPULLDOWN
public static final int ENPTUI_SELECTION_TYPE_PUSHBUTTON
public static final int ENPTUI_SELECTION_TYPE_PUSHBUTTONINPULLDOWN
public static final String PROPERTY_MATCH_SNGCHCFLD
public static final String PROPERTY_MATCH_MLTCHCFLD
public static final String PROPERTY_MATCH_PSHBUTTON
public static final String PROPERTY_MATCH_MENUBAR
public static final String PROPERTY_MATCH_AUTOENTER
public static final String MATCH_AUTOENTER_TRUE
public static final String MATCH_AUTOENTER_FALSE
public static final String MATCH_AUTOENTER_EITHER
public static Properties defaults
| Constructor Detail |
|---|
public EnptuiSelectionFieldComponent(HsrScreen hostScreen)
FieldComponent object.
hostScreen - | Method Detail |
|---|
public int convertPosToCol(int pos)
public int convertPosToRow(int pos)
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 Componentprotected void debugInputVector(Vector v)
protected void useENPTUIFields(Vector v,
BlockScreenRegion region)
public static String getInputFieldAttributeDetails(ECLInputFieldAttribute fld)
public static boolean isMultiSelectFieldType(ECLInputFieldAttribute fld)
public static boolean isMultiSelectFieldType(int selectionFieldType)
protected String getSelectionFieldTypeString(int seltype)
protected void addToElementList(ComponentElement element)
protected void handleChoiceSelection(ECLInputFieldAttribute fld,
BlockScreenRegion region,
boolean isMultiSelect)
public int fieldLookup(int spot)
spot - The position to look for the field at.
public int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Component
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 Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class ComponentiPageNumber - page for which to retrieve default properties
public 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 | ||||||||